c - doxygen 主页面上的函数列表

标签 c documentation doxygen

我确定已经有人问过这个问题,但我似乎找不到,所以就在这里。

我正在用 C 创建一个程序并使用 Doxygen 生成文档。我对结果很满意,但是主页没有内容。我想用程序中按字母顺序排列的所有函数和结构的列表填充主页。

我对 Doxygen 知之甚少,除了我曾经使用过的简单教程。这似乎是 Doxygen 能够完成的任务,但到目前为止,我所找到的只是有关如何创建自定义主页的说明。

是否可以使用Doxygen在主页上自动生成函数和结构列表?

最佳答案

从配置的角度来看,Doxygen 并没有真正提供很多东西。您可以与 Doxygendoxyrest 一起使用名为 Sphinx 的工具。

基本上,您将能够使用 Doxygen 生成 XMLDoxyrest 将把 XML 输出转换为 .rst 文件,而 Sphinx 将处理最终结果(它只处理 .rst,这就是为什么你需要使用像 doxyrest 这样的中间工具。

Sphinx 将生成漂亮的 HTML 页面,这些页面易于阅读,更重要的是,易于配置。

有关如何组合这三个工具并一起使用它们的信息,请参见此页面:https://vovkos.github.io/doxyrest/manual/basic.html

您的问题的解决方案是使用 \addtogroup Doxygen 命令对您的函数进行分组(将所有函数添加到同一组),然后使用 Sphinx,选择新创建的组页面以成为您的索引/着陆页。这可以通过编辑 Sphinx 的 conf.py 中的一些行来完成。

关于c - doxygen 主页面上的函数列表,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/30636845/

相关文章:

c - FFmpeg:使用自定义上下文打开视频时未指定像素格式

c - 将简单的算牌功能重构为多种功能?

c - 是否可以使用仅在运行时知道参数数量和类型的函数指针来调用函数

Ruby 如何从自定义对象文档创建范围?

java - 离线 Java 文档

c++ - Doxygen - 没有命名空间中函数的详细描述

c - 如何计算 --/++ 的值

command-line - 终端命令中的 "See something(3) or see something-else(5), etc..."是什么意思?

c++ - Doxygen 似乎无法识别评论 (Doxywizard)

windows - 使用 Windows 任务计划程序启动时 Doxygen 未运行