Руководство пользователя с Doxygen

Я пытаюсь написать руководство пользователя / учебник для своей библиотеки, используя doxygen (что-то похожее на руководство пользователя самого doxygen! - ссылка)

Я использовал .md файлы подстраницы ed из mainpage, чтобы создать свою иерархию документов. У меня получилось нечто похожее на OpenCV (ссылка), который выглядит неплохо, но все еще не имеет многих функций, которые есть в руководстве пользователя doxygen. Например, индекс страниц / разделов слева и постраничная таблица содержания справа.

Есть ли способ создать расширяемый индекс / таблицу содержания и прикрепить его к каждой странице с помощью doxygen (как в ссылка)? Есть ли что-нибудь лучше? Есть еще советы?


person krips89    schedule 24.09.2015    source источник
comment
Я думаю, вы можете научиться использовать режим emacs org. В нем действительно есть все, чего вы можете пожелать, и даже больше. Объедините его с draw.io для диаграмм, экспортируйте org в html и wkhtmltopdf в pdf, и вот он. youtu.be/VjMp_B1V4bI   -  person Martin    schedule 08.05.2019


Ответы (1)


Установка флага GENERATE_TREEVIEW на YES в вашем Doxyfile заставит Doxygen создать боковую панель.

Пример:

GENERATE_TREEVIEW = YES

Эта функция требует, чтобы браузеры поддерживали JavaScript, DHTML, CSS и фреймы.

person Chris Thain    schedule 24.09.2015
comment
О, это так просто и так точно ... Спасибо, я плачу от счастья! - person krips89; 24.09.2015