Недокументированные функции не должны просматриваться / отображаться в списке - выпускать документ только для документированных объектов - PullRequest
Новая
       18

Недокументированные функции не должны просматриваться / отображаться в списке - выпускать документ только для документированных объектов

0 голосов
/ 12 ноября 2009 
class EXAMPLE{
    public func1()
    private func2()
    func3()
}

Я проверил только документированные объекты. У меня есть документация для func1 и func3, но нет документации для func2. У меня 

EXTRACT_ALL            = NO
EXTRACT_PRIVATE        = NO
EXTRACT_STATIC         = NO
EXTRACT_LOCAL_CLASSES  = YES
EXTRACT_LOCAL_METHODS  = NO

Но после того, как документация сгенерирована, я все еще вижу подпись func2 без гиперссылки.

Кто-нибудь знает способ показать только те функции, которые явно задокументированы?

Ответы [ 2 ]

2 голосов
/ 12 ноября 2009

Вы должны включить флаг EXTRACT_PRIVATE. Поскольку func2 () является приватным, а флаг EXTRACT_PRIVATE указывает Doxygen игнорировать приватные, даже если они задокументированы.

1 голос
/ 12 ноября 2009

, если вы хотите включить в окончательный результат только документированные методы, которые устанавливают

HIDE_UNDOC_MEMBERS = ДА

есть также флаг, чтобы скрыть недокументированные классы: HIDE_UNDOC_CLASSES

...