Doxygen:如何在源代码之外创建额外的类文档?

时间:2013-04-16 23:36:23

标签: documentation markdown doxygen

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

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

这可能吗?

1 个答案:

答案 0 :(得分:3)

如果您目前有一个文件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