Описание тега doxygen
Doxygen - это приложение для создания многоязычной документации для C++, C, Java, Objective-C, Python, IDL, Fortran, VHDL, PHP и C#, которое поддерживает широкий спектр выходных форматов, включая RTF, HTML, XML и PDF.
1
ответ
Doxygen: как ссылаться на функцию, но со значениями аргументов
Когда я создаю документацию для этого класса: class MyClass { /** Some description * \param inhibit some description */ virtual void inhibitSaving( bool inhibit = true ) = 0; /** \return true if @ref inhibitSaving with parameter set to true has been…
01 фев '17 в 13:25
2
ответа
Как сгенерировать блок-схему из кода C, используя Doxygen
Я новичок в Doxygen, у меня мало сомнений по этому поводу Можем ли мы сгенерировать блок-схему из кода C, используя Doxygen? Если да, нужен ли какой-нибудь плагин? На самом деле я установил GraphViz для CallGraph. Если есть какая-либо ссылка для соз…
13 июл '18 в 04:55
2
ответа
Греческие символы в документации по Doxygen
Мне нужно кратко обсудить некоторую математику в моей документации по коду, и я бы хотел вставить настоящую греческую букву (лямбда в нижнем регистре), а не использовать слово "лямбда". Как я могу сделать это в Doxygen? Я только однажды баловался HT…
15 авг '13 в 16:17
3
ответа
Как получить Doxygen, выделите нажатый метод
Когда метод выбирается из индекса, он переходит к подробной документации метода. Однако, если метод оказывается в нижней части страницы, визуально не легко найти документацию по интересующей функции. Документы Python облегчают эту задачу, выделяя за…
12 май '14 в 22:14
0
ответов
doxygen добавить подстраницу в таблицу
В моей документации по Doxygen для HTML у меня есть несколько подстраниц (@subpage), которые я хотел бы включить в мою таблицу содержания (@tableofcontents). На данный момент у меня есть @section secname NameOfSection @subpage pname "NameOfSection" …
12 фев '18 в 11:51
0
ответов
Doxygen жалуется, что сущности в исключенных файлах не документированы
Doxygen 1.8.11 выдает следующее предупреждение: /home/meir/Dropbox/CurrentWork/Development/SearchLib/core/util/reflection/struct_2_stream.h:9: warning: Compound slb::core::util::print_visitor is not documented. Тем не менее, файл конфигурации находи…
10 окт '16 в 13:47
1
ответ
Документ унаследовал методы Obj-C без предупреждений Doxygen/compiler?
Фон: Я создаю иерархию составных структур данных словаря в Objective-C и наследую от NSMutableDictionary, чтобы эти классы можно было использовать везде, где требуется NSDictionary/NSMutableDictionary. (Просто чтобы люди не думали, что я заново изоб…
16 июн '09 в 16:41
1
ответ
Doxygen: именование вложенной структуры
Когда doxygen используется для документирования вложенной структуры C, как показано ниже: struct level0 { struct level1 { struct level2 { int data1; } var_level2a; struct level2b { int data2; int data3; } var_level2b; } var_level1; }; В сгенерирован…
06 мар '13 в 12:39
0
ответов
Doxygen C++ показывает строку #include для определений на уровне пространства имен
Для определений на уровне пространства имен, которые не являются классами (например, typedefs, enums, functions), Doxygen не показывает #include строка, которую пользователь должен использовать, как это делается в документации класса. Это так, когда…
31 окт '17 в 12:18
0
ответов
Создать Doxygen Комментарии
Я генерирую большое количество кода, и мне нужно, чтобы он соответствовал определенному стандарту кодирования. Я ищу программу командной строки, где я передам ей файл, и он автоматически добавит комментарии в стиле doxygen для параметров и возвращае…
17 июл '13 в 19:26
0
ответов
Параметр универсального типа, помеченный как ковариантный с ключевым словом "out", неправильно отображается в doxygen
У меня есть интерфейс с параметром типа, помеченным как ковариантный с ключевым словом "out": public interface IMultiLineResponseParser<out TResponse> Это делается с помощью doxygen в: IMultiLineResponseParser Шаблон интерфейса Ключевое слово …
17 окт '17 в 09:12
1
ответ
Ссылка на внешнюю документацию URL из комментариев Objective-C в стиле doxygen
Я хочу написать что-то похожее на это: /** Post a review. (For every place belongs only one review. If it was already written, the previous one will be overwritten.) @param placeId Place identifier @param rating Rating 0-5 for the place @param revie…
20 авг '15 в 16:19
0
ответов
Документирование перегруженных функций SFINAE с помощью Doxygen
Я пытаюсь документировать следующие перегруженные функции SFINAE (обе) с помощью Doxygen 1.8.11: template <typename T, typename std::enable_if< std::is_integral<T>::value, int >::type = 0> auto func(T x); template <typename T, t…
12 апр '16 в 13:05
2
ответа
Есть ли способ исключить функции и элементы уровня пакета из вывода Doxygen?
Я работаю с Doxygen на рабочем месте, и у меня проблемы с кодом Java. Если EXTRACT_ALL=NO, EXTRACT_PRIVATE=NO, EXTRACT_STATIC=NO, EXTRACT_LOCAL_CLASSES=NO и EXTRACT_LOCAL_METHODS=NO, выходные данные по-прежнему содержат статические элементы, которые…
19 июн '09 в 18:08
1
ответ
Doxygen не делает различий между `union myname` и`struct myname`
Я написал небольшую матричную библиотеку как часть большого проекта, над которым я работаю. Было важно иметь транспонирование с нулевой стоимостью, поэтому я использовал / злоупотреблял профсоюзами. Сам код работает нормально (приведен ниже), но ког…
25 ноя '17 в 06:58
1
ответ
Doxygen: Не удается установить файл.docset в Xcode5
Я создал документацию Doxygen для проекта Objective-C/C (без C++), запустив: doxygen ,,, а затем в выходной каталог: make В результате получается файл с именем MyProject.docset., Файл прекрасно устанавливается, например, в Dash.app, однако он не дае…
10 дек '13 в 03:19
1
ответ
Включить документ MS-Word в Doxygen
В дополнение к документированному исходному коду C я хотел бы включить документ MS-Word об архитектуре программного обеспечения в документацию HTML, созданную Doxygen. Как я могу достичь этого? Есть ли способ конвертировать MS-Wordfile *.docx в Doxy…
03 окт '12 в 12:10
1
ответ
Вложенный доксиген \if \endif образец не работает
Вложенный пример if / endif не работает должным образом: http://www.stack.nl/~dimitri/doxygen/manual/commands.html Это производит: Unconditionally shown documentation. More text. Unconditional text. Но я бы ожидал: Unconditionally shown documentatio…
14 янв '14 в 13:58
1
ответ
Ошибка в файле патча doxverilog
Я установил Doxverilog 2.7, а также скачал исходные каталоги Doxygen 1.8.1 с этого сайта https://github.com/ewa/doxverilog Установку doxygen можно загрузить с: http://sourceforge.net/projects/doxygen/files/ Я использую cygwin вместе с установкой пак…
06 ноя '15 в 10:20
1
ответ
Doxygen Как сделать общую документацию для папки
Я хотел бы добавить описания для каждой папки, как указано на рисунке: Это возможно?
30 окт '15 в 11:42