Описание тега doxygen-addtogroup

Вопросы с тегом
1 ответ

Документация дубликатов Doxygen от @file и @defgroup

Я использую Doxygen для документирования проекта. В одном файле у меня есть куча открытых функций, которые я хочу поместить в группу. Я делаю это следующим образом: /** @file myFile.c @brief This is a file. It has stuff. */ /** @defgroup my_group Gr…
09 апр '15 в 20:39
1 ответ

C и doxygen - удаление дубликатов переменной документации

Я документирую свой код C с помощью Doxygen. Для лучшей читаемости я группирую документацию каждой пары файлов.c/.h (иногда также больше файлов) с defgroup а также addtogroup (см. doxygen в c: группировка определений). Страницы файла выглядят хорошо…
08 янв '15 в 17:00
1 ответ

Положить изображения рядом на Doxygen

Я пытаюсь разместить несколько изображений на моей главной странице файла Doxygen, но мне не повезло найти ответ в Интернете. Doxygen помещает две картинки друг на друга. Есть ли способ сделать это рядом?
22 май '18 в 21:36
1 ответ

Есть ли способ, как отличить группы в enum, используя doxygen?

Я хотел бы прокомментировать большой enum и сгруппировать некоторые элементы enum (которые следуют друг за другом) Представьте enum вот так: /** @brief device OpCodes */ typedef enum opCodes_e { A = 0, ///< init /** @addtogroup bluetooth commands…
25 фев '16 в 21:36
1 ответ

Индекс кислородных групп и модулей

Я создаю документ Doxygen для моего проекта. Недавно я сгруппировал связанные классы, используя \addtogroup тег. После этого у меня есть вкладка модуля в моей документации. Показывает все модули. Я хочу добавить описание прямо под именем модуля под …
30 мар '10 в 11:40
1 ответ

Добавление справочных таблиц в Doxygen

В моем приложении C++ у меня есть около 10 различных классов, которые определяют определенные "поведения" (назовем их A, B, C, ...). Другие места (методы) в коде могут использовать эти поведения в любой комбинации. Например, метод M1 использует пове…
30 апр '13 в 07:36
1 ответ

Как использовать \addtogroup с командой ALIASES?

Я пытаюсь создать собственную команду для облегчения работы с группой. Идея в общем... ALIASES += opengroup{1}="^^* \addtogroup \1_GROUP ^^ * \{ ^^" ALIASES += close="\}" ... использовать в файле кода как... /** \opengroup{LEVEL_1} */ // ...code sta…
13 сен '18 в 12:45
2 ответа

Документирование пространств имен с помощью Doxygen

У меня проблемы с распознаванием пространств имен и модулей Doxygen. Я считаю, что проблема заключается в том, чтобы разместить \addtogroup в пространстве имен или вне пространства имен. Пример 1, вне пространства имен: /*! * \addtogroup Records * @…
16 фев '10 в 19:13
1 ответ

Как отразить структуру каталогов C с помощью групп Doxygen?

Мне нужна базовая помощь с использованием Doxygen на C-коде. Все основные документы выходят хорошо, и я хочу помочь структурировать большой длинный длинный список файлов и функций. У меня есть исходное дерево C, которое выглядит так: src/ +--util/ +…
25 фев '11 в 10:13
0 ответов

Не включать пользовательские страницы уценки в качестве страниц верхнего уровня при включении их в качестве подстраницы?

Я добавляю файлы уценки в свои группы в Doxygen следующим образом: /** * @addtogroup foobar "Foo Bar" * @{ * @subpage doc_foo_bar */ И они отображаются в документации модуля в соответствии с просьбой. Но в любом случае они отображаются как обычные с…
09 дек '14 в 11:30
2 ответа

Результаты по Doxygen Defgroup в пустой группе

У меня есть файл реализации класса C++, который имеет некоторые константы. Константы появляются перед реализациями метода класса. Я хочу сгруппировать константы вместе. Мои группы и описания отображаются на вкладке Модули, но все группы пусты. Подро…
26 мар '12 в 14:04
0 ответов

Есть ли у doxygen лучший фильтр для JavaScript?

Я знаю, что Doxygen не поддерживает файлы JavaScript. Я также посмотрел на скрипт js2doxy.pl, а также это: Документирование JavaScript с помощью Doxygen Первый вариант (js2doxy.pl) не производит соответствующий код C++, он также пропускает все метод…
18 июл '16 в 20:08
1 ответ

Генерация исходного кода для конкретного файла с использованием Doxygen

Установка SOURCE_BROWSER = TRUE показывает исходный код для всех файлов. Можно ли показать источник конкретного файла? Или включите \ref или эквивалентный, используя SOURCE_BROWSER = FALSEИли удалите исходный код для конкретных файлов, если SOURCE_B…
23 июн '14 в 17:36
1 ответ

Как генерировать документы Doxygen на языке DSL

Я хочу создать документ Doxygen для моего DSL(предметно-ориентированного языка). Поскольку мой язык DSL полностью отличается от языков C,C++,Java. По сути, мой проект - плагин eclipse, и мы разрабатываем IDE для языка DSL, в котором я хочу создать D…
10 сен '15 в 11:27
1 ответ

Почему языковая опция Objective C не найдена в графическом интерфейсе Doxygen?

Я пытаюсь использовать Doxygen GUI для генерации документации для моего проекта iPhone. В этом есть опция "выбрать язык программирования для оптимизации результатов". В этой опции я не могу найти опцию Objective C. Когда я запускаю кислород, он пока…
02 авг '13 в 07:47
1 ответ

Doxygen: предупреждение о конце файла во время создания группы при создании массива

Эта проблема связана с ограничениями парсинга. Я использую doxygen 1.8.11 с Eclox (плагин eclipse) в Kinetis Design Studio для разработки встроенного Си. Почти все работы по компилированию doxygen, за исключением того, что мне нужно иметь несколько …
30 авг '16 в 21:45
1 ответ

Как скрыть объявление частного класса в документации doxygen

class class1: public: ... private: class impl; //the class that i wanna hide std::unique_ptr<impl> impl_; // мой файл doxygen: EXTRACT_ALL = ДА EXTRACT_PRIVATE = NO EXTRACT_PACKAGE = NO EXTRACT_STATIC = НЕТ EXTRACT_LOCAL_CLASSES = ДА EXTRACT_L…
07 апр '16 в 06:17
0 ответов

Перечисление doxygen, показанное дважды в индексе, когда в группе

Существует заголовочный файл, содержащий перечисление typedef. Я не могу изменить этот заголовок. Enum используется в моем проекте, и мне нужно документировать enum. Я делаю это, добавляя команду @enum doxygen в файл.dox следующим образом: /** @addt…
11 янв '16 в 22:48
1 ответ

Doxygen не собирает все \ todo в глобальном списке todo

У меня проблема с доксигеном. Не все мои \todo собраны в глобальном списке todo, но большинство из них. Я сделал простой C-пример с одним исходным файлом и файлом заголовка, а также с файлом конфигурации, где я разместил задачи везде, где хочу, чтоб…
14 окт '19 в 09:13
1 ответ

Как добавить нашу собственную определенную вкладку в документацию doxygen

Вывод вашего кода Привет, я хочу добавить еще одну вкладку на страницу, т.е. я хочу, чтобы вкладка "Lokesh" находилась между основными и связанными страницами. Я приложил снимок экрана для справки.
12 авг '20 в 17:09