Я пытаюсь использовать Doxygen Автоматическое создание ссылок для документирования некоторых enum типов. Однако он не создает ссылки для глобальных типов enum. Он генерирует ссылки для глобальных типов struct. Есть ли что-то, что мне не хватает? Я использую пример, приведенный по ссылке выше. Как и требовалось, я задокументировал файл, в котором определены типы.
update1: я использую Doxygen версии 1.6.3.
update2: глобальные структуры в порядке
Да, у меня была такая же проблема; я думаю, что doxygen думает, что они частные или что-то в этом роде. Попробуйте использовать \public. Не забудьте сделать /*! в первой строке
/*! \public
* Enum description goes here
*/
typedef enum {
/**
* Printer control language ZPL
*/
PRINTER_LANGUAGE_ZPL,
/**
* Printer control language CPCL
*/
PRINTER_LANGUAGE_CPCL
} PrinterLanguage;
У меня была такая же проблема. Некоторые файлы заголовков генерировали ссылку для перечислений, а другие файлы заголовков — нет. Вы должны явно задокументировать файл.
Вот выдержка из этой страницы в документации. http://www.doxygen.nl/manual/docblocks.html#memberdoc
Чтобы задокументировать глобальную функцию C, typedef, enum или определение препроцессора, вы должны сначала задокументировать файл, который их содержит (обычно это будет заголовочный файл, поскольку этот файл содержит информацию, которая экспортируется в другие исходные файлы).
Внимание Давайте повторим это, потому что об этом часто забывают: для документирования глобальных объектов (функций, определений типов, перечислений, макросов и т. д.) вы должны документировать файл, в котором они определены. Другими словами, должен быть как минимум
/*! \file */ or a /** @file */ line in this file.
