氧气显示功能简要概述

Doxygen show brief summary of functions

本文关键字：显示功能氧气更新时间：2023-10-16

我试图让doxygen在"文件->文件成员->函数"中显示函数的简要摘要

例如：

我想要这个：

Box_The_Function_Name() : doxygen_c.h

看起来像这样

Box_The_Function_Name() : doxygen_c.h : brief explanation

Doxygen会自动对结构体执行此操作，但不对功能执行此操作。

有什么想法吗？

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

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

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

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试图将每个摘要文本塞进这里的列表中，那将不是很用户友好。

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

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