Ik wil graag aangepaste (niet-project) bestanden toevoegen om wat extra pagina’s te genereren met Doxygen.
Ik ben (was eigenlijk) niet zeker hoe deze bestanden moeten heten en hoe hun inhoud moet worden opgemaakt.
Antwoord 1, autoriteit 100%
Ik heb behoorlijk wat gezocht voordat ik het antwoord vond, dus ik dacht dat het leuk zou zijn om het te delen!
Volgens dit Doxygen gotchasartikel heb ik eindelijk gevonden dat: jij moet u een bestand toevoegen met de extensie dox. De inhoud moet commentaarblokken in C-stijl bevatten:
/*!
\page My test page
contents
...
more contents
*/
Zorg ervoor dat uw aangepaste bestanden in een map worden geplaatst die is opgenomen in INPUTinstelling of in de huidige map als INPUT leeg wordt gelaten, zodat deze bestanden kunnen worden gevonden.
Antwoord 2, autoriteit 78%
Voor de volledigheid: er zijn 3 mogelijke extensies die doxygen behandelt als extra documentatiebestanden: .dox, .txt en .doc.
Bestanden met een dergelijke extensie worden verborgen in de bestandsindex. In het bestand moet je een of meer commentaarblokken in C/C++-stijl plaatsen.
Antwoord 3, autoriteit 30%
Voor nog meer volledigheid, te beginnen met Doxygen versie 1.8 (denk ik), ondersteunt het nu extra tekstbestanden die erg lijken op markdownsyntaxis. U hoeft niet langer commentaarblokken in C/C++-stijl te gebruiken. Schrijf in plaats daarvan gewoon bijnanormale tekst en zorg ervoor dat het tekstbestand zich in het INPUT-pad bevindt en dat uw doxygen-scan daadwerkelijk zoekt naar bestanden met de extensie .markdown (of een andere extensie die u kiest om te gebruiken, zoals .md).
Antwoord 4, autoriteit 20%
Voor de duidelijkheid:
Voeg in het .dox-configuratiebestand het bestand met iets toe aan de INPUT-richtlijn
zoals dit:
INPUT = ../src \
../include \
../docs/my-extra-file.txt
Als het bestand de juiste extensie had, bijvoorbeeld .h of .c, dan zou Doxygen het bestand vinden zonder toevoeging aan de INPUT-richtlijn. Gebruik in het bestand normale Doxygen-tags, zoals in de bron, d.w.z. in commentaarblokken, zoals:
/*! \mainpage MyProject - A Brief Description.
\image html Mylogo.png
\section my-intro MyProject Introduction
\htmlinclude about-MyProject.html
*/
Je kunt ook gewoon een van de include-tags gebruiken, zoals de “\htmlinclude” in het bovenstaande voorbeeld, waar dan ook in de code.
Antwoord 5, autoriteit 2%
Vermeld gewoon je aangepaste bestanden in de INPUT-macro in je doxyfile. U kunt elke naam kiezen die u geschikt vindt. Opmaak is tekst met Doxygen-tags.