Doxygen详细描述渗入简要描述

Doxygen detailed description bleeds into the brief description

本文关键字:描述 Doxygen      更新时间:2023-10-16

我的以下代码的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_AUTOBRIEFQT_AUTOBRIEF设置为YES

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