मुझे डॉक्सीजन के साथ टाइपिफ़ को वर्गीकृत कैसे करना चाहिए?

Question

मेरे पास मेरे सी ++ कोड में टाइपपीफ structs हैं। अभी के रूप में वे \var टाइपपीफ के रूप में सूचीबद्ध हैं। क्या ऐसा करने के लिए इससे अच्छा तरीका है?

/*! \var typedef etc 
* \brief A type defined structure for etc 
* 
* \param x type- Variable declaration for x 
* \param y type- Variable declaration for y 
*/ 

मैं जानता हूँ कि मैं भी param यह नहीं कह जाना चाहिए: नीचे मैं क्या है के उदाहरण है। उपयोग करने के लिए और क्या है?

Answer 1

Doxygen documentation के अनुसार \typedef कमांड है। आदेश \var कमांड जैसा ही व्यवहार करता है।

Answer 2

यदि आप टाइपपीफ के सामने टिप्पणी ब्लॉक डालते हैं तो आपको किसी विशेष कमांड का उपयोग करने की आवश्यकता नहीं है।

/** This is the documentation for the following typedef */ 
typedef MyClass MyTypedef; 

आप के बाद यह डाल करने के लिए निम्नलिखित का उपयोग typedef पसंद करते हैं:

typedef MyClass MyTypedef; 
/**< This is the documentation for the preceding typedef */ 

केवल जब टिप्पणी ब्लॉक वास्तविक typedef तुलना में एक अलग स्थान पर होना चाहिए, आप \ typedef का उपयोग करने की जरूरत है।