Doxygen: включить test.dox в главную страницу.dox добавляет в виде текста

#doxygen #doxywizard

Вопрос:

Я создал документацию Doxygne для проекта на python. Чтобы добавить введение высокого уровня о проекте с архитектурой класса высокого уровня, я создал файл mainpage.dox в следующем формате.

 /* mainpage
# Introduction
Description about the project
# Class Architecture
CLass architecture using plantuml.
# Additional Links
ref addLinks "Additional Links Name"

page addLinks
# Link information

*/

Проблема с размещением всего вышеперечисленного контента на одной главной странице.dox заключается в том, что он слишком длинный и кажется нечитаемым.

На самом деле я хочу разделить все на отдельные дополнительные файлы dox и связать их с файлом mainpage.dox. Например:

Создайте отдельный файл .dox для ознакомления
Создайте отдельный файл .dox для архитектуры класса

И добавьте, затем эти связанные файлы отобразят содержимое файла mainpage.dox, как показано ниже.

 /*! mainpage
# Introduction
include introduction.dox
# Architecture
include architecture.dox
*/

файл introduction.dox содержит: Я не добавил сюда никаких комментариев.

 Introduction
===========
This is an introduction about this project.

К сожалению, добавление файла .dox, как указано выше, добавляет информацию только в текстовом формате. Он не отображает содержимое в формате Doxygen.
Я попытался включить введение.dox и включить { введение.dox} и включить введение.dox также.

Я использую Доксиген 1.8.17. Есть идеи, в чем может быть причина?

Большое спасибо!!

1. Какая версия доксигена? Вы смотрели, например subpage , на, include{doc} , snippet{doc} ?

2. Я использую 1.8.17. Я попробовал подстраничный тест.dox, включить тест.dox и фрагмент теста.dox. И добавил файл test.dox во ВХОД и ПУТЬ к ПРИМЕРУ. Тем не менее, он не распознает докс. файл.

3. Где, например include test.dox , и я думаю, что вы должны использовать includedoc (не уверен, поддерживается ли include{doc} уже в 1.8.17). Получали ли вы какие-либо предупреждения относительно, например EXAMPLE_PATH , или другого пути? что находится в test.dox?

4. Я добавил includedoc test.dox, однако затем он добавляет необработанное содержимое в файл test.dox, не отформатированный. Например, он просто печатает /*!# тест*/. Я не получил никакого предупреждения в пути к примеру.

5. Вы читали документацию об include / includedoc версия для своей версии (я вижу include{doc} поддерживается для 1.8.17) как говорится: «за документацию не должен комментировать знаки в нем, как они будут выглядеть в документацию.». Тот факт, что «Докса» имеет какой-то комментарий знаки, вероятно, из-за того «.файл докс» будет обрабатываться как «.H файл». Вы можете определить его как файл уценки (см. EXTENSION_MAPPING ), поэтому знаки комментариев не требуются. Пожалуйста, уточните свой вопрос с помощью соответствующей информации / кода.

Ответ №1:

При использовании:

главная страница.dox

 mainpage
# Introduction
include{doc} introduction.dox
# Architecture
include{doc} architecture.dox

архитектура.докс

 This is an architecture description

введение.докс

 This is an introduction about this package description

Доксифайл

 INPUT=mainpage.dox
EXTENSION_MAPPING = dox=md
QUIET=YES
EXAMPLE_PATH=.

Я получаю в качестве вывода:

Насколько я понял, это тот тип вывода, который вы хотели бы иметь.