Böylesine yaygın bir görev göründüğünden, bir kafa dosyasına tüm doxygen yorumlarını bir gruba eklemek istersem, bunu yapmak benim için zorTüm üstbilgi içeriğini bir Doxygen grubuna eklemek
foo.h
/**
*\addtogroup fooGroup
* @{
*/
...
...
...
/**@}*/
Bu işi @ {comment?
Kısa cevap no. Bir alternatif @ingroup komutunu kullanıyor.
foo.h:
/**
* @file foo.h
* @ingroup fooGroup
*/
...
Bu aynı zamanda (bu adla bir grup tanımladığınız farklı bir dosyada da olabilir gerektirir: Eğer doğru @file komutu altında bu komutu koyarsanız, ardından dosya referansı örneğin grubuna eklenir):
/**
* @defgroup fooGroup Foo
* @brief A brief description of the Foo component.
* @details A more detailed description of the Foo component.
*/
ANCAK büyük dezavantajı sen grubu belgelerinde görüntülemek istediğiniz her varlık için @ingroup komutu koymak zorunda olmasıdır. Bu, komutu, enumlar, yapılar, değişkenler ve işlevler gibi her bir bildirime veya tanıma eklemeniz gerektiği anlamına gelir.
@addtogroup ve @{ ... @} komutlarını kullanarak, büyük bir avantajı, @ingroup komutunu kullanarak gruba her bir varlığı eklemeniz gerekmez.
Grupların anlamı, belirli bir ad altında farklı dosyalardan belge toplamaktır. Ayrıca, bir dosyayı farklı gruplara bölebilirsiniz, böylece @ {ve @} yorumları bir grubun ismine eklenecek bir bölgenin başlangıcını ve sonunu tanımlar. Diğer bir neden de, grupların hiyerarşileri oluşturabilmeleridir, örn. Aşağıdaki kod ile bir dosya:
/**
* @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>
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/
Bu aşağıdaki grup hiyerarşisi neden olacaktır:
Deneyebileceğiniz tek şey gibi \ addtogroup ve {komutu için bir takma adı eklemektir:
ALIAS += "begingroup{1} = \addtogroup \1 \{"
Ancak bu durumda hala eklemek gerekir @ } Dosyanın sonunda komut.