Dans l'hypothèse que ce que vous avez quelque chose comme ceci: (La question est un peu clair à ce sujet)
/**
* Some documentation for class X
*/
class X: public osg::Drawable {
...
}
Et votre problème est que vous voulez inclure de la documentation pour la classe X, mais pas pour la classe osg::Drawable, la bonne technique est d'utiliser EXCLUDE_SYMBOLS. Par exemple, dans le cas ci-dessus l'utilisation
EXCLUDE_SYMBOLS = osg::Drawable
Si vous voulez être un peu plus rigoureux, vous pouvez utiliser
EXCLUDE_SYMBOLS = osg::Drawable \
Drawable
Wild-cards sont également autorisés, de sorte que ce sera également le travail
EXCLUDE_SYMBOLS = osg::*
Je suis en train de travailler avec le c#, et j'ai voulu exclure une catégorie "LogHandler". aucune combinaison n'a fonctionné pour moi. J'ai essayé le "LogHandler", "LogHandler", "Fullnamespace.LogHandler", "Fullnamespace::LogHandler" .. rien ne fonctionne! .. je suis d'abandonner et à l'aide d'un travail autour de l'exclusion des fichiers
Si \internal balise ne fonctionne pas, vous pouvez essayer de \cond ... \endcond étiquettes pour le marquage d'une portion de code doit être caché Doxygen.
MODIFIER
Si vous voulez exclure des fichiers spécifiques, vous pouvez utiliser EXCLUDE_PATTERNS variable dans Doxyfile fichier de configuration.
non, ce n'est pas mon problème. Mon problème est que mes fonctions utiliser QString, et doxygen essaie de trouver de la documentation à propos de QString. Comment puis-je empêcher de Doxygen pour documenter les classes "je n'ai pas explicitement écrit dans mon projet"
Ce n'est pas la meilleure façon mais on peut marquer une certaine partie de la documentation (de classe, membres, ...) avec la private. Cela empêche le morceau de code inclus dans la sortie de la documentation. (Je l'utilise pour cacher copier/déplacer des constructeurs/opérateurs figurant dans la documentation de l'API.)
/*!
* \brief This is included.
*/
class API
{
public:
/*!
* \brief So is this.
*/
API() noexcept;
///\private
~API() noexcept; /* But this not, though technically public. */
private:
int m_version; /* This is not either. */
}
Il convient de noter cependant que c'est un Doxygen extension pour PHP, qui, selon le la documentation ils ne doivent pas être utilisés.
Pour les fichiers PHP il y a un certain nombre de commandes supplémentaires, qui peuvent être utilisés à l'intérieur des classes pour les membres du public, du privé ou protégé, même si le langage lui-même n'a pas l'appui de cette notion.
L'autre option est l'utilisation de la solution mouviciel fournis, mais il nécessite au moins deux lignes.
Mais pas la bonne réponse pour la question détaillée, il peut être utile pour les lecteurs de la question du titre (comme moi). Il travaille pour la classe de trop!
Dans l'hypothèse que ce que vous avez quelque chose comme ceci: (La question est un peu clair à ce sujet)
Et votre problème est que vous voulez inclure de la documentation pour la classe
X, mais pas pour la classeosg::Drawable, la bonne technique est d'utiliserEXCLUDE_SYMBOLS. Par exemple, dans le cas ci-dessus l'utilisationSi vous voulez être un peu plus rigoureux, vous pouvez utiliser
Wild-cards sont également autorisés, de sorte que ce sera également le travail
OriginalL'auteur Ben Hocking
Si
\internalbalise ne fonctionne pas, vous pouvez essayer de\cond ... \endcondétiquettes pour le marquage d'une portion de code doit être caché Doxygen.MODIFIER
Si vous voulez exclure des fichiers spécifiques, vous pouvez utiliser
EXCLUDE_PATTERNSvariable dans Doxyfile fichier de configuration.OriginalL'auteur mouviciel
Ce n'est pas la meilleure façon mais on peut marquer une certaine partie de la documentation (de classe, membres, ...) avec la
private. Cela empêche le morceau de code inclus dans la sortie de la documentation. (Je l'utilise pour cacher copier/déplacer des constructeurs/opérateurs figurant dans la documentation de l'API.)Il convient de noter cependant que c'est un Doxygen extension pour PHP, qui, selon le la documentation ils ne doivent pas être utilisés.
L'autre option est l'utilisation de la solution mouviciel fournis, mais il nécessite au moins deux lignes.
Mais pas la bonne réponse pour la question détaillée, il peut être utile pour les lecteurs de la question du titre (comme moi). Il travaille pour la classe de trop!
OriginalL'auteur maxik