Doxygen: (एएनएसआई-सी) एक समारोह सूचक प्रकार के मापदंडों का दस्तावेजीकरण

Question

मेरे कोड की तरह

/** 
* \brief Callback function type "foo" 
*/ 
typedef int (*foo)(int a, int b); 

कुछ समारोह सूचक प्रकार मैं समारोह तर्क के शब्दों दस्तावेज़ के लिए चाहते हैं की जरूरत है, लेकिन एक \param[in,out] के बगल में \brief कथन अतिरिक्त दस्तावेज जोड़ने के लिए प्रतीत नहीं होता है।

क्या फ़ंक्शन टाइप-डीफ़ में डॉक्सिजन जोड़ने पैरामीटर दस्तावेज़ प्राप्त करने का कोई तरीका है?

किसी भी मदद के लिए टीआईए!

Answer 1

यह आपके प्रश्न से स्पष्ट नहीं है कि आपने \ param को कब रखा था।

मेरे लिए निम्नलिखित काम करता है (Doxygen 1.8.6 का प्रयोग करके):

/** 
* \brief Callback function type "foo" 
* 
* A longer description of foo. 
* \param a Description for a 
* \param b Description for b 
* \return Description for return value 
*/ 
typedef int (*foo)(int a, int b); 

उत्पादन में, यह संक्षिप्त और विस्तृत वर्णन, पैरामीटर ए और बी के साथ एक Parameters अनुभाग, और के साथ एक Returns खंड बनाता है वापसी मूल्य का विवरण।

एंडी