Doxygen을 문서 가능한 매개 변수는

Question

가 현재 내 C 코드 함수 선언이

/** Some fubar function 
*@param[in] val1 the first input variable 
*@param[in] val2 the second input variable 
*/ 
void foo (int val1, int val2); 

을 다음과 같이 기록하지만 0-500

가 할 수있는 유일한 예를 들어, 특정 범위 내에서 번호를 제외하고 매개 변수가 말을한다 값 매개 변수 설명의 일부가 아닌 다른 것을 문서화 할 수 있습니까? 어쩌면 제작 된 설명서에 별도로 표시 될 수 있습니까?

예. 라텍스에서 생성 된 pdf에서 매개 변수 유형 (int) 방향 (in)과 이름 (var1/var2)에 대한 셀이있는 테이블이 생성됩니다. 0-500의 다른 테이블 셀을 사용하는 방법이 있습니까?

Answer 1

가장 좋은 내기는 세부 구역의 테이블 일 수 있습니다. Doxygen은 문서 내에서 HTML 명령을 지원하며 PDF에서 생성 된 표는보기 흉하게 보입니다.

/** 
* @brief Some fubar function 
* @param[in] val1 the first input variable 
* @param[in] val2 the second input variable 
* 
* <TABLE> 
* <TR><TD>Type</TD><TD>Direction</TD><TD>Name</TD><TD>Value Range</TD></TR> 
* <TR><TD>int</TD><TD>in</TD><TD>val1</TD><TD>0-500</TD></TR> 
* <TR><TD>int</TD><TD>in</TD><TD>val2</TD><TD>1-1000</TD></TR> 
* </TABLE> 
*/ 
void foo(int val1, int val2) {} 

문제는 나에게 매우 과장된 것입니다. 아마도 테이블을 매개 변수 이름과 예상 값으로 제한하면 더 좋아 보일 것입니다.

doxygen에서 지원하는 HTML 세트는 Doxygen Manual: HTML Commands을 참조하십시오.