documentazione parametro funzione doxygen (//! <Vs @param)

Question

Se utilizzo la documentazione "after the member" per i parametri di funzione, ad esempio, utilizzare //!< dopo ogni parametro, anziché @param nell'intestazione, i "Parameters" la sezione viene sempre posizionata dopo "Return" nel file di output generato.

È possibile definire l'ordine in modo che "Parametri" sia posizionato prima di "Ritorno"?

/** 
***************************************************************************************** 
* @brief  Test API 
* 
* @usage  This API can be called at any time 
* 
* @return  0 if successful; or 1 if failed 
****************************************************************************************/ 

int TestAPI(
    int argument1,  //!< first argument 
    int argument2  //!< second argument 
    ); 

Answer 1

Ho appena provato il vostro codice con Doxygen 1.7.5.1, e ha confermato che con il codice, l'elenco dei parametri in uscita arriva dopo la descrizione del Ritorno.

Questo è un peccato, perché lo stile //!< è molto più bello di dover ri-stato i nomi di tutti i parametri con @param:

/** 
***************************************************************************************** 
* @brief  Test API 
* 
* @usage  This API can be called at any time 
* 
* @param  argument1 first argument 
* @param  argument2 second argument 
* 
* @return  0 if successful; or 1 if failed 
****************************************************************************************/ 

int TestAPI2(
    int argument1, 
    int argument2 
    ); 

ho dato un'occhiata in Doxygen Bugzilla bug database, per vedere se era un bug relativamente recente (come allora si potrebbe provare a tornare a un'installazione precedente).

Credo che tu abbia trovato Doxygen Bug 316311: "documentazione dei parametri dopo la documentazione di ritorno utilizzando i commenti in linea", che è stato segnalato nel settembre 2005 e non è stato corretto.

Quindi, purtroppo, ho paura della risposta alla tua domanda È possibile definire l'ordine in modo che i "Parametri" saranno posizionati prima di "Ritorno"? è quasi certamente No.

Modifica

Ho appena aggiunto una nota a Doxygen Bug 316311 chiedendo di essere cambiato a Stato = CONFERMATO.