2015-04-29 71 views
1

我有一個與doxygen記錄的C項目,並希望添加一個目錄,顯示部分和子部分。我嘗試了doxygen手冊中描述的\tableofcontents[TOC],但沒有任何反應。這裏是一個小例子:如何添加目錄到doxygen生成的html文件?

/***********************************//** 
* \file  Bsp.c 
* \brief  example 
* 
* \tableofcontents 
* 
* \section sec1 section 1 
* blabla 
* 
* \section sec2 section 2 
* blabla 
* 
* \subsection ssec21 subsection 21 
* blabla 
***********************************/ 



/***********************************//** 
* \brief 
* 
* \section sec1func funcsection 1 
* blabla 
***********************************/ 
void func() 
{ 

} 

這裏是我得到的html:

link to output of example

我該怎麼辦錯了嗎?預先感謝每一個提示!

+1

您期待在哪個頁面上顯示目錄?因爲這樣放置,它會出現在文件Bsp.c的文檔頁面上。 – John

+0

@ John:這正是我想要的:) – Wolfson

回答

2

對於doxygen說documentation說,@tableofcontents只適用於額外的頁面(@page@mainpage),而不是在常規文檔塊。

您仍然可以使用@ref和一些html(儘管它不如使用內置命令)建立自己的目錄。

+0

好的,這就是_This命令只適用於相關頁面文檔而不適用於其他文檔塊......_意味着然後。棒棒的結局是錯誤的。我認爲這意味着我不能包含其他文件中包含的部分和小節(在不同的html頁面上生成)。現在我明白了:)謝謝約翰! – Wolfson

相關問題