【问题标题】:Documenting a private struct inside a class在类中记录私有结构
【发布时间】:2011-11-15 10:15:55
【问题描述】:

目前,我有:

/// @brief Random class.
class Foo {
    /// @brief A private embedded struct of Foo.
    struct Bar {
        /// @brief Some value.
        int x;
    }
}

我的 Doxygen 输出在 Foo 的参考页面上将 Bar 列为“数据结构”,但我在任何地方都找不到 x 的文档。 Bar 没有超链接,并且似乎没有出现在全局数据结构页面上。有没有我必须跳过的障碍,还是取决于我的 Doxyfile 选项?

(我正在使用 Doxygen 1.7.1 创建我的输出,如果这有影响的话。输出是在共享服务器上生成的,所以我没有太多的选择来改变它。)

【问题讨论】:

    标签: c++ doxygen


    【解决方案1】:

    也许EXTRACT_PRIVATE 设置为Doxyfile

    【讨论】:

      【解决方案2】:

      尝试在同一行使用注释。

          int x; ///< Some value.
      

      但应该是一样的……

      【讨论】:

        猜你喜欢
        • 2019-02-13
        • 1970-01-01
        • 2015-07-17
        • 1970-01-01
        • 2015-02-10
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        相关资源
        最近更新 更多