So che è possibile utilizzare il markdown nei commenti e doxygen può capirlo. Ma ho bisogno di sapere se è possibile generare la documentazione in formato markdown?Genera documentazione come file di markdown usando doxygen
Ho bisogno che questa documentazione sia generata dai file C++.
So che questa domanda è vecchio ma sembra che ci sia un nuovo strumento a disposizione: https://www.npmjs.com/package/doxygen2md
Grazie. Questo sembra un buon modo per risolvere il problema che stavo avendo. – Sudar
Non so nulla che lo faccia direttamente, ma Doxygen ha la capacità di emettere un XML document using the XML generator.
Esistono vari progetti che possono quindi utilizzare i dati XML per trasformarli, uno dei più semplici di cui sono a conoscenza è Breathe che viene utilizzato per convertire i documenti XML in qualcosa che Sphinx può utilizzare per l'output della documentazione usando Doxygen come pre-processore, per così dire.
Il codice per Breathe può essere abbastanza semplice da utilizzare come punto di partenza per generare file Markdown invece dei file ReStructuredText richiesti da Sphinx. Non ho guardato il codice di Breathe, ma l'ho usato per alcuni progetti importanti.
Breathe inserisce il contenuto direttamente nella struttura ad albero Sphinx/docutils mentre vengono analizzati i file Sfinge. I file di ReStructuredText intermedi non vengono mai creati nel processo. –
Genera XML con DOxygen http://www.stack.nl/~dimitri/doxygen/customize.html#xmlgenerator.
Utilizzare PanDoc http://pandoc.org/ per convertire XML in Markdown.
Questa è una risposta fasulla, "XML" è un formato molto generico e pandoc non ha supporto per l'output XML di doxygen. –
Credo che utilizzando l'output XML grezzo probabilmente si può scrivere il proprio modulo di conversione Markdown. Ma sono abbastanza sicuro (anche se non al 100%), l'output di markdown diretto non è ancora possibile. –