Formålet med denne opgave er at sætte dig i gang med at bruge Doxygen til dokumentation af C programmer. Der findes også en video, som supplerer denne opgave.
Først skal du downloade Doxygen og installere programmet.
Hvis du ønsker diagrammer skal du også downloade Graphviz pakken, og installere denne.
Skriv nu et C program med dokumentationskommentarer, ligesom vist på rodsøgningsprogrammet. Start derefter Doxywizard, som giver dig mulighed for at sætte din dokumentation op.
Der er en række forhold, som du skal være opmærksom på:
- Under 'Step 1' skal du udnævne et katalog, hvor den såkaldte DoxyFile (med alle Doxygen's opsætningsparametre) gemmes.
- Under 'Step 2' Projekt skal du udpege kataloget med C kildefilen og kataloget, hvori dokumentationen skal skrives
- 'Step 2' Mode vælg All Entities som extraction mode og optimize for C.
- 'Step 2' Diagram vælg Use dot tool from GraphViz hvis du ønsker avancerede diagrammer. Check Call graphs og Called by graphs, og uncheck de andre (i det mindste som en start).
- I expert tabben er der et væld af options, hvor nogle allerede er sat op via de forrige punkter. For at få Doxygen og Graphviz til at arbejde sammen, bør du under Dot > Dot_Path udpege bin kataloget i din Graphviz installation.
- Gem nu dit doxygen setup med File > Save. (Dette indebærer dannelsen af en såkaldt DoxyFile)
- I Run tabben, aktiver Run doxygen knappen for at generere dokumentationen. Hold øje med evt. fejlmeddelelser i det store felt.
Doxygen er et meget rigt værktøj. Leg gerne med de mange muligheder for at tune dokumentationen til dine behov.
