डॉक्सिजन फ़ंक्शन पैरामीटर दस्तावेज़ (//! <बनाम @param)

Question

यदि मैं फ़ंक्शन पैरामीटर के लिए "सदस्य के बाद" दस्तावेज़ का उपयोग करता हूं, उदाहरण के लिए, प्रत्येक पैरामीटर के बाद //!< का उपयोग करें, हेडर में @param के बजाय, "पैरामीटर" खंड हमेशा जेनरेट आउटपुट फ़ाइल में "रिटर्न" के बाद रखा जाता है।

आदेश को परिभाषित करना संभव है ताकि "पैरामीटर्स" को "रिटर्न" से पहले रखा जा सके?

/** 
***************************************************************************************** 
* @brief  Test API 
* 
* @usage  This API can be called at any time 
* 
* @return  0 if successful; or 1 if failed 
****************************************************************************************/ 

int TestAPI(
    int argument1,  //!< first argument 
    int argument2  //!< second argument 
    ); 

Answer 1

मैं सिर्फ Doxygen 1.7.5.1 के साथ अपने कोड बाहर की कोशिश की है, और पुष्टि की है कि अपने कोड के साथ, उत्पादन में पैरामीटर सूची वापसी का वर्णन के बाद आता है।

यह एक शर्म की बात है के रूप में //!< शैली @param साथ राज्य फिर से सभी मापदंडों के नाम होने की तुलना में बहुत अच्छे है:

/** 
***************************************************************************************** 
* @brief  Test API 
* 
* @usage  This API can be called at any time 
* 
* @param  argument1 first argument 
* @param  argument2 second argument 
* 
* @return  0 if successful; or 1 if failed 
****************************************************************************************/ 

int TestAPI2(
    int argument1, 
    int argument2 
    ); 

मैं Doxygen Bugzilla bug database में एक नज़र था, यह देखने के लिए यह एक अपेक्षाकृत हालिया बग था (तब तक आप एक पुरानी स्थापना में वापस आज़मा सकते हैं)।

मुझे विश्वास है कि आपको Doxygen Bug 316311 मिला है: 'इनलाइन टिप्पणियों का उपयोग करके रिटर्न दस्तावेज के बाद पैरामीटर दस्तावेज', जिसे सितंबर 2005 में रिपोर्ट किया गया था, और तय नहीं किया गया है।

तो, दुख की बात है, मुझे आपके प्रश्न का उत्तर डर है आदेश को परिभाषित करना संभव है ताकि "पैरामीटर्स" को "रिटर्न" से पहले रखा जा सके? सं

संपादित

मैं सिर्फ Doxygen Bug 316311 के लिए एक नोट जोड़ने के बाद, के लिए पूछ स्थिति को बदलने की = पुष्ट लगभग निश्चित रूप से है।