Документирование частной структуры внутри класса - PullRequest
2 голосов
/ 15 ноября 2011

На данный момент у меня есть:

/// @brief Random class.
class Foo {
    /// @brief A private embedded struct of Foo.
    struct Bar {
        /// @brief Some value.
        int x;
    }
}

Мой вывод Doxygen перечисляет Bar как «структуру данных» на справочной странице Foo, но нигде не могу найти документацию для x. Bar не имеет гиперссылок и не отображается на странице глобальных структур данных. Есть ли какие-то обручи, через которые я должен прыгать, или это зависит от параметров Doxyfile?

(Я создаю свой вывод с помощью Doxygen 1.7.1, если это имеет значение. Вывод генерируется на общем сервере, поэтому у меня не так много вариантов, чтобы это изменить.)

Ответы [ 2 ]

3 голосов
/ 15 ноября 2011

Может быть EXTRACT_PRIVATE настройка в Doxyfile?

0 голосов
/ 15 ноября 2011

Попробуйте использовать комментарий в той же строке.

    int x; ///< Some value.

Но это должно быть то же самое ...

...