Doxygen - популярен генератор документация въз основа на оригиналните текстове. Какво е Doxygen, много добре написано в Уикипедия, така че статията, ще кажа само за това как бързо да се създаде и да започнете да използвате Doxygen.
По този начин, етапът на процеса по стъпка:
1. Изтегляне на връзката [1], версии са достъпни за Linux i386, Mac OS X 10.6 (Snow Leopard), Mac OS X 10.4 (Tiger), Windows XP / Vista / 7, както и източника (Doxygen се разпространява под лиценз GPL).
2. Стартирайте Doxygen-1.7.2-setup.exe. Ние отговаряме на прости въпроси традиционната инсталатор (тъп могат да извлекат Next). След инсталационната папка ще бъде C: \ Program Files \ Doxygen \, където е цялата система на Doxygen, документацията по него, и комунални услуги.
3. Стартирайте C: \ Program Files \ Doxygen \ бин \ doxywizard.exe. Това е програма, която ви позволява да се опрости създаването и използването на конфигурационен файл за документация (Doxygen GUI на интерфейса).
5. Сега трябва да отидете в раздела и кликнете върху бутон Run Run Doxygen:
Ако по време на съставяне на документация в източника текстове възникнат грешки, те се показват в полето за изход "Output произведени от Doxygen". В доклада се посочва, номерата на редовете в които са открити грешки. Line номера в съобщенията "таг без съвпадение", не може да съвпада с линиите, в които тези грешки са всъщност.
Стартиране поколение документация може да се извърши и от командния ред чрез въвеждане на командата (довереник-файл конфигурационен файл Doxygen):
Ако конфигурационния файл не е налице, можете ръчно да генерира конфигурация във файл. Трябва да се извърши най-малко следните стъпки (например VirtualSerial):
Bookmark Wizard -> Проект:
- в "Стъпка 1: Посочете работната директория, от която Doxygen ще продължи", за да укажете пътя до директорията на проекта. В моя случай, това е C: \ aaa2 \ LUFA 100 807 \ Demos \ Device \ ClassDriver \ VirtualSerial \
- в "името на проекта:" въведете името на проекта (LUFA библиотека - Virtual Serial Demo Device).
- в "версия на проекта или идентификатор:" влиза работната версия (0.0.0).
- в "Първичен код директория:" влиза ./
- в полето "Destination директория:" влиза ./Documentation/
- Ако вашият проект съдържа подпапки с изходен код, отбележете "Scan рекурсивно".
Bookmark Wizard -> Mode:
- Изберете желания режим екстракция: -> Всички лица.
- Изберете език за програмиране за оптимизиране на резултатите за -> Оптимизиране за C или PHP изход
Bookmark Wizard -> Output (изберете този път формат RTF):
- кърлежи HTML
- кърлежи LaTeX
- задаване на проверка Rich Text Format (RTF)
Bookmark Wizard -> диаграми:
- Схеми за генериране -> Не диаграми
Изпълнете раздела:
- натиснете бутона Run Doxugen. Файлът резултат е един файл VirtualSerial \ Documentation \ RTF \ refman.rtf.
Можете да запишете получената конфигурационния файл за по-нататъшна употреба (File -> Save като -.> Doxyfile).
[Проблем правилната обработка на кодиране руски език]
# Преди това беше заявено, INPUT_ENCODING = UTF-8
INPUT_ENCODING = прозорци-1251
Също така, ако имате нужда от правилно да признае руски текст, който е в Doxygen.conf файл (например, може да е име на текст PROJECT_NAME проект и други линии), е необходимо да редактирате променлива DOXYFILE_ENCODING довереник (посочете прозорци-1251 кодиране):
# Преди това беше заявено, DOXYFILE_ENCODING = UTF-8
DOXYFILE_ENCODING = прозорци-1251
Ето как можете да поправите кодиране интерфейс GUI:
След като корекция HTML един ще бъде правилно генерира и показва правилно във всички браузъри, руски текст не е безсмислица.
[Излизане специални символи Doxygen]
За да се премахне вид предупреждение "името на файла: linenumber: предупреждение: изрично искане линк към" определи "не може да бъде решен", трябва да се използва наклонена черта "\" (наклонена черта), за да избягат специални символи. Така например, така че трябва да избягат от символа # с ключовата дума, се определят:
Някои Текст \ #define тук на текст
Това ще премахне искането за вид предупреждение към ". "Не може да бъде решен.