【发布时间】:2021-08-23 12:34:57
【问题描述】:
我可以使用 # 符号链接到枚举文档
在生成的 html 中它链接到枚举
当将鼠标放在链接上时,会有一个带有文档文本的工具提示
如何获取文档的文本?
当我在某处写 #MY_ENUM 时,我得到了一个链接,但我怎样才能得到文本而不仅仅是一个工具提示
例如在 enum.h 我写这个
/**
* @file enums.h
*/
typedef enum{
MY_ENUM = 0x1, ///< Some text
}SOME_ENUM;
我在 other_header.h 中写了这个
/**
* @file other_header.h
*/
/**
* Funktion Description
*
* Values for SOME_ENUM can be<br>
* #MY_ENUM
*/
int some_function( SOME_ENUM parameter );
在 some_function 的 html 文档中,生成了指向 MY_ENUM 的链接 但我想在链接后添加文本“一些文本”
或者是否可以在其中插入孔 SOME_ENUM 表?
【问题讨论】:
-
对我来说,不清楚究竟是什么不起作用。您的代码不包含任何包含
#的 Doxygen 注释。当SOME_ENUM没有记录时,我什至不确定 Doxygen 是否会为MY_ENUM生成文档。请edit您的问题并创建一个minimal reproducible example。 -
如果 MY_ENUM 没有记录,它可以工作