Comment puis-je créer un fichier qui ne documente que les API "publiques" dans Doxygen?

Question

J'ai un projet sur lequel je travaille, qui est une bibliothèque . J'ai besoin de documenter les codes internes du code de la bibliothèque à mes propres fins, mais j'ai également besoin de fournir un document API à mes utilisateurs sur la façon dont ils devraient utiliser la bibliothèque.

Ainsi, dans le document que je veux leur donner, je veux inclure uniquement les fonctions « publiques », des structures, des variables, etc - et non les internes .

Y a-t-il un moyen de le faire dans Doxygen? Puis-je délimiter ce qui est «public» et ce qui est «privé»? Puis-je générer un document qui ne contient que l'API "public" pour mes utilisateurs, et un autre avec les détails de conception "privés" pour mon propre usage?

NOTE: Ceci est directement C, pas C++ - et mon utilisation des termes «public» et «privé» n'a rien à voir avec les membres de classe «public» et «privé».

Answer 1

En fonction de vos besoins, il y a plusieurs façons de le faire:

• Vous pouvez utiliser la balise \internal
• Vous pouvez utiliser la balise \private avec EXTRACT_PRIVATE=NO dans Doxyfile
• et probablement d'autres impliquant l'une des variables de configuration EXTRACT_.