c++ - Doxygen show 功能简述

Question

我正在尝试让 doxygen 在 `Files->File Members->Functions' 中显示函数的简短摘要

例如:

我想要这个:

Box_The_Function_Name() : doxygen_c.h

看起来像这样

Box_The_Function_Name() : doxygen_c.h : 简要说明

Doxygen 会自动为结构而不是函数执行此操作。

有什么想法吗？

Answer 1

Doxygen does this automatically for structs but not functions.

不，它没有。类/类型根本不在此页面上表示，而是在类列表中表示，这是一个具有不同范例的完全不同的页面。

在 this 页面上，列出了函数、变量和定义，翻译单元的性质意味着可以在多个文件中找到相同的名称，例如:

Box_The_Function_Name() : A.h , B.h, C.h

这是我的商业项目中的一个真实示例(不要告诉任何人):

parse_options() : debug-register-reader.cpp , main.cpp , metrics-converter.cpp , debug-register-writer.cpp

每个文件中的函数parse_options() 是不同的，并且可能有不同的摘要文本。如果 Doxygen 试图将每个摘要文本塞入此处的列表，这将不是非常用户友好。

所以，不，你不能这样做。

但是，您只需单击文件名即可转到该文件中找到的函数的文档。