如何在生成Doxygen文档时排除私有成员仅保留私有函数

要实现只保留私有函数、排除私有成员变量的效果，核心是通过Doxygen的配置或代码标记区分私有函数与私有成员，以下是两种可行方案：

方案一：代码中添加条件编译标记（精准控制，推荐） #

在代码里给不需要生成文档的私有成员变量块加上Doxygen条件编译标记，让Doxygen忽略这部分内容：

1. 修改代码中的类定义：

class YourClass {
public:
    // 公共成员...
private:
    \cond PRIVATE_VARS
    // 这里放所有需要排除的私有成员变量
    int m_internalState;
    std::string m_cacheData;
    \endcond

    // 私有函数会被正常提取
    void privateUtilityFunc();
    bool privateCheckLogic();
};

2. 修改Doxyfile配置：
   确保ENABLED_SECTIONS不包含PRIVATE_VARS，让Doxygen跳过标记块内容：

ENABLED_SECTIONS = 
EXTRACT_PRIVATE        = YES  # 保留此配置以提取私有函数
EXTRACT_PRIV_VIRTUAL   = YES
# 其他配置保持原有设置不变

方案二：通过命名规范过滤（无需修改代码） #

如果你的私有成员变量有统一命名前缀（比如m_、_），可直接在Doxyfile中添加符号排除规则：

在Doxyfile里新增配置：

EXCLUDE_SYMBOLS = *m_*  # 替换为你实际的私有成员变量前缀
EXTRACT_PRIVATE        = YES
EXTRACT_PRIV_VIRTUAL   = YES

这样所有匹配该前缀的私有成员变量会被排除，不使用该前缀的私有函数则会被保留。

关键注意点 #

• 不要将EXTRACT_PRIVATE设为NO，否则会连私有函数一起排除；
• Sphinx的breathe插件是读取Doxygen生成的XML文件生成文档，所以核心控制逻辑在Doxyfile配置；
• 若使用方案一，需确保所有需排除的私有成员都放在\cond块内，避免遗漏。

内容的提问来源于stack exchange，提问作者Sriram