2011-08-08 60 views
1

我觉得我的问题基本上是相同的,因为这一个,但它并没有得到一个很好的答案:Create new custom command that will add to a section in Doxygen的Doxygen - 创建自定义命令

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

我也试着这样做:在我的Doxyfile

ALIASES = option"\par Options:\n" 

,但我也得到了自己的部分,而不是所有的人在同一节是每个单独的选项。他们也没有与@param选项相同的参数。

我也尝试过用\xrefitem做些什么,当然这种做法并不奏效。我尝试这样做:

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

但它看起来像被用于创建更多的东西一样从不同部分编译列表,像待办列表\xrefitem

非常感谢帮助。谢谢!


编辑:

只是为了澄清,我正在寻找的输出会是这个样子:

选项:
                $ opt ion1    这是选项1
                $ 1选项    这是选项2

+0

我期待着做同样的事情,除了有文字“错误”。也许这个问题更完整的标题可能会吸引更多的答案。你有没有提交功能要求?如果是这样,它已经有6年没有采取行动。 – msc

+0

@msc:对不起,我不记得是否打开了功能请求。如果你愿意,随意编辑这个问题,但我不再寻找这个问题的答案。 – Travesty3

回答

0

最接近我能想出是使用这样的:

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

这几乎是工作体面,但它不能很好地排队每一部分,像它与@param。因此,如果第一个选项的名称类似$option1,第二个选项的名称是$thisIsTheSecondOption,则说明的开头不会排队。它看起来更像是:

选项:
            $选项1  这是选项1
        INT     $ thisIsTheSecondOption  这是o 2.

这使得它更难以阅读。

: - \

+0

你可以发布你的别名来实现这个结果吗?我正在努力解决同样的问题。 doxygen不会以优雅的方式允许这种渲染,这很奇怪。 – Bruno

+0

@布鲁诺:对不起,这篇文章来自四年前。我在做不同的工作,不再使用Doxygen。我真的不记得这件事。但我不记得使用任何种类的别名。祝你好运! – Travesty3

0

我敢肯定,这是不可能的,而无需修改的doxygen 。我只是使用\ li,然后列出使用\ param的选项。

http://www.stack.nl/~dimitri/doxygen/commands.html#cmdli

+0

修改doxygen需要下载源代码,修改它并编译它,对吧?可能比我想要为此做更多的工作。也许我会提交功能请求。使用'\ li',我可以为'\ li'元素的区段创建一个头部,让用户知道这些是** Options **? – Travesty3

相关问题