【问题标题】:Doxygen: How to create extra class docs outside of source code?Doxygen:如何在源代码之外创建额外的类文档?
【发布时间】:2013-04-09 13:32:39
【问题描述】:

我想添加关于我的核心类的详细信息,而不是将其全部嵌入源文件中的这些类之上。

例如,我想创建一个单独的文件,其中包含有关 Foo 类的大量信息,可能在 markdown 或 html 中。然后,当我在 doxygen 创建的输出中查看 Foo 类时,我希望 Foo 的类页面在其详细信息部分包含我所有大量且标记精美的文档以及我做过的任何其他 cmets 放在类Foo 之上。

这可能吗?

【问题讨论】:

    标签: documentation markdown doxygen


    【解决方案1】:

    如果你当前有一个文件 Foo.h

    /**
    A short description of class Foo.
    */
    class Foo
    {
    }
    

    您可以在扩展名为 .dox 的文件中添加其他文档(我们称之为 Foo.dox)

    /**
    More details about Foo.
    
    Maybe you only want to distribute this to your nicer customers.
    
    @class Foo Foo.h
    */
    

    不要忘记将 .dox 文件添加到配置文件的 INPUT 行

    INPUT = \
    Foo.h Foo.dox
    

    【讨论】:

    • 毕竟这很容易。 :) 谢谢!
    • 另一个用例可能是允许公共访问文档源而不是源代码,以便 API 的使用者可以发送添加描述和示例的拉取请求。
    • 1.这适用于类型、函数、常量等吗?还是只是为了上课? 2.如果你指定一个类的“命名空间路径”,它会出现在文档中还是仅仅用来解析你所指的类?
    猜你喜欢
    • 2018-01-18
    • 2011-06-12
    • 2016-09-17
    • 2011-11-18
    • 1970-01-01
    • 2010-11-15
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多