Sopprime specifici avvertimenti Doxygen

Question

Sembra che altri abbiano già fatto questa domanda prima. Volevo solo controllare e vedere se fosse stata trovata una risposta.

Ho diverse occorrenze della seguente situazione: mentre sto documentando varie funzioni, a volte mi imbatto nella situazione in cui desidero documentare alcuni parametri di funzione ma non altri. Ad esempio,

/** 
* This is the brief description for the function. 
* And here is the detailed description. 
* @param foo This parameter is not self-explanatory and needs a blurb 
*/ 
void some_function(void *foo, int self_explanatory) { 
    // function does stuff 
} 

Aggiungendo il parametro self_explanatory alla documentazione Doxygen appena aggiunge l'ingombro, quindi preferirei lasciarlo fuori. Tuttavia, Doxygen avverte che il parametro non è documentato. Sto usando Eclox, ed è fastidioso avere un sacco di avvertimenti che non mi interessa.

In questo momento, il mio doxyfile ha le seguenti opzioni impostate:

EXTRACT_ALL   = YES 
WARNINGS    = YES 
WARN_IF_UNDOCUMENTED = NO 
WARN_IF_DOC_ERROR = YES 
WARN_NO_PARAM_DOC = NO 

Gli avvisi sono ancora generati.

Un'opzione è aggiungere @cond e @endcond che circonda il codice che causa l'errore, ma in seguito non viene generata alcuna documentazione per le mie funzioni. Voglio la documentazione, solo non gli avvertimenti.

Quello che sto cercando è qualcosa di simile ...

/** @nowarn 
* This is the brief description for the function. 
* And here is the detailed description. 
* @param foo This parameter is not self-explanatory and needs a blurb 
* @endnowarn 
*/ 
void some_function(void *foo, int self_explanatory) { 
    // function does stuff 
} 

... in modo che gli avvertimenti non vengono generati nel blocco di codice allegato.

Altre domande in modo che ho trovato:
Suppressing Doxygen warnings
Suppress doxygen warning for undocumented member function, but leave synopsis in place
Is it possible to choose which Doxygen warning to show?

Answer 1

Proprio documentano il parametro self_explanatory, o tenere a mente che gli avvertimenti sono solo quello: avvertimenti. Tutto ciò che Doxygen sta dicendo è che c'è qualcosa che potresti aver trascurato.

È possibile prendere l'avviso o semplicemente ignorarlo. Se vuoi davvero sopprimere questo avviso, potresti voler cercare nel primo thread che hai collegato. Nello specifico, https://stackoverflow.com/a/25137529/3121160.