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

Question

我想使用Doxygen来记录一个HTTP API并具有参数的HTTP查询的描述，返回类似于类描述的结果等。因此，我需要的是一个\query结构性命令，其后可以跟\brief,\param,\return等，并在顶部导航菜单中具有相应的选项卡“查询”。换句话说，我需要100％复制\class，但只是名称不同而已。这是可能的和如何？

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=""/>