Doxygen - dichiarare parametro come facoltativo

Question

Sto documentando un codice base utilizzando Doxygen e mi chiedevo se esiste una parola chiave per dichiarare un argomento come funzione facoltativo. Qualcosa di simile:

/*! 
\fn int add(int a, int b=0) 
\brief adds two values 
\param a the first operand 
\param \optional b the second operand. Default is 0 
\return the result 
*/ 

Sembra che questo sia qualcosa che dovrebbe esistere, ma non sono stato in grado di trovarlo da nessuna parte. Esiste un'opzione effettiva o devo solo prendere nota nella descrizione?

Answer 1

Per rispondere alla tua domanda: No, non esiste una cosa del genere.

Ma io non condivido la tua opinione che ci dovrebbe essere qualcosa del genere. Dopo tutto, la dichiarazione della funzione verrà visualizzata insieme alla relativa documentazione, in modo che tutti possano vedere che b è facoltativo e quale è l'argomento predefinito. E per il \fn vedere la documentazione di doxygen discouraging the use of \fn.

Answer 2

Quello che vuoi non è fornito da Doxygen - dovrai prenderne nota manualmente nella descrizione.