Mida Doxygeniga ette võtta?
Järgneb loetelu sammudest, mida teha, et Doxygeniga sõbraks saada.
1) Genereeri Doxyfile. Variant A on 'doxygen -g Doxyfile'. Variant B on doxywizard. Palun pane faili nimeks Doxyfile, sest nii on tavaks. doxywizard on väga hea, sest laseb sul valida mitmeid kasulikke ja huvitavaid võimalusi, mis sinu dokumentatsiooni täielikumaks ja ilusamaks teevad. Samas pead pärast Doxyfile'i muutma, et ta ei sisaldaks absoluutseid teid (C:/minu/kodu/kaust/cpp/praks1).
PS: Doxyfile'is on ka mugav määrata, kuhu peaks genereeritav dokumentatsioon tekkima, näiteks docs kausta (abiks muutuja OUTPUT_DIRECTORY).
2) Loe Doxygeni juhendit. See on iseseisev töö. Head lingid on näiteks:
Eriti loe käske \brief, \param, \returns, \retval.
3) Dokumenteeri oma koodis päisefail (*.h) vastavalt doxygeni nõuetele.
4) Käivita doxygen. Kui Doxyfile'i nimi on Doxyfile, siis ei pea parameetreid andma doxygenile.
5) Vaata väljundis HTML kaustas index.html-i. Seal kuskil linkide taga peab olema dokumenteeritud funktsioonide loetelu koos väljatoodud parameetrite ja tagastatavate väärtustega. Ei piisa vabatekstist, tuleb kasutada punktis 2 loetletud käske.
6) Näidis, mida tasub vaadata (Javadoc style):
FAQ: Miks ei teki dokumentatsiooni, kui päisefailis on doxygeni kommentaarid olemas?
- Let's repeat that, because it is often overlooked: to document global objects (functions, typedefs, enum, macros, etc), you must document the file in which they are defined. In other words, there must at least be a
/*! \file */or a/** @file */line in this file.[1] - Kontrolli, et oled configuratsioonifailis (Doxyfile) öelnud, kust tuleks dokumentatsiooni otsida (näiteks kaustast include). Abiks muutuja INPUT.
- Let's repeat that, because it is often overlooked: to document global objects (functions, typedefs, enum, macros, etc), you must document the file in which they are defined. In other words, there must at least be a