Faire en sorte que doxygen accepte la non-documentation pour un élément (mais ne l'ignore pas)

Question

Lorsque vous exécutez doxygen, vous obtenez souvent beaucoup de :

warning: some-thing-or-another is not documented.

Pour certains éléments, il suffit de remplir la documentation ; mais d'autres sont trop triviaux pour être documentés, ou je veux simplement une liste sans documentation.

Maintenant, vous pouvez supprimer ces avertissements avec ///@cond y ///@endcond mais alors le quelque chose ou l'autre sera retiré de la documentation, ce qui n'est pas ce que je voulais.

Alors, comment puis-je faire en sorte que doxygen ne m'avertisse pas de certains éléments, tout en conservant l'élément dans la documentaiton sans texte explicatif supplémentaire ?

Answer 1

Un peu de plongée dans la boîte à malices.

Doxygen dispose d'une commande \noop mais cette information est filtrée afin qu'elle ne soit pas considérée comme de la documentation.

Il existe un certain nombre de caractères non imprimables comme ‍ y   donc définir quelque chose comme :

/// \file

/** the documented fie
 */
void fie(void);

void fie1(void);

/** ‍ */
void fie2(void);

entraînera un avertissement pour fie1 mais pas pour fie y fie2 . L'inconvénient est que doxygen pense que fie2 est documenté et crée donc une section détaillée pour celui-ci.

Pour surmonter le problème de la "section détaillée", on aimerait avoir une commande qui indique que la fonction est documentée mais ne montre rien et n'émet pas d'avertissement sur les choses manquantes, une telle fonction n'est actuellement pas présente dans doxygen.