Poiché sembra un'attività così comune, è difficile per me credere che se voglio aggiungere tutti i commenti doxygen in un file di intestazione a un gruppo, che devo fareAggiunta di tutto il contenuto dell'intestazione a un gruppo Doxygen
foo.h
/**
*\addtogroup fooGroup
* @{
*/
...
...
...
/**@}*/
C'è un modo per farlo funzionare senza il @ {commento?
La risposta breve è no. Un'alternativa sta utilizzando il comando @ingroup. Se si mette il comando proprio sotto il comando @file, poi si aggiunge il riferimento al file al gruppo, ad esempio:
foo.h:
/**
* @file foo.h
* @ingroup fooGroup
*/
...
Questo richiede anche che è stato definito un gruppo con quel nome (potrebbe essere anche in un file diverso):
/**
* @defgroup fooGroup Foo
* @brief A brief description of the Foo component.
* @details A more detailed description of the Foo component.
*/
ma il grande svantaggio è che dovete mettere il comando @ingroup per ogni entità che si desidera visualizzare nella documentazione del gruppo. Ciò significa che devi aggiungere il comando a ogni dichiarazione o definizione, come enumerazioni, strutture, variabili e funzioni.
L'utilizzo dei comandi @addtogroup e @{ ... @} ha il grande vantaggio che non è necessario aggiungere ciascuna entitity al gruppo utilizzando il comando @ingroup.
Il senso dei gruppi è raccogliere la documentazione da diversi file con un nome specifico. È anche possibile dividere un file in diversi gruppi, quindi i commenti @ {e @} definiscono l'inizio e la fine di una regione che deve essere aggiunta al nome di un gruppo. Un'altra ragione è che i gruppi possono creare gerarchie, ad es. un file con il seguente codice:
/**
* @addtogroup group_name
* @{
*/
<Code Example 1>
/**
* @}
*/
/**
* @addtogroup group_name_2
* @{
*/
<Code Example 2>
/**
* @addtogroup sub_group_name
* @{
*/
<Code Example 3>
/**
* @addtogroup sub_sub_group_name
* @{
*/
<Code Example 4>
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/
Questo comporterebbe la seguente gerarchia gruppo:
L'unica cosa che si potrebbe provare è quello di aggiungere un alias per il \ AggiungiAlGruppo e il comando {, come:
ALIAS += "begingroup{1} = \addtogroup \1 \{"
Ma in questo caso si avrebbe ancora da aggiungere la @ } comando alla fine del file.