Переменные не документируются с помощью Doxygen - PullRequest
0 голосов
/ 19 февраля 2012

Я использую Doxygen для документирования своего кода C ++. Все они хорошо выводятся в формате HTML, за исключением атрибутов / переменных, подобных приведенным ниже (совсем нет).

    /**
     * Flag to check whether the variable is once initialized or not
     */
     bool initialized_;

Есть идеи, что может пойти не так?

EDIT

initialized_ - переменная члена класса.

1 Ответ

2 голосов
/ 20 февраля 2012

Я не уверен, что это решит вашу проблему, так как вы дали очень мало информации о переменной initialized_ (это глобальная переменная, является ли она частью класса и т. Д.), Но doxygen документация (см. под заголовком документация в других местах ) гласит, что

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

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

/*! \file */ 

или

/** @file */ 

строка в этом файле.

...