【问题标题】:Doxygen - Create custom commandDoxygen - 创建自定义命令
【发布时间】:2011-10-22 12:45:36
【问题描述】:

我觉得我的问题和这个问题基本一样,只是没有得到好的答案:Create new custom command that will add to a section in Doxygen

我想我非常想做同样的事情。我想完全复制@param 选项的确切功能,除了给它标题“选项”而不是“参数”。我希望参数相同(数据类型、变量名和描述),并希望它们看起来都一样。从字面上看,我唯一需要不同的是标题。

我也试过这样做:

ALIASES = option"\par Options:\n"

在我的 Doxyfile 中,但我也将每个单独的选项放在其自己的部分中,而不是所有选项都在同一部分中。它们也没有与@param 选项相同的参数。

我还尝试对\xrefitem 做一些事情,当然,这没有用。我试过这个:

ALIASES = option="\xrefitem param \"Option\" \"Options\" "

但看起来\xrefitem 用于创建更像是来自不同部分的编译列表,例如待办事项列表。

非常感谢您的帮助。谢谢!


编辑:

澄清一下,我正在寻找的输出看起来像这样:

选项:
string    $option1  这是选项 1。
string    $option2  这是选项 2。

【问题讨论】:

  • 我想做同样的事情,除了文本“错误”。也许更完整的问题标题可能会吸引更多答案。您是否曾经提交过功能请求?如果是这样,它已经 6 年没有采取行动了。
  • @msc:抱歉,我不记得我是否打开了功能请求。如果需要,请随时编辑问题,但我不再寻找问题的答案。

标签: command arguments doxygen param


【解决方案1】:

我能想到的最接近的是使用这个:

@par Options:
@li @e string @b $option1 This is option 1.
@li @e string @b $option2 This is option 2.

这几乎可以正常工作,除了它没有很好地排列每个部分,就像它与@param 一样。因此,如果第一个选项的名称类似于$option1,而第二个选项的名称是$thisIsTheSecondOption,则说明的开头不会排列。它看起来更像:

选项:
string  $option1 这是选项 1。
int  $thisIsTheSecondOption 这是选项 2。

这使它更难阅读。

:-\

【讨论】:

  • 你能发布你的别名来达到这个结果吗?我正在努力解决同样的问题。 doxygen 不允许以优雅的方式进行这种渲染,这很奇怪。
  • @Bruno:抱歉,这篇文章是四年前的。我从事不同的工作,不再使用 Doxygen。老实说,我几乎不记得任何关于它的事情。但我不记得使用过任何别名。祝你好运!
【解决方案2】:

我很确定如果不修改 doxygen,这是不可能的。我只会使用 \li 并列出选项而不是使用 \param 然后。

http://www.doxygen.nl/manual/commands.html#cmdli

【讨论】:

  • 修改 doxygen 需要下载源代码、修改和编译,对吗?可能比我为此要做的工作更多。也许我会提交一个功能请求。使用\li,我可以为\li 元素部分制作标题,让用户知道这些是选项
猜你喜欢
  • 2015-11-25
  • 2011-07-10
  • 2015-12-30
  • 1970-01-01
  • 2010-12-11
  • 2011-03-04
  • 2013-02-24
  • 2018-06-11
  • 1970-01-01
相关资源
最近更新 更多