Детальное описание Doxygen превращается в краткое описание - PullRequest
Новая
       26

Детальное описание Doxygen превращается в краткое описание

0 голосов
/ 25 апреля 2019

Мой 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 Ответ

1 голос
/ 25 апреля 2019

Я мог воспроизвести проблему с текущей (1.8.15) версией doxygen.

Решение @Someprogrammerdude работает

Порядок команд немного странный. Я бы ожидал, что сначала \class, за которым следует описание \brief, также не требуется \class, поскольку документация (в данном случае) находится прямо перед класс.

Другое решение состоит в том, чтобы поместить . в конце предложения, и JAVADOC_AUTOBRIEF или QT_AUTOBRIEF установить в YES.

Причина проблемы в том, что \class не рассматривается как окончание документации \brief. Возможно, было бы целесообразно представить отчет о проблеме на https://github.com/doxygen/doxygen/issues/new (поэтому он может быть исправлен или могут быть выдвинуты дополнительные возражения против использования \class и других с аналогичным значением для прекращения краткого описания.

...