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

问题描述 投票:0回答:1

我的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的doc块示例:

/*! \brief Brief description.
 *         Brief description continued.
 *
 *  Detailed description starts here.
 */

有人知道解决方案吗?

c++ doxygen
1个回答
1
投票

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

@Someprogrammerdude的解决方案确实有效

命令的顺序有点奇怪,我原先预计\class后跟\brief描述,\class也没有必要,因为文档(在这种情况下)直接在类前面。

另一个解决方案是在句子的末尾放置一个.,并将JAVADOC_AUTOBRIEFQT_AUTOBRIEF设置为YES

问题的背景是\class不被视为\brief文档的结尾。在https://github.com/doxygen/doxygen/issues/new提交问题报告可能是值得的(所以要么可以修复,要么可以使用\class以及其他具有类似含义的其他反对意见来终止简要说明。

© www.soinside.com 2019 - 2024. All rights reserved.