Y a-t-il un moyen d'avoir Doxygene montrer la documentation pour des fonctions privées individuelles? Je veux que Doxygen ne montre pas la documentation de la grande majorité des fonctions privées, mais le montrer à une sélection de quelques fonctions privées. Ma motivation est que ces fonctions privées c ++ sont fournies à Python en tant qu'extualités et que je souhaite que leur documentation apparaisse à Doxygen. Cependant, je ne veux pas qu'ils soient publics car ils ne sont nécessaires que par les classes eux-mêmes; ils appartiennent certainement au secteur privé.
merci
3 Réponses :
Il y a quelques façons d'y parvenir.
Vous pouvez simplement ne pas documenter ces fonctions que vous ne voulez pas visibles. Par défaut, Doxygen ne montrera aucun membre que vous n'avez pas documenté. Ainsi, vous pouvez simplement le dire de montrer des privés et de tout député privé non documenté ne sera pas affiché.
Ce serait certainement faire, mais de nombreuses fonctions privées ont déjà une documentation Doxygene et je ne vais pas les désaguer.
La section entre \ Cond et \ endcond Les commandes peuvent être incluses en ajoutant son étiquette de section à l'option de configuration Enabled_Sections. Si l'étiquette de section est omise, la section sera exclue du traitement de manière inconditionnelle. voir ne pas voir Cond1 Sections: Il suffit de ne pas l'ajouter à l'option Configuration de l'activation_sections.
Pour les champs privés, cela ne fonctionne que si Extract_private est activé.
Je définit ce qui suit dans le fichier de configuration: Ceci a l'effet souhaité, mais affichera toujours la documentation de tous les membres privés documentés. I Utilisez ensuite En outre, je peux toujours documenter les membres privés avec un commentaire normal C ++. c'est à dire. n'utilisez pas Enfin, si je veux vraiment montrer à toutes ces documents privés, je peux définir: pour créer une version plus vaste de la documentation. @Internal comme première ligne de la documentation des membres privés que je ne veux pas montrer. / ** ... * / Utilisez / * ... * / .
Habituellement, j'utilise un commentaire normal pour les variables des membres.
Voir ce Stackoverflow.com/questions / 562763 / ...
Cela ne répond pas à ma question. Cela détermine comment activer ou désactiver toutes les fonctions privées, ce qui n'est pas ce que je voulais faire. J'espère une sorte de conditionnel. J'ai essayé de transformer des documents privés et de permettre aux documents internes, mais cela n'a pas fonctionné.
Voir ma réponse sur les conditionnels. Cela ne nécessite que quelques modifications par classe.
Nudge Avez-vous déjà eu quelque part avec cela?