views:

97

answers:

3
class EXAMPLE{
    public func1()
    private func2()
    func3()
}

I have checked for documented entities only. I have documentation for func1 and func3 but no documentation for func2. I have

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

But after the documentation is generated I still see the signature of func2 without hyperlink.

Does anyone know a way to show only those functions explicitly documented?

+2  A: 

You must turn on the EXTRACT_PRIVATE flag. As func2() is private and the EXTRACT_PRIVATE flag instructs Doxygen to ignore the private even if they are documented.

Alon
A: 

Thanks for the quickest response but actually my case is this one:

class EXAMPLE
{
    public func1()
    public func2()
    public func3()
}

Func2 is not documented at all. And I don't want it display in the list of documentation.

Ashish
+1  A: 

if you only want to include documented methods in your final result that set

HIDE_UNDOC_MEMBERS = YES

there is also a flag to hide undocumented classes: HIDE_UNDOC_CLASSES

Alon