如何使用带有选项的Doxygen命令作为第一个参数?
我在理解某些将选项作为第一个参数(使用HTML输出)的Doxygen命令时遇到一些困难。 这里是关于如何使用带有选项的Doxygen命令作为第一个参数?,doxygen,Doxygen,我在理解某些将选项作为第一个参数(使用HTML输出)的Doxygen命令时遇到一些困难。 这里是关于\include命令的,但我相信答案(如果有的话)将适用于其他命令 报告说: 如果需要,可以添加选项{lineno}以启用包含代码的行号 您可以添加选项{doc},将文件视为文档而不是代码 我不能让它工作。 这: 很好。但文件内容被视为代码(这是完全正常的),它实际上包含一些生成的内容,我希望将这些内容格式化为文档 我试过这些(是的,请不要笑): 但这些都不管用。 与lineno选项的行为相同 完
\include
命令的,但我相信答案(如果有的话)将适用于其他命令
报告说:
如果需要,可以添加选项{lineno}以启用包含代码的行号
您可以添加选项{doc},将文件视为文档而不是代码
我不能让它工作。
这:
很好。但文件内容被视为代码(这是完全正常的),它实际上包含一些生成的内容,我希望将这些内容格式化为文档
我试过这些(是的,请不要笑):
但这些都不管用。
与lineno
选项的行为相同
完整地说,我必须提到手册提供了一些关于符号的信息:
某些命令有一个或多个参数。每个参数都有一定的范围:
如果使用大括号,则参数为单个单词
如果使用(圆)括号,参数将一直延伸到找到命令的行的末尾
如果使用了{curly}大括号,参数将一直延伸到下一段。段落由空行或节指示符分隔
但我不明白这与\include
命令手册的上述引用有什么关系
有人有线索吗
Doxygen版本:1.8.11(Ubuntu 16.04的最新版本)。首先要区分不同版本的Doxygen。在1.8.11版本中没有选项,例如
\include
命令,它们在1.8.15版本中引入
如\include
命令的语法见1.8.15:
\包括[{lineno,doc}]
在较新的版本中,这写为:
\包括['{'选项'}']
重写完成了,因为它不完全清楚。此处(新版本,但该语法也适用于1.8.15)方括号([
和]
)表示可选性,'{'
和'}'
表示必须使用花括号。这种情况下的选项可以是lineno
或doc
。此外,在\include
之后和花括号之间看不到空格,这不应该在那里,花括号是命令的一部分。如果出现空格,它将被视为命令的结尾,{
将是参数的开始
如果\include
带有文件名xx.h
,我们可以:
\include xx.h
\include{lineno}xx.h
\include{dox}xx.h
这是关于选项的,另一个引号是关于命令的参数的。谢谢。所以这只是版本问题,很高兴知道。我确实检查了变更日志,看到了:
包括命令显示行号(例如LaTeX)
但我认为这只是关于LaTeX和行号的问题。好吧,所以我确实忽略了一点,那就是不能有空格。无论如何,我只是尝试了一下,我可以确认这对1.8.11不起作用。我将尝试升级。对于1.8.11,命令\includelineno
存在,这与\include{lineno}的作用相同
。\includedoc
是在1.8.12中引入的。选项背后的想法是减少命令数量,并使命令列表更紧凑。老实说,我仍然对标记部分感兴趣,以查看\include{doc}
的错误(您可以在上发布一个新问题,并附加一个小的、自包含的示例(tar或zip中的source+配置文件),使我们能够重现该问题。请不要添加外部链接,因为它们可能不会持久。将找到的解决方案放在那里(用于比较)也会很好。好的,我将尝试这样做,直到我们完成此操作为止。
\include doc path/to/my/file
\include doc path/to/my/file
\include [doc] path/to/my/file
\include {doc} path/to/my/file
\include {[doc]} path/to/my/file
\include [{doc}] path/to/my/file