我想在我的c++代码氧注释指的是一个特定的函数;比如,在另一个命名空间:foo::bar()
中。让我们忽略这个函数被重载的可能性。我也希望函数的名称被设置为相同的方式,在我的氧注释中的反引号内的内容。
考虑到这一点,下面哪个应该产生我所描述的效果?
@ref foo::bar
@ref foo::bar()
@ref `foo::bar`
@ref `foo::bar()`
或者-也许是别的什么?
ref
命令的文档说明:
裁判("(文本)")
创建对指定节、子节、页面或锚的引用。对于HTML文档,reference命令将生成指向该部分的链接。对于章节或小节,章节的标题将用作链接的文本。对于锚,将使用引号之间的可选文本,或者如果没有指定文本。对于LATEX文档,reference命令将为章节生成一个章节号,或者如果引用了锚,则文本后跟一个页码。
使用ref
命令时,第一个参数是<name>
,<name>
不能包含反号。
要获得所要求的单间距链接的可能性,可以(仅限!)调整/扩展样式表中使用的条目。
在默认的氧样式表
doxygen.css
中,我们有:
a.el {
font-weight: bold;
}
通过将该条目更改为例如
a.el {
font-family: monospace, fixed;
font-weight: normal;
}
最好不要重新定义doxygen.css
,而将其作为设置HTML_STYLESHEET
,但创建一个新的,额外的,样式表,并指定在HTML_EXTRA_STYLESHEET
。
注意这将影响所有不仅仅是ref
的链接。