Doxygen：组模块和页面？ [英] Doxygen: Group modules and pages?

问题描述

我有一个有关doxygen的页面和组的问题。
我有一个项目，我在那里我分组了类别等与 @defgroup 和 @ingroup cmds。到目前为止这个工作正常。

现在我想使用markdown页面为项目添加特殊文档。这些页面应显示在专用模块（组）中。我尝试使用 @page 和 @subpage cmds创建页面。这很好，但这些页面在菜单中显得很简单。

所以我试图将它们添加到具有 @ingroup 的组。但是，我没有按照我的猜测工作。
是否可以向模块（组）添加页面？

结果应如下所示：

项目

| - 模块

| | - Module1

| | | - 文档页面1（来自* .md文件）

| | | - 类文件

| | - Module2

| | | - 文档页2

| | | - 类文档

希望你能帮助我！

解决方案

p>要分组页面，您需要使用子页面功能，不需要该组。

因此，为引用这两个子页面和模块组的每个组创建一个页面。 p>

  / *！ \page group1page我的组的文档页面
此页面包含有关组1的信息\ref group1_label 
 \subpage group1page2 
 \subpage group1page3 
 * / 
  

http://www.stack.nl/~dimitri/doxygen/manual/grouping.html#subpaging
http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdsubpage

I have a question about pages and groups in doxygen. I have a project, where I grouped classes etc. with the @defgroup and @ingroup cmds. So far this works fine.

Now I'd like to add special documentation to the project with markdown pages. These pages should appear in the dedicated module (group). I tried to create pages with the @page and @subpage cmds. That works fine, but the pages appear plain in the menu.

So I tried to add them to the groups with @ingroup. But that doesn't work as I guessed. Is it possible to add pages to modules (groups)?

The result should look like this:

Project
|-- Modules
| |-- "Module1"
| | |-- documentation page1 (from *.md file)
| | |-- class documentation
| |-- "Module2"
| | |-- documentation page2
| | |-- class documentation

I hope you can help me!

解决方案

To group pages you need to use the subpage functionality, no the group.

So create a page for each group that references both subpages and the module group.

/*! \page group1page A documentation page for my group
This page contains the info about group 1 \ref group1_label
\subpage group1page2
\subpage group1page3
*/

http://www.stack.nl/~dimitri/doxygen/manual/grouping.html#subpaging http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdsubpage

这篇关于Doxygen：组模块和页面？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！