Question

我想使用Doxygen来记录HTTP API并使用参数，返回结果等类似于类描述的HTTP查询的描述。所以我需要的是一个\query结构命令，后跟\brief，\param，\return等等，并有相应的标签＆＃34;查询＆＃34 ;在顶部导航菜单中。换句话说，我需要\class的100％复制，但只需使用不同的名称。这可能吗？如何？

Answer 1

不要认为可以像你希望的那样干净利落地做到这一点，但我要做到这一点的方法是使用群组。

/**
 * \defgroup query Queries
 */

然后将每个查询记录为query组

中的一个组

/**
 * \defgroup getUser Get User by Id
 * \ingroup query
 * \brief Some brief
 * \param Id user id
 * \return User for given id
 */

现在您需要在导航菜单中的query组中添加一个标签。

首先使用doxygen -l生成doxygen布局文件。然后在你的doxyfile集LAYOUTFILE = DoxygenLayout.xml。

最后更改DoxygenLayout.xml文件以添加新标签：

<navindex>
   ...
   <tab type="user" visible="yes" title="Queries" url="@ref query" intro=""/>

是否可以在Doxygen中创建自定义对象类型？

1 个答案: