Doxygen: \include test.dox in mainpage.dox 添加为文本
Doxygen: \include test.dox in mainpage.dox adds as a text
我为 python 项目创建了 Doxygne 文档。为了添加关于具有高级 class 架构的项目的高级介绍,我创建了一个具有以下格式的 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 文件中,并且 link 它来自 mainpage.dox 文件。例如:
为简介创建一个单独的 .dox 文件
为 Class 架构创建一个单独的 .dox 文件
然后添加这些 linked 文件将显示 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。
知道可能是什么原因吗?
非常感谢!!
使用时:
mainpage.dox
\mainpage
# Introduction
\include{doc} introduction.dox
# Architecture
\include{doc} architecture.dox
architecture.dox
This is an architecture description
introduction.dox
This is an introduction about this package description
Doxyfile
INPUT=mainpage.dox
EXTENSION_MAPPING = dox=md
QUIET=YES
EXAMPLE_PATH=.
我得到输出:
据我了解,这就是您想要的输出类型。
我为 python 项目创建了 Doxygne 文档。为了添加关于具有高级 class 架构的项目的高级介绍,我创建了一个具有以下格式的 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 文件中,并且 link 它来自 mainpage.dox 文件。例如:
为简介创建一个单独的 .dox 文件
为 Class 架构创建一个单独的 .dox 文件
然后添加这些 linked 文件将显示 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。 知道可能是什么原因吗?
非常感谢!!
使用时:
mainpage.dox
\mainpage
# Introduction
\include{doc} introduction.dox
# Architecture
\include{doc} architecture.dox
architecture.dox
This is an architecture description
introduction.dox
This is an introduction about this package description
Doxyfile
INPUT=mainpage.dox
EXTENSION_MAPPING = dox=md
QUIET=YES
EXAMPLE_PATH=.
我得到输出:
据我了解,这就是您想要的输出类型。