Doxygen dokumentáció generátor - gyors indítás, avr, programozás
Doxygen - népszerű dokumentáció generátor alapján az eredeti szövegek. Mi Doxygen, nagyon jól megírt Wikipedia, így a cikket, azt fogja mondani, csak arról, hogyan kell gyorsan beállítani és kezdi el használni Doxygen.
Így a folyamatot lépésről lépésre:
1. letöltése link [1], változatok állnak rendelkezésre a Linux i386, a Mac OS X 10.6 (Snow Leopard), Mac OS X 10.4 (Tiger), Windows XP / Vista / 7, valamint a forrás (Doxygen eloszlik a GPL alatt).
2. Run doxygen-1.7.2-setup.exe. Mi válaszolni egyszerű kérdésekre hagyományos telepítő (tompa arat Next). A telepítés után a mappát a C: \ Program Files \ doxygen \, ahol az egész rendszer Doxygen, a dokumentációt, és a közművek.
3. Run c: \ Program Files \ doxygen \ bin \ doxywizard.exe. Ez egy olyan program, amely lehetővé teszi, hogy egyszerűsítse a létrehozását és használatát egy konfigurációs fájl dokumentáció (Doxygen GUI frontend).
5. Most kell menni a fület, és kattintson Run Run doxygen gomb:
Ha összeállítása során dokumentációt a forrásszövegek hibák léphetnek fel, azok megjelennek a kimeneti mezőben „Output által termelt doxygen”. A jelentés megállapította, a sorszámok, ahol talált hibát. Sorszámok üzenetekben „címke nélkül illő” nem feltétlenül esik egybe a vonalakat, ahol ezek a hibák valóban.
Elindítása dokumentáció generálás is elvégezhető parancssorból paranccsal (config-file konfigurációs fájl doxygen):
Ha a konfigurációs fájl nem található, akkor manuálisan létrehoz egy fájl összeállításban. Be kell, hogy végezze el legalább az alábbi lépéseket (például VirtualSerial):
Könyvjelző Wizard -> Project:
- Az „1. lépés: Adja meg az aktuális könyvtárat, ahonnan doxygen fog futni”, hogy adja meg az utat, hogy a projekt könyvtárba. Az én esetemben ez a c: \ aaa2 \ LUFA 100 807 \ Demos \ Device \ ClassDriver \ VirtualSerial \
- A „Projekt neve:” adja meg a projekt nevét (LUFA Könyvtár - Virtual Serial Device Demo).
- A „Project változat vagy id:” adja meg a tervezet (0.0.0).
- A „Forráskód könyvtárban:” írja ./
- területén „célkönyvtára:” írja ./Documentation/
- Ha a projekt tartalmaz almappákat forráskód, kullancs „Scan rekurzívan”.
Könyvjelző Wizard -> Mode:
- Válassza ki a kívánt extrakciós mód: -> Minden entitások.
- Select programozási nyelv, hogy optimalizálja az eredményeket -> Optimalizálás C és PHP kimenet
Könyvjelző Wizard -> Output (válassza ezúttal RTF formátumban):
- kullancsok HTML
- kullancsok LaTeX
- meg egy csekket Rich Text Format (RTF)
Könyvjelző Wizard -> Rajzok:
- Diagramok létrehozására -> No diagramok
Fuss lap:
- menü Futtatás Doxugen gombra. Az eredmény fájl egyetlen fájl VirtualSerial \ Dokumentáció \ rtf \ refman.rtf.
Ön tudja menteni a kapott konfigurációs fájl későbbi felhasználásra (File -> Save as -.> Doxyfile).
[Probléma helyes feldolgozását kódoló orosz nyelv]
# Előtt, majd azt állította, INPUT_ENCODING = UTF-8
INPUT_ENCODING = windows-1251
Továbbá, ha kell, hogy megfelelően ismeri az orosz szöveget, amely Doxygen.conf fájlt (például, lehet, hogy egy szöveges nevet PROJECT_NAME projekt és egyéb tételek), szükséges, hogy módosítsa a config változó DOXYFILE_ENCODING (adja meg a windows-1251 kódolás):
# Előtt, majd azt állította, DOXYFILE_ENCODING = UTF-8
DOXYFILE_ENCODING = windows-1251
Ez hogyan lehet kijavítani kódoló a grafikus felhasználói felület:
Miután egy ilyen korrekció html megfelelőek lesznek létre, és helyesen jelenik meg minden böngészőben, az orosz szöveg nem halandzsa.
[Menekülő Különleges karakterek doxygen]
Hogy megszüntesse a figyelmeztető típus „fájlnév: linenumber: figyelmeztetés: explicit kapcsolat kérést»definíció«nem lehet megoldani” kell használni backslash „\” (backslash), hogy elkerülje a speciális karaktereket. Például, így meg kell, hogy elkerülje a # jelet a kulcsszó határozza meg:
Néhány szöveg \ #define itt szöveges
Ez megszünteti a figyelmeztető típusú kérés”. „Nem lehet megoldani.