Comment faire une page d'introduction avec Doxygen

Question

J'ai réalisé la documentation de mon SDK en utilisant Doxygen. Il contient la liste des fichiers, des espaces de noms, des classes, des types, etc. - tout ce que j'ai placé en tant que commentaires Doxygen dans le code. Maintenant, je veux écrire quelques informations générales sur le SDK (type d’introduction), qui ne sont pas directement liées à un élément de code. Je souhaite placer cette introduction sur la page d'accueil de la documentation. Comment puis-je faire ceci?

Answer 1

Jetez un oeil à l' mainpage commande.

Aussi, jetez un oeil cette réponse à un autre fil de discussion: Comment faire pour inclure des fichiers dans Doxygen. Il affirme qu'il y a trois extensions qui doxygen classes supplémentaires sur les fichiers de documentation: .dox, .txt et .doc. Les fichiers avec ces extensions n'apparaissent pas dans le fichier d'index, mais peut être utilisé pour inclure des informations supplémentaires dans votre documentation finale - très utile pour la documentation qui est nécessaire mais qui n'est pas vraiment approprié à inclure dans votre code source (par exemple, une FAQ)

Donc je vous conseille d'avoir un mainpage.dox (ou un nom similaire) fichier dans votre répertoire de projet à vous présenter SDK. Notez qu'à l'intérieur de ce fichier, vous devez mettre un ou plusieurs C/C++ style des blocs de commentaires.

Answer 2

A partir de la version 1.8.8, il existe également l'option USE_MDFILE_AS_MAINPAGE . Veillez donc à ajouter votre fichier d'index, par exemple README.md , à INPUT et à le définir comme valeur de cette option:

 INPUT += README.md
USE_MDFILE_AS_MAINPAGE = README.md
 

Answer 3

Notez qu'avec la version 1.8.0 de Doxygen, vous pouvez également ajouter des pages au format Markdown. Pour que cela fonctionne, vous devez créer des pages avec une extension .md ou .markdown et ajouter les éléments suivants au fichier config:

 INPUT += your_page.md
FILE_PATTERNS += *.md *.markdown
 

Voir http://www.doxygen.org/markdown.html#md_page_header pour plus de détails.

Answer 4

Ajouter n'importe quel fichier dans la documentation votre contenu, par exemple de table des matières.h

@ mainpage Manual SDK
<hr/>
@ section pageTOC Content
  -# @ref Description
  -# @ref License
  -# @ref Item
...

dans "doxyfile"

ENTRÉE = table des matières.h \

exemple de Manuel de la langue (russe)

http://www.scale-tech.ru/luckyBackupW/doc/html/index.html

http://www.scale-tech.ru/luckyBackupW/doc/html/toc_8h_source.html