Публикации по теме 'javadoc'
Интеграция GitBook с JSDoc для документирования вашего проекта с открытым исходным кодом
Хорошая документация должна включать два отдельных элемента - Руководство и API :
Руководство строит концепции, предоставляет примеры и т. Д. GitBook хорошо подходит для создания Руководства, поддерживая множество опций, используя стандартный Markdown . API предоставляет низкоуровневую специфику с сигнатурами функций, деталями и т. Д. JSDoc (потомок JavaDoc ) идеально подходит для определения низкоуровневого API. Используя этот метод, API определяется из комментариев,..
Вопросы по теме 'javadoc'
Как добавить Javadoc для Servlet API в Eclipse
У меня есть динамическое веб-приложение в Eclipse, которое использует Tomcat в качестве среды выполнения.
Я не могу добавить путь Javadoc Tomcat Servlet API: как оказалось, кнопка редактирования всегда отключена!
замещающий текст...
15892 просмотров
schedule
04.07.2022
UmlGraph не интегрируется автоматически в JavaDoc
Я использую maven и плагин maven-javadoc с umlgraph-doclet для создания javadoc для моего проекта. Часть из моей помпы:
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>...
4265 просмотров
schedule
22.08.2022
Передача аргументов компилятору и javadoc в gradle
Я пытаюсь предоставить Gradle в качестве альтернативной системы сборки для существующего проекта. Этот проект использует sun.misc.Unsafe , что приводит к подобным предупреждениям:
warning: Unsafe is internal proprietary API and may be removed in...
8185 просмотров
schedule
05.01.2024
Как использовать автодополнение в Eclipse, добавляя полное имя
Как я могу использовать автодополнение в Eclipse, добавляя полное имя?
Чтобы избежать проблем с сонарами/чекстайлами (неиспользуемый импорт), у нас есть политика использования полного имени в Javadoc.
Я ищу метод, все еще использующий...
979 просмотров
schedule
28.07.2022
Предупреждение компиляции mvn (неиспользуемый импорт) из-за импорта javadoc
Я работаю над java-проектом, в котором для сборки используется maven. Мы также используем eclipse для разработки всех плюсов (автозаполнение и т. Д.) Одна вещь, которую я заметил, это то, что импорт в классы из-за комментариев javadoc, где eclipse в...
713 просмотров
schedule
07.09.2022
Фрагмент кода внутри @param Javadoc
Можно ли поместить фрагмент кода в JavaDoc параметра? Я пробовал следующее, но фрагмент кода не отформатирован как таковой в сгенерированных документах.
/**
* Description of method
*
* @param dataSourceProperties defines the properties of this...
67 просмотров
schedule
08.10.2023
Ссылка на текстовый файл (ресурс) в Javadoc
Я сделал свой поиск, но не смог найти правильный ответ... Как я могу использовать ссылку на текстовый файл ресурса в Javadoc. {@link easywords.txt} не работает. <a href="D:\NetBeans\HMan\easy.txt">Easy words</a> тоже не работает.
7799 просмотров
schedule
18.02.2024
Почему javadoc LinkedList не гарантирует постоянную производительность во всплывающих и push-уведомлениях?
В Java Collection Framework многие реализации упоминают об их производительности в Javadoc. Например, HashSet говорит:
Этот класс предлагает постоянную производительность для основных операций (добавление, удаление, содержание и размер),...
109 просмотров
schedule
16.02.2024
Невозможно сгенерировать javadoc в Eclipse для связанных исходных файлов
Я не могу создать javadoc для связанных файлов .java с помощью Eclipse Mars.
Это показывает, как настроен мой проект:
Я могу запустить программу.
Исходный файл находится в папке с именем foo , чтобы соответствовать объявлению пакета:...
977 просмотров
schedule
22.02.2024
Используйте maven JavaDoc с разумными параметрами doclint
Существует много информации о том, как отключить функцию lint JavaDoc в Java 8. Хотите верьте, хотите нет, но сегодня я решил использовать эту функцию и исправить свои JavaDocs. Однако в своей стандартной конфигурации он жалуется на все возможные...
3198 просмотров
schedule
02.05.2024
Пакет ошибок генерации Javadoc не существует в многомодульном проекте
Мне нужно загрузить свои библиотеки (многомодульный проект) в репозиторий sonatype через Bintray. Так что мне нужно генерировать Javadoc отдельно для каждого модуля.
Сначала я столкнулся с проблемами в этих подобных вопросах
Android Studio...
4205 просмотров
schedule
18.03.2024
Escape @ Character в Javadoc
Я знаю, что об этом уже спрашивали, но ответы там работали только со старыми JVM; Я на 8. У меня есть такой javadoc:
* <pre>
* {@code
*
* import javax.ws.rs.Path;
*
* import com.ziath.handheldserver.scripts.AbstractHandheldScript;...
444 просмотров
schedule
04.10.2023
‹sub› и ‹sup› разрешены в предварительно отформатированном текстовом блоке JavaDoc?
Я хотел бы использовать <sub> и <sup> в JavaDoc для лучшего форматирования. Однако кажется, что JavaDoc борется с этими элементами. По крайней мере, maven-javadoc-plugin наводняет такими предупреждающими сообщениями. Java 11 в любом...
82 просмотров
schedule
15.03.2024
Ошибка плагина maven javadoc при использовании с модулями Код выхода: 1 - ошибка: модуль не найден:
У меня есть многомодульный проект, который использует maven в качестве системы сборки. Я хочу создать javadocs для проекта. Я делаю:
mvn -e javadoc: javadoc
Когда maven переходит к первому модулю (Util), я получаю следующее:
Код выхода:...
478 просмотров
schedule
27.02.2024
