Вопросы по теме 'doxygen'
Настройка вывода doxygen для оглавления HTML
Я использую doxygen для создания ссылки на API из исходного кода, стремясь преобразовать его в файл справки CHM и, в конечном итоге, в плагин для Eclipse. К сожалению, порядок и вложенность классов, пространств имен и т. д. по умолчанию в таблице...
4210 просмотров
schedule
31.12.2022
Комментарии в стиле Doxygen в Кейт
У Кейт есть очень удобное сочетание клавиш (Ctrl+D) для применения однострочных и многострочных комментариев к выделенной области текста. Как настроить Kate для применения комментариев в стиле doxygen к исходным файлам C/C++?
/**
* reduces the...
1127 просмотров
schedule
28.06.2023
Doxygen не работает с публичными блоками после приватных блоков в классе
Как мне сказать Doxygen документировать публичные разделы после приватного раздела в классе (C ++)?
E.g.
class Brg {
public:
//! this function will be documented
void documentedFunction1()
private:
void irrelevantFunction()...
1190 просмотров
schedule
18.10.2022
Добавление пользовательской команды в doxygen
Я хотел бы добавить пользовательскую команду в свою документацию по doxygen. По сути, для каждой функции C, для которой я пишу документ, мне нужно написать, какие глобальные переменные «касаются» в режиме чтения или в режиме записи. Это как список...
2656 просмотров
schedule
13.03.2022
Как связать функции, не являющиеся членами, с классом в Doxygen?
Я уверен, что есть какой-то способ сделать это с помощью тегов \defgroup, \addgroup и \@{ \@}, но после пары часов проб и (очевидно) ошибок я прошу ТАК.....
У меня есть:
class C {
public:
void foo () const;
};
и у меня есть некоторые...
1888 просмотров
schedule
28.10.2022
Отметка использования примера в документации по коду
Как лучше всего размещать примеры использования в документации по коду? Есть ли стандартный способ? С @usage или @notes? Поддерживают ли генераторы документов это?
Я знаю, что этот вопрос должен зависеть от генератора документации. Тем не...
1720 просмотров
schedule
30.03.2022
Есть ли способ сказать Doxygen игнорировать (все) пространства имен?
Почти все в моей документации заканчивается префиксом namespace :: перед ним. (где namespace — это имя моего пространства имен)
Есть ли способ сгенерировать документацию без части пространства имен?
Например:...
3726 просмотров
schedule
03.10.2023
Остановить doxygen (в некоторых каталогах) для рекурсивного ввода
Я использовал этот туто ( http://www.duckrowing.com/2010/03/18/documenting-objective-c-with-doxygen-part-ii/ ), чтобы создать свою документацию... Я хотел бы запустить doxygen в некоторых каталоги, а не в других! Проблема в том, что я не хочу...
1331 просмотров
schedule
13.05.2024
Как удалить ссылки на строки при генерации вывода в doxygen?
Я хочу удалить строки, выглядящие следующим образом, но я все еще хочу вернуть просмотр исходного кода
Definition at line 377 of file xxx.h.
Я пробовал следующие два в файле конфигурации doxygen, но они просто удаляют перекрестные ссылки на...
4556 просмотров
schedule
07.09.2022
Как включить пользовательские файлы в Doxygen
Я хотел бы добавить пользовательские (не проектные) файлы для создания дополнительных страниц с помощью Doxygen .
Я (на самом деле был) не уверен, как следует называть эти файлы и как их содержимое должно быть отформатировано.
60617 просмотров
schedule
07.02.2023
Doxygen переключатель
У меня есть довольно большой оператор switch (или такой же большой оператор if), который я хотел бы задокументировать как-то в Doxygen, возможно, в его Caller Graph или, может быть, в каком-то формате блок-схемы.
Как я могу этого добиться? Спасибо !
1784 просмотров
schedule
24.12.2022
Можно ли интегрировать Doxygen с Netbeans C++?
Я читал о Doxygen в Интернете и думаю, что хотел бы попробовать его в своих проектах Netbeans C++. Проблема в том, что я нигде не могу найти учебники/руководства о том, как заставить Doxygen работать с Netbeans. Я нашел несколько сообщений в блогах,...
4909 просмотров
schedule
20.07.2023
Как расширить макросы с помощью doxygen, но не документировать их как определение?
Скажем, у меня есть:
#define MY_MACRO(FOO) void FOO();
MY_MACRO(hi);
MY_MACRO(hey);
MY_MACRO(hello);
#undef MY_MACRO
Я хочу, чтобы макросы были расширены с помощью doxygen, что я могу сделать, настроив его правильно:...
6568 просмотров
schedule
12.06.2024
Есть ли способ документировать файл cuda .cu с использованием doxygen
Поскольку файл cuda «.cu» в основном c, есть ли способ использовать doxygen для создания документации для файлов «.cu»? Я заметил, что NVIDIA использует doxygen для создания документации cuda. Однако, когда я использую doxygen, файлы «.cu»...
2788 просмотров
schedule
21.08.2023
Doxygen-как документировать файлы с нестандартным расширением (.INI)
У меня простой вопрос: как документировать файл .INI?
У меня есть проект C++ со следующим макетом:
readme.txt
src
main.cpp
data
simple.ini
У меня нет проблем с созданием документа из readme.txt и main.cpp, но документ в simple.ini...
2960 просмотров
schedule
17.05.2023
Можно ли включать примеры кода при использовании HeaderDoc или Doxygen?
Я пишу структуру Cocoa в Objective-C и хотел бы использовать автора документации для создания ссылки на API. Для .NET легко включить примеры, используя:
/// <example>
/// <code lang="c#">
/// Console.WriteLine("Hello, World!");
///...
904 просмотров
schedule
23.04.2024
Как настроить Doxygen для правильного документирования категорий Objective-C
Doxygen, похоже, имеет идиосинкразическую обработку категорий Objective-C, и я хотел бы знать, смогли ли другие успешно обойти это. Я хотел бы, чтобы doxygen документировал все категории класса как отдельные объекты, независимо от того,...
3487 просмотров
schedule
28.05.2022
Как использовать doxygen для создания диаграмм классов UML из исходного кода C++
Я искал материал, описывающий, как генерировать простые диаграммы классов с помощью doxygen, но не смог его найти. Кто-нибудь может помочь?
Мне нужно создать диаграммы, как показано ниже, из набора файлов C++.
Если есть лучшие инструменты...
117777 просмотров
schedule
10.06.2023
Objective-C, Doxygen и как показать классы AppKit в документации
Я хочу включить классы AppKit в информацию о наследовании. Например, если у меня есть SuperWindowController и он наследуется от NSWindowController, то я хотел бы, чтобы это упоминалось в сгенерированных файлах HTML. В моем случае меня больше...
151 просмотров
schedule
01.12.2022
Doxygen не документирует статические классы?
Недавно я использовал Doxygen для своего проекта. У меня проблема, однако, что он не будет генерировать правильную документацию для статического класса С#. Есть ли какая-то опция, которую я должен включить?
Мой полный исходный код для...
12197 просмотров
schedule
01.02.2024
