Doxygen详细描述渗入简要描述
Doxygen detailed description bleeds into the brief description
我的以下代码的doxygen如下所示:
Spawns two mettaurs on the fieldMay optionally spawn an empty tile for challenge
简要描述应该在哪里。请注意,它合并了简介和详细说明。
/*! brief Spawns two mettaurs on the field
* class TwoMettaurMob
*
* May optionally spawn an empty tile for challenge
*/
#pragma once
#include "bnMobFactory.h"
#include "bnMettaur.h"
#include "bnMettaurIdleState.h"
class TwoMettaurMob :
public MobFactory
{
public:
TwoMettaurMob(Field* field);
~TwoMettaurMob();
/**
* @brief Builds and returns the mob
* @return Mob pointer. must be deleted manually.
*/
Mob* Build();
};
我正在遵循doxygen的文档块示例:
/*! brief Brief description.
* Brief description continued.
*
* Detailed description starts here.
*/
有人知道解决方案吗?
我可以重现当前(1.8.15(版本的doxygen的问题。
@Someprogrammerdude的解决方案确实有效
命令的顺序有点奇怪,我本来希望首先是class
,然后是brief
描述,而且class
也不是必需的,因为文档(在这种情况下(直接在类前面。
另一种解决方案是在句子末尾放置一个.
,并将JAVADOC_AUTOBRIEF
或QT_AUTOBRIEF
设置为YES
。
问题的背景是class
不被视为brief
文档的结束。在 https://github.com/doxygen/doxygen/issues/new 提交问题报告可能是值得的(因此可以修复它,或者可以对使用 class
和其他具有类似含义的 终止简短描述提出一些额外的异议。
相关文章:
- 使用VerQueryValue检索应用程序的文件描述
- 如何使用重载的相等(==)运算符向测试用例添加描述
- 如何在C/C++中用FD_set Unix设置套接字文件描述符
- PC中的程序和PHONE中的本机描述应用程序之间的数据连接
- 从 Boost ASIO 获取 epoll 描述符 io_service对象
- 使 \page 和 \subpage 参考 doxygen 中的方法文档
- Doxygen - 如何在不生成图形的情况下生成文本调用关系结果
- I2C 文件描述符上的 I2C 总线可写/可读标志
- 如何在 CompleteAsyncIO 中访问 IOMemoryBufferDescriptor,该描述符通过中断 EP
- 使用 Doxygen 记录枚举类值,而不启用EXTRACT_ALL
- 如何在动态创建的CMFCToolbar的工具提示中添加描述?
- 带有 *.in 文件的 Doxygen
- 记录Doxygen中的命名
- 下面描述的概念如何在C++14中定义?
- Doxygen:不为非成员函数生成超链接
- 请描述一下在 c++ 中在此类中定义构造函数的方式?
- numpy.load 给出 ValueError: descr 不是有效的 dtype 描述符:
- 在 Direct3D 12 的描述符范围内设置多个描述符
- Doxygen详细描述渗入简要描述
- 如何使用 Doxygen 更改派生类中的函数描述