如何告诉 Doxygen 在(C++)类中的私有部分之后记录公共部分?
例如
class Brg {
public:
//! this function will be documented
void documentedFunction1()
private:
void irrelevantFunction()
public:
//! this function will _not_ be documented
void undocumentedFunction1()
};
即使没有第一个公共部分,第二个公共部分仍然没有记录。
doxylog.txt 报告:
警告:未声明或定义记录的函数“Brg::undocumentedFunction1”
# Doxyfile 1.5.2 #------------------------------------------------ -------------------------- # 项目相关配置选项 #------------------------------------------------ -------------------------- DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = "废话" PROJECT_NUMBER = OUTPUT_DIRECTORY = ./gen_docs/ CREATE_SUBDIRS = 否 OUTPUT_LANGUAGE = 英语 Brief_MEMBER_DESC = 是 REPEAT_BRIEF = 是 ABBREVIATE_BRIEF = ALWAYS_DETAILED_SEC = 否 INLINE_INHERITED_MEMB = 否 FULL_PATH_NAMES = 否 STRIP_FROM_PATH = STRIP_FROM_INC_PATH = SHORT_NAMES = 否 JAVADOC_AUTOBRIEF = 否 MULTILINE_CPP_IS_BRIEF = 否 DETAILS_AT_TOP = 否 INHERIT_DOCS = 是 SEPARATE_MEMBER_PAGES = 否 TAB_SIZE = 4 别名 = OPTIMIZE_OUTPUT_FOR_C = 否 OPTIMIZE_OUTPUT_JAVA = 否 BUILTIN_STL_SUPPORT = 否 CPP_CLI_SUPPORT = 否 DISTRIBUTE_GROUP_DOC = 否 分组 = 是 #------------------------------------------------ -------------------------- # 构建相关配置选项 #------------------------------------------------ -------------------------- EXTRACT_ALL = 是 EXTRACT_PRIVATE = 否 EXTRACT_STATIC = 是 EXTRACT_LOCAL_CLASSES = 否 EXTRACT_LOCAL_METHODS = 否 HIDE_UNDOC_MEMBERS = 否 HIDE_UNDOC_CLASSES = 是 HIDE_FRIEND_COMPOUNDS = 否 HIDE_IN_BODY_DOCS = 否 INTERNAL_DOCS = 否 CASE_SENSE_NAMES = 是 HIDE_SCOPE_NAMES = 否 SHOW_INCLUDE_FILES = 是 INLINE_INFO = 是 SORT_MEMBER_DOCS = 是 SORT_BRIEF_DOCS = 否 SORT_BY_SCOPE_NAME = 否 GENERATE_TODOLIST = 是 GENERATE_TESTLIST = 是 GENERATE_BUGLIST = 是 GENERATE_DEPRECATEDLIST= 是 ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = 是 SHOW_DIRECTORIES = 是 FILE_VERSION_FILTER = #------------------------------------------------ -------------------------- # 与警告和进度消息相关的配置选项 #------------------------------------------------ -------------------------- 安静 = 不 警告 = 是 WARN_IF_UNDOCUMENTED = 是 WARN_IF_DOC_ERROR = 是 WARN_NO_PARAMDOC = 否 WARN_FORMAT = "$file:$line: $text" WARN_LOGFILE = doxylog.txt #------------------------------------------------ -------------------------- # 与输入文件相关的配置选项 #------------------------------------------------ -------------------------- 输入 = 。\ ..\代码 图像路径 = 。 输入编码 = UTF-8 FILE_PATTERNS = *.cpp \ *.cc \ *。H \ *.hpp \ *。文本 示例路径 = 。\ ..\代码 \ 示例_模式 = *.lua \ *。H 示例_递归 = 是 递归 = 是 排除 = EXCLUDE_SYMLINKS = 否 EXCLUDE_PATTERNS = EXCLUDE_SYMBOLS = 输入过滤器 = FILTER_PATTERNS = FILTER_SOURCE_FILES = 否 #------------------------------------------------ -------------------------- # 与源浏览相关的配置选项 #------------------------------------------------ -------------------------- SOURCE_BROWSER = 否 INLINE_SOURCES = 否 STRIP_CODE_COMMENTS = 是 REFERENCED_BY_RELATION = 是 REFERENCES_RELATION = 是 REFERENCES_LINK_SOURCE = 是 USE_HTAGS = 否 VERBATIM_HEADERS = 是 #------------------------------------------------ -------------------------- # 与字母分类索引相关的配置选项 #------------------------------------------------ -------------------------- ALPHABETICAL_INDEX = 否 COLS_IN_ALPHA_INDEX = 5 IGNORE_PREFIX = #------------------------------------------------ -------------------------- # 与 HTML 输出相关的配置选项 #------------------------------------------------ -------------------------- GENERATE_HTML = 是 HTML_OUTPUT = html HTML_FILE_EXTENSION = .html HTML_STYLESHEET = HTML_ALIGN_MEMBERS = 是 GENERATE_HTMLHELP = 是 CHM_FILE = HHC_LOCATION = GENERATE_CHI = 是 BINARY_TOC = 否 TOC_EXPAND = 否 DISABLE_INDEX = 否 ENUM_VALUES_PER_LINE = 4 GENERATE_TREEVIEW = 否 TREEVIEW_WIDTH = 250 #------------------------------------------------ -------------------------- # 与 LaTeX 输出相关的配置选项 #------------------------------------------------ -------------------------- GENERATE_LATEX = 否 LATEX_OUTPUT = 乳胶 LATEX_CMD_NAME = 乳胶 EXTRA_PACKAGES = amsmath MAKEINDEX_CMD_NAME = 生成索引 COMPACT_LATEX = 否 PAPER_TYPE = a4wide EXTRA_PACKAGES = LATEX_HEADER = PDF_HYPERLINKS = 是 USE_PDFLATEX = 是 LATEX_BATCHMODE = 否 LATEX_HIDE_INDICES = 否 #------------------------------------------------ -------------------------- # 与 RTF 输出相关的配置选项 #------------------------------------------------ -------------------------- GENERATE_RTF = 否 RTF_OUTPUT = rtf COMPACT_RTF = 否 RTF_HYPERLINKS = 否 RTF_STYLESHEET_FILE = RTF_EXTENSIONS_FILE = #------------------------------------------------ -------------------------- # 与手册页输出相关的配置选项 #------------------------------------------------ -------------------------- GENERATE_MAN = 否 MAN_OUTPUT = 人 MAN_EXTENSION = .3 MAN_LINKS = 否 #------------------------------------------------ -------------------------- # 与 XML 输出相关的配置选项 #------------------------------------------------ -------------------------- GENERATE_XML = 否 XML_OUTPUT = xml XML_SCHEMA = XML_DTD = XML_PROGRAMISTING = 是 #------------------------------------------------ -------------------------- # AutoGen 定义输出的配置选项 #------------------------------------------------ -------------------------- GENERATE_AUTOGEN_DEF = 否 #------------------------------------------------ -------------------------- # 与 Perl 模块输出相关的配置选项 #------------------------------------------------ -------------------------- GENERATE_PERLMOD = 否 PERLMOD_LATEX = 否 PERLMOD_PRETTY = 是 PERLMOD_MAKEVAR_PREFIX = #------------------------------------------------ -------------------------- # 预处理器相关的配置选项 #------------------------------------------------ -------------------------- ENABLE_PREPROCESSING = 是 MACRO_EXPANSION = 否 EXPAND_ONLY_PREDEF = 否 SEARCH_INCLUDES = 是 包含路径 = INCLUDE_FILE_PATTERNS = 预定义 = EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = 是 #------------------------------------------------ -------------------------- # Configuration::additions 与外部引用相关 #------------------------------------------------ -------------------------- 标签文件 = ../ExternalModule/ExternalModule.tag=../../../ExternalModule/Docs/html GENERATE_TAGFILE = 模块名.tag 外部设备 = 否 EXTERNAL_GROUPS = 是 PERL_PATH = /usr/bin/perl #------------------------------------------------ -------------------------- # 点工具相关的配置选项 #------------------------------------------------ -------------------------- CLASS_DIAGRAMS = 是 MSCGEN_PATH = HIDE_UNDOC_RELATIONS = 是 HAVE_DOT = 是 CLASS_GRAPH = 是 COLLABORATION_GRAPH = 是 GROUP_GRAPHS = 是 UML_LOOK = 否 TEMPLATE_RELATIONS = 是 INCLUDE_GRAPH = 是 INCLUDED_BY_GRAPH = 是 CALL_GRAPH = 否 CALLER_GRAPH = 否 GRAPHICAL_HIERARCHY = 是 DIRECTORY_GRAPH = 是 DOT_IMAGE_FORMAT = png DOT_PATH = DOTFILE_DIRS = DOT_GRAPH_MAX_NODES = 50 DOT_TRANSPARENT = 否 DOT_MULTI_TARGETS = 否 GENERATE_LEGEND = 是 DOT_CLEANUP = 是 #------------------------------------------------ -------------------------- # Configuration::additions 与搜索引擎相关 #------------------------------------------------ -------------------------- 搜索引擎 = 否