Doxygen显示功能的简要概述

时间:2017-07-13 16:03:02

标签: c++ doxygen

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

例如:

我想要这个:

Box_The_Function_Name() : doxygen_c.h

看起来像这样

Box_The_Function_Name() : doxygen_c.h : brief explanation

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

有什么想法吗?

1 个答案:

答案 0 :(得分:1)

  

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试图将每个摘要文本填入这里的列表中,那将不是非常用户友好。

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

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