Перечисление Doxygen не отображается

возможно ли, чтобы doxygen генерировал документы для перечисления, объявленного в одном из заголовков моего класса? Перечисление для свойства, называемого "scope" в этой ссылке не отображается как документированный тип.

8
c doxygen objective-c

2 ответов

согласно руководству Doxygen здесь:

To document global objects (functions, typedefs, enum, macros, etc), you must document the file in which they are defined. In other words, there must at least be a

/*! \file */ 
or a
/** @file */ 
line in this file.

вот пример:

/*! \file MyClass.h
    \brief A brief file description.

    More details
 */

/*! This is an enum */
enum Direction {
    kDirectionRight, /*!< this is right */
    kDirectionLeft,  /*!< this is left */
};

надеюсь, что это помогает

4

отредактируйте конфигурацию Doxyfile и установите следующее:

SHOW_FILES = YES

. . а затем просто добавьте стандартный документ-комментарии к типу перечисления.

теперь связаны и документально.

0