2011-09-14 27 views
4

從概念上講,我沿着restructuredtext的方向,將自述文件分佈在不同的源目錄中,然後讀取Doxygen,並將這些自述文本文件包含爲生成的Doxygen輸出的一部分。如何編寫自動包含在Doxygen輸出中的自述文件?

這是如何完成的?還是我需要創建一個僞C文件喜歡惡搞的Doxygen:

README.h:

/** 
My big long readme file describing how this library 
was created and how it should be used 
*/ 
namespace foo_readme { } 

回答

6

如果你僅僅使用HTML輸出,你可以只使用doxygen的配置文件的HTML_EXTRA_FILES場。

如果你有一個純文本的README文件,只需手動將它添加到你的程序目錄。

您也可以用標記\mainpage來欺騙.h文件以填充doxygen輸出的索引(主)頁面。