在主页(doxygen)中嵌入自述文件

时间:2014-03-17 19:42:56

标签: c++ doxygen

有没有办法将纯文本文件(README.txt)嵌入到doxygen的主页中? (我用cmake编写它,所以我可以转储变量,但我认为这种类型的东西会内置)。

1 个答案:

答案 0 :(得分:2)

不确定。在你的mainpage.dox(或你称之为的任何内容)中,将一个指向README.txt的链接作为单独的doxygen页面。

\mainpage FooBar

...
\section other_docs Additional Documentation`

...
Key features that distinguish the current release, build instructions,
and a history of Project FooBar are described in the
\ref README "Foobar README file".

然后,通过将README.txt设为纯文本页面文件来生成该页面。

\page README README
\verbinclude README.txt