Doxygen을 : 함수 포인터 유형의 매개 변수를 문서화 (ANSI-C)는

Question

내 코드는 내가 함수 인수의 의미를 문서화하고 싶은

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

같은 일부 함수 포인터 유형을 필요로하지만 옆에 \param[in,out]에 \brief 문은 추가 문서를 추가하지 않는 것 같습니다.

doxygen을 매개 변수 문서를 function-type-defs에 추가하는 방법이 있습니까?

TIA 어떤 도움이 필요하십니까?

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); 

를,이 짧고 긴 설명, 변수 a 및 b와 Parameters 부 및 Returns 섹션을 만들어 반환 값의 설명.

앤디