Вопросы по теме 'doxygen'
Документирование перечислений с помощью doxygen
HTML-документация, сгенерированная doxygen для перечислений, перечисляет перечисление слева и документацию справа. Однако мне нужна довольно подробная документация для каждого значения, а некоторые имена очень длинные, из-за чего правый столбец с...
13201 просмотров
schedule
11.12.2022
Фрагмент Javascript для преобразования комментария в стиле doxygen в HTML
В отношении этого вопроса мне было интересно, если кто-нибудь знает фрагмент/библиотеку кода javascript для преобразования одного комментария doxygen в HTML?
Например,
/** This is a comment block
*
* \b bold text
* \i italic text
*/...
651 просмотров
schedule
05.11.2022
Doxygen с внутренним модификатором доступа C#
Я использую Doxygen для создания некоторых документов API для проекта С#, над которым я работаю. У меня довольно много «внутренних» функций в этом проекте, и я не хочу, чтобы Doxygen производил эти подписи в сгенерированном html, который он создает....
3796 просмотров
schedule
09.04.2024
Комментарии Objective C @property
Я использую Doxygen для создания документации для моего целевого кода на C. Однако до сих пор я не смог найти каких-либо указаний о том, как правильно документировать свойства. Примеры, на которые я смотрел, делают это всеми мыслимыми способами....
3655 просмотров
schedule
30.10.2022
использование пространства имен для комментариев Doxygen
Все классы моей библиотеки определены в пространстве имен. Когда я создаю главную страницу для Doxygen, я должен явно использовать это пространство имен в комментариях, чтобы Doxygen генерировал ссылки. Я хотел бы использовать что-то вроде...
2764 просмотров
schedule
03.04.2024
Doxygen / C ++: глобальное пространство имен в списке пространств имен
Могу ли я показать глобальное пространство имен в списке пространств имен документации, созданной с помощью Doxygen? У меня есть некоторые функции, которые extern "C" , они появляются в документации заголовочного файла, который их объявляет, но не в...
1631 просмотров
schedule
30.10.2023
Настройте Doxygen, чтобы скрыть определенные имена или ключевые слова
Я только начинаю работать с Doxygen и много искал по этому поводу, так что простите меня, если есть очевидный ответ.
Я работаю над встроенным проектом, в котором функции могут быть помечены как debug или nodebug перед возвращаемым типом. В...
1341 просмотров
schedule
01.12.2023
Плагин doxygen eclipse, автоматически генерирующий документацию-заглушку?
Я ищу плагин eclipse для документации по коду doxygen. Я нашел плагин eclox ( http://home.gna.org/eclox/ ). Я хотел бы узнать, как он может автоматически генерировать «пустой» комментарий doxygen, который можно было бы заполнить позже, или что...
43917 просмотров
schedule
15.05.2024
Документирование макрофункций в C++ с помощью Doxygen
Как мне задокументировать функцию макроса на C++ с помощью Doxygen и ссылаться на нее в документации моего кода, отличного от Evil?
В частности, у меня есть некоторый обычный класс под названием «Сообщение», определенный в Message.H, от которого...
31335 просмотров
schedule
06.12.2023
Протоколы Doxygen и Objective-C
Я использую мастер Doxygen на Mac (графический интерфейс для Doxygen 1.7.3).
Я обнаружил, что если в заголовке моего класса я #импортирую файл заголовка, в котором определен протокол, первый член моего класса появляется в документах как...
649 просмотров
schedule
22.09.2022
Doxygen сообщает о потенциальной рекурсивной связи класса
У меня есть шаблонный класс С++ base::Foo<class T> , а в другом файле есть класс base::bar::Foo : public base::Foo<Baz> . Doxygen, похоже, это не нравится, так как выдает ошибку
<unknown>:1: Detected potential recursive class...
1448 просмотров
schedule
31.05.2024
Как создать аналогичную документацию Qt через Doxygen?
Выходные данные Doxygen HTML по умолчанию создают документацию такого рода .
Можно ли сделать вывод HTML похожим на Qt3 или стиль документации Qt4 ? Как этого добиться?
Предпочтителен стиль Qt4, однако подойдет и Qt3.
2929 просмотров
schedule
25.10.2023
Как использовать документ Apple Header для автоматической генерации документации для разработки под iOS?
Я использовал инструмент Doxygen для создания документов. Но позже я узнал, что Apple предоставляет «Руководство по набору документации».
Вот справочная ссылка:...
6529 просмотров
schedule
27.11.2022
Как документировать типы параметров функции python?
Я знаю, что параметрами могут быть любые объекты, но для документации очень важно указать, что вы ожидаете.
Во-первых, как указать типы параметров, подобные приведенным ниже?
str (или использовать String или string ?)
int
list...
24778 просмотров
schedule
17.09.2022
Как задокументировать свойство, объявленное в другом файле, с помощью Doxygen?
Я использую mogenerator для создания Основные данные . Mogenerator производит машинные классы и человеческие классы. Разработчик не должен модифицировать сгенерированные машиной классы, так как они генерируются каждый раз, когда вызывается...
1679 просмотров
schedule
14.11.2022
Добавить XML-файл в список файлов
Я хочу добавить содержимое файла XML в документацию, сгенерированную doxygen. Я добавил файл XML в тег INPUT файла конфигурации doxygen. Однако, хотя XML-файл указан в списке файлов, содержимое файла не отображается. Что мне нужно сделать, чтобы...
1577 просмотров
schedule
02.03.2024
Комментарии для функции в Emacs
Я ищу способ генерировать и вставлять блоки комментариев заголовка над моими функциями в Emacs (в любом режиме), с автоматическим содержанием комментария по умолчанию на основе подписи функции (т.е. правильное количество заполнителей @param) ....
1234 просмотров
schedule
27.09.2022
Как заставить doxygen создавать график зависимостей только для веб-страниц (не для tex/PDF)?
Таким образом, хотя SVG масштабируется и доступен для просмотра и выглядит беспорядочно, но нормально в Общая:
Include dependency graph внутри PDF-файла (стр. 195) выглядит действительно беспорядочно:
Я автоматически генерирую...
4431 просмотров
schedule
15.06.2024
Предупреждение Doxygen: задокументированная функция не объявлена или не определена
Я пытаюсь использовать Doxygen в первый раз. При запуске Doxygen мне выдается большое количество предупреждений следующего вида:
.cxx: : предупреждение: документированная функция ` :: ' не была объявлена или определена.
Я не уверен, как...
10284 просмотров
schedule
09.12.2023
Веб-ссылка в документации и поддержка заголовка обратной (myLib / index.html) ссылки
У меня есть библиотека (назовем ее « myLib »), документированная с использованием Doxygen, которая выполняет некоторые (внешние) ссылки / ссылки; для этого я использую синтаксис <a...
602 просмотров
schedule
30.12.2023
