2010-03-11 8 views
10

Come posso forzare Doxygen a mostrare il percorso completo di inclusione?Come posso forzare Doxygen a mostrare il percorso completo di inclusione?

Cosa voglio dire:

Ho una classe foo::bar::bee definito bee.hpp nella seguente struttura di directory:

foo 
foo/bar 
foo/bar/bee.hpp 

Doxygen, quando si documenta foo::bar::bee classe dice che è necessario includere <bee.hpp>, ma per il mio software mi serve <foo/bar/bee.hpp>

Come posso fare a Doxygen? C'è qualche opzione per fornire "Include flags" come "-I" così doxygen saprebbe dove si trova la base?

Note:

  • FULL_PATH_NAMES è già impostato di default YES
  • Non voglio fornire comprendono intestazione in modo esplicito per ogni classe, perché ci troppi di loro. Voglio che Doxygen lo faccia automaticamente.

Grazie.

risposta

Set:

STRIP_FROM_INC_PATH = relative/path/to/include/directory 

risposta

12

tratte direttamente dai suggerimenti in doxywizard:

STRIP_FROM_INC_PATH

Il tag STRIP_FROM_INC_PATH può essere utilizzato per mettere a nudo un dall'utente parte definita del percorso menzionato nel documenta zione di una classe, che indica al lettore quale file di intestazione includere per poter utilizzare una classe. Se lasciato vuoto, viene utilizzato solo il nome del file di intestazione contenente la definizione di classe. Altrimenti si dovrebbero specificare i percorsi di inclusione che normalmente vengono passati al compilatore usando il flag -I.

+0

Grazie ... mi sento stupido. Ho letto questa parte della documentazione e non l'ho capita. – Artyom

+1

Bene, il nome dell'opzione suggerisce un comportamento diverso, quindi non abbatterti :) –

Problemi correlati