我在理解某些将选项作为第一个参数的Doxygen命令时遇到了麻烦(使用HTML输出)。
在这里,它是关于\include
命令的,但是我相信答案(如果有的话)将适用于其他命令。
manual说:
如果需要,您可以添加选项{lineno}为所包含的代码启用行号。
您可以添加选项{doc}将该文件视为文档而不是代码。
我无法使用它。 这个:
\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
但这些都不起作用。
其与lineno
选项的行为相同。
为完整起见,我不得不提到手册提供了有关here表示法的一些信息:
某些命令具有一个或多个参数。每个参数都有一定范围:
如果使用花括号,则参数为单个单词。
如果使用(大括号),则参数会一直扩展到找到命令的行的末尾。
如果使用{curly}大括号,则参数会扩展到下一段。段落由空白行或节指示符定界。
但是我不明白这与\include
命令手册的上述引用有何关系。
有人知道吗?
Doxygen版本:1.8.11(最新的Ubuntu 16.04)。
答案 0 :(得分:1)
第一个必须区分不同版本的doxygen。在1.8.11版本中,没有任何选项,例如const routeComponentFactory = <TProps extends {}>(
Component: React.ComponentType<TProps>,
props: TProps & {}
) => {
return (routeProps: any) => {
return <Component {...routeProps} {...props} />;
};
};
interface MyComponentProps { a: number; b: number; }
const MyComponent: React.FunctionComponent<MyComponentProps> = () => null;
routeComponentFactory(MyComponent, {}); // Argument of type '{}' is not assignable to parameter of type 'MyComponentProps'
命令,它们是在1.8.15版中引入的。
的语法例如\include
命令在1.8.15中:
\ include [{lineno,doc}]
在较新的版本中,其写为:
\ include ['{'option'}']
因为尚不完全清楚,所以重写已完成。此处(新版本,但此语法也适用于1.8.15)方括号(\include
和[
)表示]
和'{'
信号的可选项大括号是必需的。在这种情况下,该选项可以是'}'
或lineno
。此外,您在doc
之后和大括号之间看不到空格,该空格不应存在,大括号是命令的一部分。如果出现空格,则将其视为命令的结尾,而\include
将作为参数的开头。
如果{
的文件名为\include
,我们可以拥有:
xx.h
\include xx.h
\include{lineno} xx.h
这是关于选项的信息,另一引号是关于命令的参数的信息。