Doxygen函数自动链接问题:C头文件函数引用无法自动链接
解决Doxygen列表中函数引用无法生成链接的问题
这个问题我之前在使用Doxygen的时候也碰到过,默认情况下Doxygen不会自动把列表里手写的函数声明识别为可跳转的链接,得用它提供的专门引用语法来处理,给你几种可行的解决办法:
使用
\ref命令(推荐)
这是最直接的方式,你可以通过\ref指定函数名,还能自定义显示的文本。如果想显示完整的函数签名,写法如下:/** 为简化此类操作,我实现了: * @li \ref foo "int foo( int v1, int v2, char *s1, char *s2)" * * 该函数可用于…… */要是觉得写完整签名太繁琐,也可以直接引用函数名,Doxygen会自动帮你补全函数声明并生成链接:
/** 为简化此类操作,我实现了: * @li \ref foo * * 该函数可用于…… */使用
\link和\endlink包裹
这种方式和\ref效果类似,适合需要在一段文本中嵌入链接的场景,写法如下:/** 为简化此类操作,我实现了: * @li \link foo int foo( int v1, int v2, char *s1, char *s2) \endlink * * 该函数可用于…… */开启自动链接支持(简洁版)
如果你在Doxygen的配置文件里开启了AUTOLINK_SUPPORT(默认一般是开启状态),直接在列表里写foo()也能生成链接,不过这种方式只会显示函数名加括号,不会显示完整参数列表:/** 为简化此类操作,我实现了: * @li foo() * * 该函数可用于…… */
需要注意的是,如果你的项目里有同名的重载函数,可能需要在\ref里加上更明确的标识符(比如包含参数类型的完整签名),来指定具体要链接的函数。
内容的提问来源于stack exchange,提问作者John
相关产品推荐
相关产品推荐

