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

53
голоса
1
ответ
Я хотел бы документировать свой код гибким способом, так что, когда что-то меняется, например, версия, год (авторское право), мне не нужно вносить изменения вручную в мои> 100 файлов. Мой заголо...
1 месяц, 3 недели назад Tengis
119
голосов
1
ответ
Для документации нам обычно нужно создать дополнительный документ, описывающий, что мы сделали, когда какие-либо сообщения lint были отключены в коде (e.g. /* lint --e228) . Было бы намного проще и...
1 месяц, 3 недели назад user1987872
53
голоса
2
ответа
Ищете что-то похожее на Modelmaker, которое было для Delphi. Отображение зависимостей модулей. Любая помощь приветствуется. Доксиген был замечательным до сих пор. Если кто-то знает, возможно ли что...
1 месяц, 3 недели назад user4910881
180
голосов
3
ответа
Я знаю, что можно использовать markdown внутри комментариев, и doxygen может это понять. Но мне нужно знать, можно ли создать документацию в формате уценки? Мне нужна эта документация, которая буде...
1 месяц, 3 недели назад Sudar
64
голоса
1
ответ
Я хотел бы добавить подробные сведения о моих основных классах, не вставляя их все выше этих классов в исходный файл. Например, я хотел бы создать отдельный файл с объемной информацией о классе Foo...
1 месяц, 3 недели назад charliep
56
голосов
2
ответа
Для кода C++ у doxygen нет непреодолимой проблемы с \code{.markdown} . Например //=========================================================================== //! \defgroup markdown_cpp C++ markdown...
1 месяц, 3 недели назад Daniel J. Greenhoe
53
голоса
1
ответ
Теперь у меня есть куча исходных файлов C с уже вставленными комментариями, которые находятся в формате /*****......*****/ для функций и /*....*/ для фраз и переменные. Моя задача - документировать...
1 месяц, 3 недели назад jcraffael
63
голоса
1
ответ
Можно ли использовать документальные комментарии для тестовых случаев, определенных с помощью макросов Boost.Test? Могу ли я использовать комментарии в стиле Doxygen, будут ли они правильно разбира...
1 месяц, 3 недели назад Marc Andreson
116
голосов
2
ответа
Документация Doxygen гласит, что \group можно использовать для добавления объекта в несколько групп: \ingroup (<groupname> [<groupname> <groupname>]) Проблема в том, что я попробо...
1 месяц, 3 недели назад user2432986
90
голосов
2
ответа
Если у меня есть моя документация отдельно от моего кода, как мне помочь Doxygen различать перегруженные функции (что использовать в поле \fn )? Одна функция будет документирована следующим образом...
1 месяц, 3 недели назад Paul Manta
74
голоса
1
ответ
Я использую комментарии к документации для кислорода и XML для создания внутренней документации API для наших фреймворков. Doxygen создает "пакет" для пространства имен. Интересно, возможно ли доба...
1 месяц, 3 недели назад Jan
64
голоса
1
ответ
Я пытаюсь использовать комментарий для группы переменных в документации по файлу Fortran 90, используя doxygen 1.7.3: !> The parameters defined to convert R to Q real(wp),allocatable :: A(:) int...
1 месяц, 3 недели назад Amir
75
голосов
2
ответа
Я работаю с некоторым устаревшим кодом, для которого я создаю документацию XML, используя doxygen. У меня две проблемы с этим кодом. Сначала он содержит недопустимые комментарии. Например: ///@stru...
1 месяц, 3 недели назад Paperback Writer
52
голоса
1
ответ
Я использую doxygen для отслеживания функций и пользовательских историй в моем проекте. Для этого я хотел бы создать ссылки следующим образом: перечислены абзацы, которые являются достоинствами: -#...
1 месяц, 3 недели назад Moravas
64
голоса
1
ответ
Я пишу программу на C. Из-за статического ввода языка, его необходимо дублировать функции следующим образом: void foo_8(uint8_t thingy); void foo_16(uint16_t thingy); void foo_32(uint32_t thingy); ...
1 месяц, 3 недели назад MarkP
65
голосов
1
ответ
Как перевести этот комментарий с doxygen на javadoc? /// <typeparam name="SolutionType">the custom solution data type, derived from <see cref="Solution{InputDataType}">Solution</see&...
1 месяц, 3 недели назад user2381422
53
голоса
1
ответ
Я хочу установить Doxygen плагин из этой ссылки на моем qt-creator3.3.0 . Я не нашел пакетов для этой версии. Я пробовал другие версии, и я не получил никакого результата. Кто-нибудь знает, что мне...
1 месяц, 3 недели назад Ali Mirzaei
55
голосов
2
ответа
У меня есть простой проект doxygen, состоящий из Doxyfile и файла конфигурации, project.txt . В файле project.txt меня есть документация, написанная вручную, которая использует перекрестные ссылки ...
1 месяц, 3 недели назад DevNull
91
голос
3
ответа
Я использую Doxygen для документирования API, написанного на Objective-C. Doyxygen не понимает NS_ENUM typedef. Я нашел это решение, но это не сработало для меня. ENABLE_PREPROCESSING = YES MACRO_E...
1 месяц, 3 недели назад Ido Ran
54
голоса
1
ответ
Я хочу прокомментировать мой код на Фортране с помощью doxygen и обнаружил, что есть два официальных источника документации: http://www.doxygen.nl/manual/docblocks.html#fortranblocks
1 месяц, 3 недели назад Eenoku
82
голоса
1
ответ
Я использую doxygen для создания документации по API и хочу добавить некоторые учебные пособия (будет записано в файлах dox). Я хотел бы добавить новую вкладку "Учебники" в navindex. Как мне это до...
1 месяц, 3 недели назад Bangyou
82
голоса
1
ответ
Я бы не хотел этого раздражать: Generating docs for compound bla_param... /home/mathieu/Projects/bla_parser.h:57: warning: Found unknown command `\0' /home/mathieu/Projects/bla_parser.h:57: warning...
1 месяц, 3 недели назад malat
101
голос
1
ответ
Я пытаюсь использовать doxygen для создания пользовательской справки, когда я использую команду \tableofcontents на главной странице, ничего не отображается в html-выходе. Я просто не знаю, почему,...
1 месяц, 3 недели назад user1416414
65
голосов
1
ответ
Я новичок в doxygen, поэтому у меня есть некоторые проблемы. Я хочу добавить теги, такие как \param,\brief и т.д. В документацию, но по какой-то причине сгенерированная html-страница показывает тол...
1 месяц, 3 недели назад ruhig brauner
54
голоса
2
ответа
Предположим, что у вас довольно сложный README, который вы хотите, чтобы Doxygen обрабатывал, чтобы подготовить основную документацию, что-то вроде /*! \mainpage Welcome to this code \section S1 In...
1 месяц, 3 недели назад Davide
74
голоса
2
ответа
Я новичок в doxygen, и я не смог найти синтаксис для меня, чтобы создать ссылку с главной страницы на определенную страницу в разделе связанных страниц. Например, я ищу что-то похожее на это: http:...
1 месяц, 3 недели назад Fluffy
74
голоса
1
ответ
Я создаю html для моего проекта c++, используя doxygen. Doxygen создает страницу списка файлов, но ни один из перечисленных файлов заголовков не ссылается на страницу документации. Например, в спис...
1 месяц, 3 недели назад brian
66
голосов
2
ответа
Я знаю, что есть опция doxygen, чтобы показать включенные графики, например a.cpp включает ah и bh ah включает ch ch включает <unistd.h> Но unistd.h также включает в себя <features.h> н...
1 месяц, 3 недели назад Uroc327
66
голосов
1
ответ
Я пишу асинхронную библиотеку, и некоторые из моих методов принимают обратные вызовы в качестве параметров: /// \brief Opens a connection to the remote server defined by the parameters passed in th...
1 месяц, 3 недели назад ruipacheco
53
голоса
1
ответ
Я новичок в Doxygen и пытаюсь выяснить, можно ли его использовать для следующей необходимости. У меня есть следующий код: typedef struct definition { int val; const char* name; const char* desc; } ...
1 месяц, 3 недели назад vmayer
54
голоса
1
ответ
Я использую doxygen для создания документации для своих кодов С# и включил treeview. Однако древовидная структура слева содержала якорь функций. Как я могу отключить их? Спасибо за любое предложени...
1 месяц, 3 недели назад Bangyou
83
голоса
1
ответ
Я пытаюсь создать граф вызовов, используя doxygen и graphiz. После ответов, размещенных здесь и здесь, я добавил точку в PAT
1 месяц, 3 недели назад Sebi
74
голоса
1
ответ
Проблема В настоящее время мы хотим перейти от ручной к автоматической документации по C-коду, повторно используя наши предыдущие результаты OpenOffice. Фон За последние 10 лет мы вручную создали м...
1 месяц, 3 недели назад Ralf
84
голоса
1
ответ
Я хочу использовать doxygen для документирования c-подобного языка. У меня есть некоторые проблемы для решения ключевых слов, которые неизвестны в контексте. Например, я должен использовать функцию...
1 месяц, 3 недели назад Luigi Di Carmino
56
голосов
2
ответа
У меня есть следующая проблема с использованием doxygen в проекте C. У меня много внутренних структур, которые не документированы. Поэтому он устанавливает EXTRACT_ALL=NO в моем Doxyfile. К сожален...
1 месяц, 3 недели назад M.K. aka Grisu
83
голоса
1
ответ
Я новичок в Doxygen и недавно столкнулся с проблемой, которую я не мог решить. У меня есть этот фрагментированный код: /*! \def nAsserts Uncomment that line so that all asserts would be removed */ ...
1 месяц, 3 недели назад Cheng Lai
101
голос
1
ответ
Я имею в функции следующую переменную: 97 98 UINT8 Reponse; 99 static UINT8 Initialisation = 0; 100 static DWORD StartTime = 0; // Инициализация - это также имя одной функции: void Initialisation(v...
1 месяц, 3 недели назад schneiderj
64
голоса
3
ответа
У меня есть мой doxygen в каталоге my/utils, и мой источник находится в другом каталоге в корне ( /code_with_doxygen ), как я /code_with_doxygen сделать относительное имя пути для него, поскольку о...
1 месяц, 3 недели назад Weffel
53
голоса
1
ответ
Как изменить внешний вид того, как исходный код представлен в doxygen? Я имею в виду, когда вы щелкаете по ссылке, чтобы просмотреть исходный код файла (ов), сгенерировавшего документацию. Меня инт...
1 месяц, 3 недели назад Juan
105
голосов
1
ответ
У меня есть код, который я хочу документировать с такими комментариями: /*! \file best.cpp * \brief The best * * I am the best */ /*! \fn void theBestFunction(int) * I'm the best blah blah blah */ ...
1 месяц, 3 недели назад Andrew Lee
Чтобы , пожалуйста,
Выберите тему жалобы:

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