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不是必需的，因为文档是必需的（在这种情况下，）直接放在班级前面。

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

问题的背景是\class未被视为\brief文档的结尾。可能值得在https://github.com/doxygen/doxygen/issues/new提交问题报告（因此，可以将其修复，也可以提出一些反对意见，反对使用\class和其他具有类似含义的陈述来终止简短说明。< / p>

Doxygen详细说明渗入简短说明中

1 个答案: