doxygen - 您如何在 Doxygen 中定义主页层次结构？

Question

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

这是上述页面的屏幕截图:

Answer 1

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

索引

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

GENERATE_TREEVIEW      = YES

GENERATE_TREEVIEW 标签的默认值为 NO。

这将使索引出现在左 Pane 中。

目录

右侧 Pane 中的目录可以手动生成，如下所示。

在你的 Markdown 中使用嵌套的缩进的项目符号列表来手动创建一个多级层次结构，并使用@ref(或\ref)命令标记来创建超链接。

这是我自己项目的 doxygen 文档的摘录。我把这个页面放在一个名为“pages.dox”的文档中，并在 Doxyfile 的 INPUT 标签中添加了对“pages.dox”的引用。

/*! @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 呈现，如下面的屏幕截图所示:

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

另见

• Doxygen 的 @ref 命令的在线文档位于 this link .
• Doxygen 的文档ma​​rkdown 支持在 this link .