结构的 doxygen 别名，class，等等

Question

我想创建一些在内部创建 \struct 命令的别名，该命令引用一些特定的结构并添加一些额外的命令：

ALIASES += "thing{2}=\struct  \n \n \xrefitem thingList\"\" \"List of Things\"   this thing belongs to that \ref "

别名在一些正常的 doxy 注释中被调用：

/**
 *
 * \thing{SomeThing, SomeThingStruct}
 *
 * \brief ..sdfsdf
 */
typedef struct sSomeTag SomeThingStruct;

它主要做了它应该做的，而且 xrefitem 列表也正确生成，但我得到错误：

warning: the name `\_linebr' supplied as the argument of the \class, \struct, \union, or \include command is not an input file

因为它将别名中的 \n 解释为 \struct 关键字的第二个参数

如何定义我的别名使其不产生此警告？

Answer 1

请参阅 doxygen 文档中有关 ALIASES 的文档。

直接来自文档的几点：

ALIASES This tag can be used to specify a number of aliases that act as commands in the documentation. An alias has the form: name=value For example adding "sideeffect=@par Side Effects:\n" will allow you to put the command \sideeffect (or @sideeffect) in the documentation, which will result in a user-defined paragraph with heading "Side Effects:". You can put \n's in the value part of an alias to insert newlines (in the resulting output). You can put ^^ in the value part of an alias to insert a newline as if a physical newline was in the original file.

这里看到等号(=)的用法（同时更正，复制时忘记了）
使用大写 <-> 小写（您现在应该有一条消息：warning: Found unknown command\thing'`（同时更正）
\n 的用法可能是 ^^

所以别名应该是：

ALIASES += thing{2}="\struct ^^ ^^ \xrefitem thingList\"\" \"List of Things\" this thing belongs to that \ref "

结构的 doxygen 别名，class，等等

doxygen alias to struct, class, etc

doxygen