2015-04-29 2 views
1

У меня есть C-проект, документированный с помощью doxygen, и вы хотите добавить оглавление, которое показывает разделы и подразделы. Я попробовал \tableofcontents и [TOC], как описано в руководстве doxygen, но ничего не происходит. Вот небольшой пример:Как добавить оглавление в файл html, созданный doxygen?

/***********************************//** 
* \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

documentation для Doxygen говорит, что @tableofcontents работает только на дополнительных страницах (@page, @mainpage), а не в обычных блоках документации.

Вы все еще можете создать собственное оглавление, используя @ref и немного html (хотя это не так хорошо, как использование встроенной команды).

+0

ОК, вот что. Эта команда работает только в связанной документации по страницам, а не в других блоках документации ... означает тогда. У меня неправильный конец палки. Я думал, что это означает, что я не могу включать разделы и подразделы, содержащиеся в других файлах (которые генерируются на разных html-страницах). Теперь я понимаю :) Спасибо, Джон! – Wolfson

Смежные вопросы