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

Question

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

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

这可能吗？

Answer 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