0

我为一个 python 项目创建了一个 Doxygne 文档。为了添加有关具有高级类体系结构的项目的高级介绍,我创建了一个 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

*/

将上述所有内容放在一个 mainpage.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 格式的方式显示内容。我也试过 \include Introduction.dox 和 \include { Introduction.dox} 和 \includedoc Introduction.dox 。

我正在使用 Doxygen 1.8.17。知道可能是什么原因吗?

非常感谢!!

4

1 回答 1

1

使用时:

主页.dox

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

架构.dox

This is an architecture description

介绍.dox

This is an introduction about this package description

多西文件

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

我得到输出:

在此处输入图像描述

据我了解,这是您想要的输出类型。

于 2021-08-16T15:58:48.817 回答