我有以下 Doxygen 函数文档:
/**
@brief Does interesting things
@param[in] pfirst The first parameter: a barrel full of monkeys
@pre
"pfirst" must have been previously passed through BarrelFiller()
*/
注意pfirst
是一个参数,并且在前提条件中引用了它。
我在这里用引号将其引起来,因为我想将其与文本的其余部分区分开来。但如果这样做的话,Doxygen 会突出显示该命令,并且最好将其链接到参数定义,那就太好了。有没有办法做到这一点?
如果仅使用默认配置(或其较小的更改)就可以实现这种情况,那就特别好。
Doxygen 提供命令\p http://www.doxygen.nl/manual/commands.html#cmdp用于指示下一个单词是函数的参数。你会像这样使用它:
... the \p x and \p y coordinates are used to ...
我相信默认情况下这将使用打字机字体表示。我认为这目前不提供任何自动链接功能,但将来可能会提供。
有一个相关的命令,\a http://www.doxygen.nl/manual/commands.html#cmda用于标记成员参数。默认情况下,它在文本中强调显示(<em>arg</em>
)
您可以找到有关各种 Doxygen 的更多信息特殊命令参考 http://www.doxygen.nl/manual/commands.html.
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)