में जोड़ना क्योंकि यह एक आम काम लगता है, मेरे लिए यह विश्वास करना मुश्किल है कि यदि मैं एक समूह में हेडर फ़ाइल में सभी डॉक्सिजन टिप्पणियां जोड़ना चाहता हूं, तो मुझे करना हैसंपूर्ण हेडर सामग्री को एक डॉक्सिजन समूह
foo.h
/**
*\addtogroup fooGroup
* @{
*/
...
...
...
/**@}*/
क्या यह काम @ {टिप्पणी के बिना करने का कोई तरीका है?
संक्षिप्त उत्तर नहीं है। एक विकल्प @ingroup कमांड का उपयोग कर रहा है। आप सही @file आदेश नीचे है कि आदेश डाल, तो फ़ाइल संदर्भ समूह में जोड़ा जाता है, जैसे:
foo.h:
/**
* @file foo.h
* @ingroup fooGroup
*/
...
यह भी जरूरी है कि आप (उस नाम का कोई समूह को परिभाषित किया है एक अलग फाइल में भी हो सकता है):
/**
* @defgroup fooGroup Foo
* @brief A brief description of the Foo component.
* @details A more detailed description of the Foo component.
*/
लेकिन बड़ा नुकसान यह है कि आप प्रत्येक इकाई को समूह दस्तावेज में प्रदर्शित करना चाहते हैं के लिए @ingroup आदेश डाल करने के लिए होता है। इसका मतलब है कि आपको प्रत्येक घोषणा या परिभाषा, जैसे enums, structs, variables और कार्यों में कमांड जोड़ना होगा।
@addtogroup और @{ ... @} कमांड का उपयोग करने का बड़ा लाभ है कि आपको @ingroup कमांड का उपयोग करके समूह में प्रत्येक योग्यता जोड़ने की आवश्यकता नहीं है।
समूहों की भावना एक विशिष्ट नाम के तहत विभिन्न फ़ाइलों से दस्तावेज एकत्र करना है। आप एक फ़ाइल को विभिन्न समूहों में भी विभाजित कर सकते हैं, इसलिए @ {और @} टिप्पणियां शुरुआत और उस क्षेत्र के अंत को परिभाषित कर रही हैं जिसे समूह नाम में जोड़ा जाएगा। एक और कारण यह है कि समूह पदानुक्रम बना सकते हैं, उदा। निम्नलिखित कोड के साथ एक फ़ाइल:
/**
* @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>
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/
यह निम्न समूह पदानुक्रम में परिणाम होगा:
केवल एक चीज आप कोशिश कर सकते हैं \ addtogroup और {आदेश, जैसे के लिए एक अन्य नाम जोड़ने के लिए है:
ALIAS += "begingroup{1} = \addtogroup \1 \{"
लेकिन इस मामले में आप अभी भी जोड़ना होगा @ } फ़ाइल के अंत में कमांड।