2011-10-17 2 views
13

함수 매개 변수에 대한 "멤버"문서를 사용하는 경우 예를 들어 머리글에 @param 대신 각 매개 변수 뒤에 //!<을 사용하면 "Parameters" 섹션은 항상 생성 된 출력 파일에서 "Return"다음에 배치됩니다.doxygen 함수 매개 변수 설명서 (//! <vs @param)

"Return"앞에 "Parameters"가 오도록 순서를 정의 할 수 있습니까?

/** 
***************************************************************************************** 
* @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 
    ); 
+0

"회원 이후"문서는 어디에 문서화되어 있습니까? – To1ne

+0

+1, 정확히 내가 무엇을 찾고 있었는지, // 방향을 나타낼 수도 있습니다!

답변

15

난 그냥 Doxygen을 1.7.5.1 사용하여 코드를 시도하고, 당신의 코드로, 출력의 매개 변수 목록이 반환의 설명 뒤에 오는 것을 확인했습니다. //!< 스타일 @param 모든 매개 변수의 이름을 상태를 다시 것보다 훨씬 좋네요으로

은 수치입니다 : 내가 있는지 확인하려면 Doxygen Bugzilla bug database에보고했다

/** 
***************************************************************************************** 
* @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 Bug 316311 : 2005 년 9 월에보고 된 '인라인 주석을 사용하여 반환 문서화 후 매개 변수 문서화'가 발견되어 고쳐지지 않았다고 생각합니다.

슬프게도 질문에 대한 대답이 두렵습니다. "반환"전에 "매개 변수"가 배치되도록 순서를 정의 할 수 있습니까?는 제

편집

난 그냥 요구, Doxygen Bug 316311에 메모를 추가했습니다 확정 = 상태로 변경하는 거의 확실하다.

+1

이 답변은 가장 확실하게 받아 들여진다. – Michael

관련 문제