Esiste un modo per impedire a Doxygen di inviare avvisi "non documentati" su determinati file? Il mio progetto ha diverse intestazioni di codice generate automaticamente che causano centinaia o migliaia di errori che rendono difficile il setacciamento.Soppressione degli avvertimenti Doxygen
Si potrebbe utilizzare i tag di soppressione nei file generati:
//! @cond Doxygen_Suppress
code
//! @endcond
Non è necessario il "Doxygen_Suppress" in là, ma mi piace per chiarezza.
Non ci sono più opzioni in doxygen FAQ
EDIT: Ok, avrei fatto la mia diligenza, ho una risposta che è più appropriato alla situazione. Credo che sia necessario escludere completamente i file. Aggiungere questo al file doxygen:
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
EXCLUDE = abc.cpp \
abc.h
L'ironia è che ho avuto questo problema e risolto, poi dimenticato tutto su di esso ... cervello deve essere di nuovo pieno.
Ho estratto queste informazioni dallo doxygen Configuration page, ma se siete pigri come me, usate semplicemente lo strumento gui (doxywizard) e passate attraverso e selezionate tutte le cose che volete e salvate il doxyfile per voi.
C'è un'opzione di configurazione per questo, come dichiarato nella documentation
WARN_IF_UNDOCUMENTEDSe
WARN_IF_UNDOCUMENTEDè impostato suYES, allora doxygen genererà avvertenze per i membri senza documenti. SeEXTRACT_ALLè impostato suYES, questo flag sarà automaticamente disattivato.
Posso dargli qualche tipo di oscilloscopio in modo che avvisi i miei file e ignori gli altri? –
Hmmm .. non sembra possibile. È possibile escludere interamente i file, ma non per sopprimere selettivamente gli avvisi ... :( – Mchl
Sebbene questo collegamento possa rispondere alla domanda, è meglio includere qui le parti essenziali della risposta e fornire il collegamento per riferimento. può diventare non valido se la pagina collegata cambia. –
Nelle intestazioni generate automaticamente aggiungo semplicemente la documentazione doxygen nella routine di generazione automatica.
Ciò significa che non viene lasciato nulla di non documentato.
Se qualcuno utilizza Eclipse, consiglio vivamente di aprire il file (* .doxyfile) con un editor di testo (notare che eclipse lo apre con "Doxyfile Editor" per impostazione predefinita).
Quindi:
l'aggiunta di tag
//! @cond Doxygen_Suppress
code
//! @endcond
se si dispone di molte classi dovrebbero essere noioso e difficile.
La documentazione per le altre opzioni di configurazione è disponibile here.
I file generati vengono spazzati via e ricreati ogni volta che apporto qualsiasi modifica alle impostazioni del progetto. Lo strumento mi permette di inserire commenti nei file generati, ma sono tutti in un blocco, anche se sembrano aperti comunque i peggiori trasgressori (un'intestazione di mappa IO che elenca * ogni singolo registro e campo di bit del processore *) non riesco a farlo con. –
I tag aperti sembra che interferisca con la documentazione del mio codice a prima vista; '# definisce' in particolare, ma principalmente la documentazione nelle intestazioni. –