你如何在 Doxygen 中定义主页层次结构？答案

【问题标题】：How do you define a main page hierarchy in Doxygen?你如何在 Doxygen 中定义主页层次结构？
【发布时间】：2015-11-23 21:19:47
【问题描述】：

在这个 Doxygen 生成的帮助页面 http://api.fluffyunderware.com/curvy/index.html 上，有一个用于主页的分层文档索引和一个目录。如何在我自己的文档中复制此功能？

这是上述页面的截图：

【问题讨论】：

注意，如果我只是创建命名文件，它们会在主页中显示为条目，但我看不到如何在此之下创建层次结构。

标签： doxygen

【解决方案1】：

在链接中的示例网页上，有两个主要窗格：左侧是自动生成的分层索引（Doxygen 称之为“treeview” )，右侧是手动生成的目录。这些是使用不同的方法生产的。

索引

要创建自动生成的分层索引，请编辑您的 Doxyfile，并确保以下标记显示如下：

GENERATE_TREEVIEW      = YES

GENERATE_TREEVIEW 标签的默认值为NO。

这将导致索引出现在左窗格中。

/*! @page users_guide STFishFinder API User's Guide

@par Table of Contents

- @ref users_guide
    - @ref black_box
    - @ref api_overview
    - @ref stfishfinder_api
    - @ref wrappers
        - @ref ios_fishfinder_api
        - The Fish Finder API for Android   <!-- @ref android_fishfinder_api -->
        - The Fish Finder API for CLI       <!-- @ref windows_fishfinder_api -->
        - The Fish Finder API for Linux     <!-- @ref linux_fishfinder_api -->
        - @ref porting
    - @ref how_to
        - @ref how_to_connect
        - Flow of Information Overview      <!-- @ref flow_of_info -->
        - Advanced Gain Settings            <!-- @ref gain_how_to -->
        - How To Use the Depth Alarms       <!-- @ref depth_alarms_how_to -->
        - @ref simulator_how_to
        - Updating the Black Box Firmware   <!-- @ref firmware_update -->
        - @ref best_practices

*/

上面摘录的页面由 Doxygen 渲染，如下图所示：

请注意，我的目录中的某些条目不是链接（例如“Android 的 Fish Finder API”）。这是因为我的 API 文档还没有完成，所以我为尚未编写的页面创建了“占位符”。我使用 HTML 样式的注释标签注释掉了这些的 @ref 链接。

另请参阅

Doxygen 的@ref 命令的在线文档位于this link。
Doxygen 的文档 markdown 支持在 this link。

【讨论】：

"在 Doxyfile 的 INPUT 标记中添加了对 "pages.dox" 的引用。"。你是怎么做到的？
添加[TOC]好像可以生成当前页面的目录。