【问题标题】:remove Protected section from Documentation?从文档中删除受保护的部分?
【发布时间】:2011-08-11 11:22:23
【问题描述】:

我一直在使用 doxygen 为我的项目生成 html 文档。我生成的文档包含一个文件选项卡。如何从中删除受保护的属性和受保护的成员函数字段?

受保护的成员函数 受保护的属性

【问题讨论】:

    标签: c++ doxygen


    【解决方案1】:

    如果您不希望提取某些内容,则不应包含文档块。在您的版本中提供一个仅包含您希望公开的方法的头文件,创建一个单独的头文件供您自己使用。如果您希望内部文档对您有利,您也可以使用 \internal 标志,但这也需要公开隐藏方法的原型。

    一般:

    /** \internal My personal documentation
    * Public documentation..................
    */
    

    doxyfile EXTRACT_ALL= 0, HIDE_UNDOC_MEMBERS=1, INTERNAL_DOCS = 1 或 0

    【讨论】:

    • 是的,我发现了一些相关的东西......我们在 doxygen 中有一些称为 \cond 和 \endcond 方法的东西,它们允许我们隐藏部分代码以防止暴露于文档
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2023-03-07
    • 2015-11-14
    • 1970-01-01
    • 1970-01-01
    • 2011-01-23
    相关资源
    最近更新 更多