Свързани въпроси 'doxygen'
Doxygen и Objective-C протоколи
Използвам Doxygen Wizard на Mac (GUI за Doxygen 1.7.3).
Открих, че ако в заглавката на моя клас #импортирам заглавен файл, в който е дефиниран протокол, първият член на моя клас се появява в документите като предварително добавен с пътя към...
649 изгледи
schedule
22.09.2022
Как да документираме типовете параметри на функцията на python?
Знам, че параметрите могат да бъдат всякакви обекти, но за документацията е много важно да посочите какво бихте очаквали.
Първо е как да посочите типове параметри като тези по-долу?
str (или използвайте String или string ?)
int...
24778 изгледи
schedule
17.09.2022
Коментари за функция в Emacs
Търся начин да генерирам и вмъквам блокове с коментари за заглавки над моите функции в Emacs (във всеки режим), като съдържанието по подразбиране на коментара автоматично се базира на подписа на функцията (т.е. правилния брой @param контейнери за...
1234 изгледи
schedule
27.09.2022
Doxygen Conditional Markdown Страници
Имам набор от страници за маркиране, които използвам за документиране на моя код в настройка на таблица и използвам @subpage, за да поставя тези страници под страницата на таблицата.
Table.md
Code Table
==========
| Name |...
845 изгледи
schedule
28.09.2022
Документиране на енуми с помощта на doxygen
HTML документацията, генерирана от doxygen за enums, изброява enum отляво и документацията отдясно. Въпреки това имам нужда от доста подробна документация за всяка стойност и някои от имената са много дълги, което прави дясната колона с...
13201 изгледи
schedule
11.12.2022
Javascript фрагмент за конвертиране на коментар в стил doxygen в HTML
Във връзка с този въпрос се чудех дали някой знае ли кодов фрагмент/библиотека на javascript за преобразуване на един коментар на doxygen в HTML?
Например,
/** This is a comment block
*
* \b bold text
* \i italic text
*/
ще се...
651 изгледи
schedule
05.11.2022
Обектив C @property коментари
Използвам Doxygen за генериране на документи за моя objective c код. Досега обаче не успях да намеря никакви насоки за това как правилно да документирам свойствата. Примерите, които разгледах, го правят по всеки възможен начин. Някои хора...
3655 изгледи
schedule
30.10.2022
Как да генерирам подобна на Qt документация чрез Doxygen?
HTML изходът на Doxygen по подразбиране създава този вид документация.
Възможно ли е да направите HTML изхода подобен на Qt3 или Qt4 стил на документация? Как да постигнете това?
Стилът Qt4 е за предпочитане, но Qt3 също ще свърши работа.
2929 изгледи
schedule
25.10.2023
Как да използвам Apple Header doc за автоматично генерирана документация за разработка на iOS?
Използвал съм инструмента Doxygen за генериране на документи. Но по-късно разбрах, че самата Apple предоставя „Ръководство за набор от документи“.
Ето връзката за справка:...
6529 изгледи
schedule
27.11.2022
Как да документирам свойство, декларирано в различен файл с помощта на Doxygen?
Използвам mogenerator за генериране на Core Data класове. Mogenerator произвежда машинни класове и човешки класове. Разработчикът не трябва да променя машинно генерираните класове, тъй като те се генерират при всяко извикване на mogenerator....
1679 изгледи
schedule
14.11.2022
Doxygen/C++: Глобално пространство от имена в списъка с пространства от имена
Мога ли да покажа глобалното пространство от имена в списъка с пространства от имена на документацията, генерирана с Doxygen? Имам някои функции, които са extern "C" , те се появяват в документацията на заглавния файл, който ги декларира, но не и в...
1631 изгледи
schedule
30.10.2023
как да коментирате ucf файл в Doxygen
Искам да използвам Doxygen, за да документирам VHDL проект. Това работи според очакванията за изходните файлове на VHDL. Бих искал обаче да добавя и ucf (файл с потребителски ограничения; Xilinx). Индикаторът за VHDL коментар "--!" явно не работи....
1176 изгледи
schedule
29.10.2023
Защо Doxygen създава толкова много празни папки?
След стартиране на Doxygen върху моята кодова база, той създаде две нови директории: html и latex .
И двете съдържат файлове с документи, както и много от тези празни папки:
/html
├── d0
│ ├── d00
│ ├── d01
│ ├── d02
│ ├── d03
│...
373 изгледи
schedule
01.12.2022
Конфигурирайте Doxygen да скрие определени имена или ключови думи
Току-що започвам с Doxygen и проучих доста по този въпрос, така че ме извинете, ако има очевиден отговор.
Работя върху вграден проект, където функциите могат да бъдат маркирани като debug или nodebug преди типа на връщане. В повечето от нашите...
1341 изгледи
schedule
01.12.2023
Документиране на макро функции в C++ с Doxygen
Как да документирам макро функция в C++ с помощта на Doxygen и да се позова на нея в документацията на моя не-Evil код?
По-конкретно, имам някакъв нормален клас, наречен „Съобщение“, дефиниран в Message.H, от който потребителите могат да...
31335 изгледи
schedule
06.12.2023
Генериране на doc за външни файлове с помощта на Doxygen
Имам собствени източници и включвам в тези две папки:
/A/B/C/MyProject/src/
/A/B/C/MyProject/include/
Но също така използвам библиотека xx, която има заглавки
/A/xx/include
В конфигурацията на doxygen давам главната папка на моя...
231 изгледи
schedule
26.10.2022
Предупреждение на Doxygen: документираната функция не е декларирана или дефинирана
Опитвам се да използвам Doxygen за първи път. При стартиране на Doxygen ми се представят голям брой предупреждения от следната форма:
.cxx: : предупреждение: документирана функция ` :: ' не е декларирана или дефинирана.
Не съм сигурен как да...
10284 изгледи
schedule
09.12.2023
Уеб връзка в документацията и поддържайте обратна (myLib/index.html) заглавка на връзката
Имам библиотека (да я наречем " myLib "), документирана с помощта на Doxygen, която прави някои (външни) препратки/свързване; за това използвам синтаксиса <a href="/bg../path/to/other/documentation/page/index.html">OtherDoc</a> . Това е...
602 изгледи
schedule
30.12.2023
Автоматичната връзка на Doxygen към Java класове не работи, освен ако не е квалифициран
Според ръководството на doxygen " Всички думи в документацията, които съответстват към документиран клас и съдържат поне един знак, който не е малък, автоматично ще бъдат заменени от връзка към страницата, съдържаща документацията на класа. "...
398 изгледи
schedule
28.12.2023
Как да документирам errno стойност с Doxygen?
Имам функция, която задава errno при възникване на грешка. Искам да документирам възможните errno стойности. Но изглежда, че Doxygen поддържа само изключение, а не errno . Възможно ли е да се документират errno стойности като страница с...
503 изгледи
schedule
03.01.2024
