处理 doxygen 中的长链接

【问题标题】：Handling long links in doxygen处理 doxygen 中的长链接
【发布时间】：2013-01-15 03:31:45
【问题描述】：

给定一个带有长参数列表的函数声明，例如：

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

【问题讨论】：

标签： c doxygen long-parameter-list

【解决方案1】：

您不应该在链接中使用参数名称。假设 rtSetTime 不是重载函数，也不需要指定所有参数类型。

这里有多种链接到函数的方法，从最短到最长。最后两个也可以在函数重载的情况下使用。

/** @mainpage 
 *  - #rtSetTime 
 *  - @ref rtSetTime "rtSetTime"
 *  - @ref rtSetTime() "rtSetTime"
 *  - @link rtSetTime rtSetTime@endlink 
 *  - @link rtSetTime() rtSetTime@endlink
 *  - @ref rtSetTime(RTIME*,uint8,uint8,uint16,uint8,uint8,uint8) "rtSetTime"
 *  - @link rtSetTime(RTIME*,uint8,uint8,uint16,uint8,uint8,uint8) rtSetTime @endlink
 */

【讨论】：

太棒了 - 感谢您花时间描述如何正确使用 @link 命令。