Utilisez le fichier README.md comme page principale dans Doxygen
La documentation de Doxygen indique que je peux utiliser PHP Markdown Extra étiquetage de titre dans un fichier de démarque, mais ni
# Main Page # {#mainpage}
ni
# Main Page # {#index}
fonctionne, mais l'étiquette n'est pas présente dans la sortie en texte brut non plus. Il s'agit de la toute première ligne BTW.
Je ne peux pas non plus faire référence à cette page ni avec les étiquettes ci-dessus, ni avec le nom du fichier.
J'ai aussi un main.dox fichier contenant un \mainpage commande spéciale, mais j'ai également essayé tout ce qui précède en supprimant une barre oblique avant (pour n'en faire que deux).
J'utilise Doxygen 1.8.2 (téléchargé) et 1.8.1.1 (depuis MacPorts) pour la tâche.
Comment puis-je y parvenir alors?
De plus, comment puis-je marquer un fichier de démarque dans le cadre d'une langue spécifique?
EDIT: j'ai activé la prise en charge des démarques et le fichier apparaît dans les pages référencées.
Dans la prochaine version de doxygen (1.8.3), je prévois d'introduire une nouvelle option de configuration USE_MDFILE_AS_MAINPAGE qui peut être utilisé pour spécifier une page de démarque à utiliser comme page principale. Ensuite, vous pouvez configurer doxygen comme suit:
INPUT = README.md other_sources
USE_MDFILE_AS_MAINPAGE = README.md
et cela fonctionnera indépendamment des en-têtes de page.
Essayez plutôt de marquer le titre comme en-tête de niveau 1:
Main Page {#mainpage}
=========
Avec doxygen 1.8.2, cela fait de la page le index.html page pour moi.
Le document doxygen indique que le démarrage d'une ligne avec un seul # déclare un en-tête de niveau 1, mais il semble ne pas fonctionner pour moi non plus.