2010-03-11 19 views
10

Comment puis-je forcer Doxygen à afficher le chemin d'inclusion complet?Comment puis-je forcer Doxygen à afficher le chemin d'inclusion complet?

Qu'est-ce que je veux dire:

J'ai une classe foo::bar::bee définie dans bee.hpp dans la structure de répertoire suivant:

foo 
foo/bar 
foo/bar/bee.hpp 

Doxygen, quand il documente foo::bar::bee classe dit que vous devez inclure <bee.hpp>, mais pour mon logiciel j'ai besoin <foo/bar/bee.hpp>

Comment puis-je provoquer Doxygen pour faire cela? Y at-il une option pour fournir "Inclure les drapeaux" comme "-I" pour que doxygen sache où se trouve la base?

Notes:

  • FULL_PATH_NAMES est déjà défini par défaut YES
  • Je ne veux pas fournir incluent explicitement en-tête pour chaque classe, car il trop grand nombre d'entre eux. Je veux que Doxygen le fasse automatiquement.

Merci.

Réponse

Set:

STRIP_FROM_INC_PATH = relative/path/to/include/directory 

Répondre

12

prises directement à partir des conseils en DoxyWizard:

STRIP_FROM_INC_PATH

La balise STRIP_FROM_INC_PATH peut être utilisé pour enlever un user- partie définie du chemin mentionné dans la documenta tion d'une classe, qui indique au lecteur quel fichier d'en-tête inclure afin d'utiliser une classe. Si cette case est vide, seul le nom du fichier d'en-tête contenant la définition de classe est utilisé. Sinon, il faut spécifier les chemins d'inclusion qui sont normalement passés au compilateur en utilisant l'indicateur -I.

+0

Merci ... Je me sens stupide. J'ai lu cette partie de la documentation et je n'ai pas compris. – Artyom

+1

Eh bien, le nom de l'option suggère un comportement différent, alors ne vous battez pas :) –