Undocumented functions should not be viewable/displayed in the list - Issue document only for documented entities

半城伤御伤魂 提交于 2019-12-12 05:38:40

问题


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?


回答1:


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.




回答2:


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



来源:https://stackoverflow.com/questions/1719868/undocumented-functions-should-not-be-viewable-displayed-in-the-list-issue-docu

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!