Doxygen 详细描述渗透到简短描述中

Question

我的以下代码的 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.
 */

有人知道解决方案吗？

Answer 1

我可以使用当前 (1.8.15) 版本的 doxygen 重现该问题。

@Someprogrammerdude 的解决方案确实有效

命令的顺序有点奇怪我希望首先是 \class 然后是 \brief 描述，而且 \class 不是必需的，因为文档是（在这种情况下）直接在 class.

前面

另一种解决方案是在句子末尾放置一个.并将JAVADOC_AUTOBRIEF或QT_AUTOBRIEF设置为YES。

问题的背景是 \class 未被视为 \brief 文档的结尾。在 https://github.com/doxygen/doxygen/issues/new 提交问题报告可能是值得的（因此可以修复它，或者可以针对使用 \class 和其他具有类似含义的其他人提出一些额外的反对意见，以终止简短描述。

Doxygen 详细描述渗透到简短描述中

Doxygen detailed description bleeds into the brief description

c++

doxygen