Doxygen: настройка примеров Page

Question

При документировании проекта с Doxygen я столкнулся со следующей проблемой.

У меня есть набор примеров программ (demo_1.c, demo_2.c, ...), размещающихся внутри EXAMPLE_PATH множества в Doxyfile. Я создал файл examples.c со следующим содержимым включать примеры:

/** 
* \example demo_1.c 
* \example demo_2.c 
* ... 
*/ 

После запуска Doxygen, страница с Примеры создается в навигации, как я хочу, но в разделе Примеры всегда выглядит:

Examples 
-------- 
Here is a list of all examples: 
* demo_1.c 
* demo_2.c 

Как я могу изменить эту страницу? Я особенно хочу заменить текст «Вот список всех примеров:» с большим введением.

Я уже сгенерировал файл макета doxygen и файлы заголовка/нижнего колонтитула, но это не дает мне никакой полезной информации.

Answer 1

Решение состоит в том, чтобы создать файл DoxygenLayout.xml и настроить его с информацией, которую вы хотите отобразить на странице примеров.

Doxygen произведут шаблон XML-файл в текущем каталоге, из конфигурации она использует в настоящее время с помощью следующей командной строки:

$ doxygen -l 

Точка Doxygen к этому файлу путем редактирования файла Doxyfile конфигурации или с помощью графический интерфейс Doxywizard (вкладка Expert -> Build -> LAYOUT_FILE), чтобы изменить путь LAYOUT_FILE к вашему новому файлу DoxygenLayout.xml.

Я рекомендую сделать этот шаг явно, вместо того, чтобы полагаться на поведение по умолчанию, чтобы выбрать DoxygenLayout.xml, когда он существует в папке, с которой выполняется Doxygen.

Вам нужно будет отредактировать тег XML <tab type="examples"> и изменить существующий атрибут title и добавить атрибут intro в соответствии с вашими потребностями. Атрибут title изменяет имя заголовка на странице и имя TAB в верхней части HTML-браузера, поэтому лучше чем-то короче.

Например:

<tab type="examples" visible="yes" title="ALI Library Examples" intro="Welcome to the fantastic set of examples I have prepared for your enjoyment."/> 

Производит:

ALI Библиотека Примеры

Добро пожаловать в фантастический набор примеров, которые я приготовил для вашего удовольствия.

• CSV-simple.tcl

Обратите внимание, что я не мог найти какую-либо информацию о атрибуте intro в официальной документации Doxygen. Я заметил это, читая статью Adding new user Tab in the Doxygen Layout.