Автолинк Doxygen не работает с глобальными типами перечислений

Question

Я пытаюсь использовать Doxygen Автоматическое создание ссылок для документирования некоторых enum типов.Однако он не генерирует ссылки для глобальных типов enum.Он генерирует ссылки для глобальных типов struct.Есть ли что-то, что мне не хватает?Я использую пример, приведенный по ссылке выше.При необходимости я задокументировал файл, в котором определены типы.

update1 : я использую Doxygen версии 1.6.3

update2 : глобальные структуры в порядке

Answer 1

Да, у меня была та же проблема; я думаю, что doxygen думает, что они частные или что-то в этом роде глупое. Попробуйте использовать \public. Не забудьте сделать /*! в первой строке

/*! \public
 * Enum description goes here
 */
typedef enum {

    /**
     * Printer control language ZPL
     */
    PRINTER_LANGUAGE_ZPL,

    /**
     * Printer control language CPCL
     */
    PRINTER_LANGUAGE_CPCL

} PrinterLanguage;

Answer 2

У меня была такая же проблема. Некоторые заголовочные файлы генерировали ссылку на enums, а другие заголовочные файлы - нет. Вы должны явно задокументировать файл.

Вот выдержка из этой страницы в документации. http://www.doxygen.nl/manual/docblocks.html#memberdoc

Для документирования глобальной функции C, typedef, enum или препроцессора определение, вы должны сначала документировать файл, который его содержит (обычно это будет заголовочный файл, потому что этот файл содержит информацию экспортируется в другие исходные файлы).

Внимание Давайте повторим это, потому что это часто упускается из виду: чтобы документировать глобальные объекты (функции, typedefs, enum, макросы и т. Д.), Вы должны документировать файл, в котором они определены. Другими словами, там должен быть хотя бы

/*! \file */ 

or a

/** @file */ 

line in this file.