Doxygen – вопросы и ответы

48
голосов
0
ответов
Я новичок в Doxygen, и я комментировал свои функции с помощью подхода стиля Qt: /*! .. */ Doxygen, однако, только подбирает мои заголовочные файлы и не создает документацию о любом тексте, который ...
5 лет, 8 месяцев назад joey
71
голос
1
ответ
Я использую Doxygen для документирования моего модуля python, и я пытаюсь заставить его ссылаться на функцию в тексте. Я могу заставить его ссылаться на пространство имен функций в порядке, но не н...
8 лет назад Adam M-W
102
голоса
2
ответа
Здравствуйте, Я пытаюсь использовать doxygen для создания документации по коду из набора папок. Моя структура папок такова: +root +-include/ +-include/subdir/file.h +-src +-src/subdir/file.cpp +-Do...
6 лет, 3 месяца назад Jan Jaap
71
голос
2
ответа
Я добавляю модуль python в код С++, используя boost:: python. Проект С++ документирован с помощью doxygen. Я хочу создать документацию для модуля python, но я не знаю, как не быть избыточным, как э...
3 года, 10 месяцев назад cromod
77
голосов
1
ответ
Как я могу комментировать функции С++ в создателе Qt, чтобы при наведении на вызов функции этой функции я мог видеть документацию как подсказку. Так же, как мы делаем /** newline Eclipse автоматиче...
7 лет, 5 месяцев назад Ahmed
45
голосов
0
ответов
Рассматривать: // In temp.cpp #include "a.h" template <typename T> struct A {}; /// Main int main() { return 0; } // In a.h /// My template /// \tparam T The meaning of T template <typenam...
3 года назад AlwaysLearning
90
голосов
2
ответа
Почти все в моей документации заканчивается префиксом namespace :: перед ним. (где namespace - это имя моего пространства имен) Есть ли способ создать документацию без части пространства имен? Напр...
9 лет, 8 месяцев назад Nathan Osman
44
голоса
1
ответ
Я хочу создать ссылку на центральный глоссарий, используя doxygen. Для создания глоссария я использовал бы файл glossary.md в моем пути поиска doxygen. Содержимое доступно через "связанные страницы...
3 года, 6 месяцев назад Andreas Walter
46
голосов
0
ответов
У меня есть шаблонный C++ класс в моем проекте, который используется только для целей отладки - в обычных сборках он компилируется до пустого /no-op класса. Этот класс становится частным образом ун...
1 год, 7 месяцев назад Jeremy Friesner
82
голоса
1
ответ
У меня есть сложный набор тестов python-selenium (с использованием py.test) в папке, и я waht для использования doxygen для создания документации по всем файлам (и, что более важно, графам вызовов ...
1 год, 2 месяца назад Alex
55
голосов
1
ответ
Могу ли я изменить корень древовидной структуры с помощью специальной ссылки вместо index.html? Или, по крайней мере, добавить html перед древовидной структурой на боковой панели?
6 лет, 3 месяца назад pedromrnd
46
голосов
1
ответ
Кто-нибудь знает, есть ли способ импортировать файлы комментариев в формате XML XML в проект Doxygen? У меня есть проект, который использует сборки, в которых есть файлы комментариев XML. Я бы хоте...
9 лет, 5 месяцев назад Eric Farr
86
голосов
1
ответ
Я не уверен, что это вопрос doxygen или dot , но здесь. В моем проекте у меня есть много файлов, которые должны включать общие заголовки, такие как stdlib.h , stdint.h и т.д. Когда я прошу doxygen ...
6 лет, 4 месяца назад Thomas
77
голосов
1
ответ
Мы используем doxygen для документирования наших классов. Я хотел бы явно указать, что класс сгенерировал конструкторы и/или деструкторы, чтобы указать, что я думал об этом, и решил, что, например,...
8 лет, 9 месяцев назад andreas buykx
-5
голосов
1
ответ
Я использовал Code::Blocks для создания проекта C++ . У меня есть три файла проекта: файл .hxx содержащий объявление шаблона класса; файл .tcc в котором функции-члены шаблона класса определены и до...
2 года, 8 месяцев назад user24098
44
голоса
0
ответов
Я хочу создать ссылку на страницу в документации. В настоящее время я использую /// You will find a copy here. /// /// \ref clicn Я хочу, чтобы ссылка была here а не имя страницы, на clicn ссылаетс...
4 года, 7 месяцев назад Zeus
111
голосов
1
ответ
Я использую Doxygen 1.7.4 для Windows. На странице списка файлов сгенерированной документации я хотел бы видеть относительные пути. Я установил FULL_PATH_NAMES = YES , чтобы иметь что-то большее, ч...
8 лет, 6 месяцев назад Soul Reaver
55
голосов
2
ответа
На данный момент у меня есть: /// @brief Random class. class Foo { /// @brief A private embedded struct of Foo. struct Bar { /// @brief Some value. int x; } } My Doxygen выводит список Bar как "стр...
8 лет назад Daniel Buckmaster
146
голосов
4
ответа
У всех нас есть хорошая привычка документировать наш код, не так ли? В настоящее время сама документация в коде имеет синтаксис. Это почти как язык программирования на себе. Вопросы: Что (сколько) ...
9 лет, 3 месяца назад augustin
104
голоса
1
ответ
Doxygen (v 1.8.11) создает приятные диаграммы сотрудничества UML. Приятно, за исключением того, что они забиты линиями агрегации, идущими на "size_t". Формально правильно, но совершенно бесполезно....
3 года, 7 месяцев назад Joachim W
45
голосов
1
ответ
В эти дни для этой цели был разработан ряд коммерческих и открытых инструментов. Однако (к сожалению) ни одно из них не отвечает моим требованиям в отношении конкретной проблемы, с которой я имею д...
9 лет, 7 месяцев назад Yonas
63
голоса
0
ответов
Я пытаюсь задокументировать проект с Doxygen. Проект состоит из нескольких библиотек, которые все сгенерированы и разработаны в одном проекте. Я хочу, чтобы Doxygen задокументировал проект как един...
7 месяцев, 2 недели назад Narase
74
голоса
1
ответ
Я новичок, чтобы разработать инструмент для статического анализа объектно-c файла с clang сейчас. И я хочу найти способ получить граф вызовов funtion с текстом (который я могу анализировать в прогр...
3 года, 5 месяцев назад CurryChen
63
голоса
0
ответов
Я попытался использовать doxygen-maven-plugin soebes с моим собственным конфигурационным файлом doxygen. Но плагин просто продолжает генерировать конфигурацию по умолчанию doxygen и использует это ...
3 года, 3 месяца назад Eelko de Groot
123
голоса
1
ответ
Я хотел бы знать, можно ли исключить символ из функции автозапуска. У меня есть пространство имен с общим именем (например, Ball), и в документации я использую это имя в фразах, которые полностью н...
6 лет назад V Ronin
112
голосов
4
ответа
Недавно я (наконец) стал документировать один из моих проектов с открытым исходным кодом. Проект представляет собой библиотеку классов для .Net. Я использую Doxygen для создания документации HTML и...
8 лет, 9 месяцев назад Earlz
57
голосов
0
ответов
Visual Studio признает документацию XML и помогает отображать всплывающие подсказки в редакторе на основе этого. Есть ли способ (я думаю, расширение или подобное), чтобы получить такую же функциона...
5 лет, 4 месяца назад user2746401
99
голосов
3
ответа
Недавно я обновился от Doxygen 1.8.4 и GraphViz 2.36, где у меня не возникало проблем с созданием графиков для Doxygen 1.8.7 и GraphViz 2.38 и теперь не получается получать графики. Во время сборки...
5 лет, 7 месяцев назад LarryB
44
голоса
0
ответов
У меня есть этот код /** * @brief Class corresponding to the %PatientData schema type. * * @nosubgrouping */ class __declspec(dllexport) PatientData: public ::abc::def::phsyiology::datamodel::Objec...
5 лет, 2 месяца назад Aaron Bray
46
голосов
1
ответ
Мне интересно, есть ли возможность повторно использовать описание заголовка файла doxygen также для описания модуля. /** \file \brief Some brief info \details more Details */ /** \defgroup Views \b...
3 года, 4 месяца назад Jonny Schubert
56
голосов
0
ответов
Я хотел бы создать документацию, похожую на эту страницу. В принципе, у них есть ссылка API, пояснения и пример кода на одной странице. Пример кода и дальнейшее объяснение каждой функции не содержа...
3 года, 10 месяцев назад gcb
55
голосов
1
ответ
Мы используем Doxygen для создания HTML-документов для проекта с несколькими языками. В некоторых документах я хотел бы ссылаться на источник файла, написанный на языке, не поддерживаемом Doxygen (...
7 лет, 11 месяцев назад skrebbel
99
голосов
1
ответ
Я установил doxygen.dmg. Я использовал эту ссылку для справки: duckrowing Я следил за каждым шагом. Теперь я могу создать html docset, используя этот инструмент doxygen. Но для следующих шагов, соз...
8 лет, 2 месяца назад Mrunal
104
голоса
0
ответов
Я помещаю комментарий doxygen в мои файлы кода. Каждый класс имеет префикс с начальным проектом, например, класс CpDemo (пользовательский демонстрационный класс проекта) Когда генерировать HTML фай...
7 месяцев, 3 недели назад Jai
55
голосов
1
ответ
Теперь я использую Doxygen для создания документов для класса C++: /** brief introduction to the class * * detailed explanations are here. * / class MyClass { public: MyClass() ... } Когда я пишу ч...
4 года, 7 месяцев назад feelfree
78
голосов
2
ответа
У меня есть несколько многострочных макросов, определенных в файле macros.h. В моем doxyfile у меня есть ENABLE_PREPROCESSING = YES MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = NO PREDEFINED = EXPAND...
8 лет, 9 месяцев назад Brynn Mahsman
63
голоса
1
ответ
Я документировал Javadoc, и я высоко оценил интеграцию с Eclipse, но я хотел использовать Doxygen для добавления диаграмм. Я использую теги {link foo} в нескольких кратких описаниях для ссылки на с...
6 лет, 4 месяца назад kikouk
63
голоса
0
ответов
Я использую doxygen для документирования содержимого моей папки cgi-bin на моем веб-сервере apache. На страницах doxygen html есть ссылки на исходный код, но они перестали работать. Требуется ли ко...
1 год, 2 месяца назад Douglas Goodall
57
голосов
1
ответ
У меня есть некоторые крупные, в основном процедурные коды, которые необходимо хорошо документировать. Обычно это предполагает повторное использование ряда функций, которые должны выполняться в опр...
9 лет, 4 месяца назад Aurelius
44
голоса
0
ответов
Я использовал команду mathbb в одном из комментариев к документации /** * @brief Represents a point in $\mathbb{R}^2$ */ Добавлены amsfonts в EXTRA_PACKAGES в моем Doxyfile EXTRA_PACKAGES = amsfont...
3 года, 7 месяцев назад marmistrz
Чтобы , пожалуйста,
Выберите тему жалобы:

Другая проблема