2013-01-15 17 views
1

長鏈接給出一個函數聲明用長參數列表,如:處理在doxygen的

uint8 rtSetTime(RTIME *rtime, uint8 day, uint8 month, uint16 year, 
    uint8 hour, uint8 minute, uint8 second); 

是有辦法拆分到多個行參數列表這樣的doxygen將仍然正確解析@link命令?目前我只能得到它的工作,如果函數的聲明是單行線,即:

@link rtSetTime(RTIME *rtime, uint8 day, uint8 month, uint16 year, uint8 hour, uint8 minute, uint8 second) rtSetTime @endlink 

回答

2

中的鏈接,您不應該使用的參數名稱。 假設rtSetTime不是重載函數,也不需要指定所有參數類型。

這裏有很多方法可以鏈接到從最短到最長的功能。最後兩個也起作用,以防函數過載。

/** @mainpage 
* - #rtSetTime 
* - @ref rtSetTime "rtSetTime" 
* - @ref rtSetTime() "rtSetTime" 
* - @link rtSetTime [email protected] 
* - @link rtSetTime() [email protected] 
* - @ref rtSetTime(RTIME*,uint8,uint8,uint16,uint8,uint8,uint8) "rtSetTime" 
* - @link rtSetTime(RTIME*,uint8,uint8,uint16,uint8,uint8,uint8) rtSetTime @endlink 
*/ 
+0

非常棒 - 感謝您花時間描述如何正確使用'@ link'命令。 – RBE