如何从 doxygen 输出中排除 class 的无证成员 functions/variables?
How to exclude undocumented member functions/variables of a class from doxygen output?
正如标题所暗示的,这可能吗?
基本上,任何未记录的内容都不会出现在输出中。
来自the FAQ:
Is your class / file / namespace documented? If not, it will not be extracted from the sources unless EXTRACT_ALL is set to YES in the config file.
所以,设置为NO。
我通常只导出必要的,所以:(也没有 static 和 private)
# do not extract all
EXTRACT_ALL = NO
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO
并隐藏未注释的内容:
# hide undoc stuff
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = YES
HIDE_FRIEND_COMPOUNDS = YES
HIDE_IN_BODY_DOCS = YES
执行此操作后,将只处理使用了 @file
标记的文件,并且只考虑记录的元素。
(doxygen 1.8.13)
正如标题所暗示的,这可能吗?
基本上,任何未记录的内容都不会出现在输出中。
来自the FAQ:
Is your class / file / namespace documented? If not, it will not be extracted from the sources unless EXTRACT_ALL is set to YES in the config file.
所以,设置为NO。
我通常只导出必要的,所以:(也没有 static 和 private)
# do not extract all
EXTRACT_ALL = NO
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO
并隐藏未注释的内容:
# hide undoc stuff
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = YES
HIDE_FRIEND_COMPOUNDS = YES
HIDE_IN_BODY_DOCS = YES
执行此操作后,将只处理使用了 @file
标记的文件,并且只考虑记录的元素。
(doxygen 1.8.13)