Doxygen show 功能简述
Doxygen show brief summary of functions
我正在尝试让 doxygen 在“文件->文件成员->函数”中显示函数的简要摘要
例如:
我想要这个:
Box_The_Function_Name() : doxygen_c.h
看起来像这样
Box_The_Function_Name() : doxygen_c.h : brief explanation
Doxygen 会自动为结构而非函数执行此操作。
有什么想法吗?
Doxygen does this automatically for structs but not functions.
不,不是。 Classes/types 根本没有出现在这个页面上,而是出现在 类 的列表中,这是一个完全不同的页面,具有不同的范例。
在这个页面,列出了函数、变量和定义,翻译单元的性质意味着可以在多个文件中找到相同的名称,例如:
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 试图将每个摘要文本塞入此处的列表,那将不是很用户友好。
所以,不,你不能这样做。
但是,您只需单击文件名即可转到该文件中找到的函数的文档。
我正在尝试让 doxygen 在“文件->文件成员->函数”中显示函数的简要摘要
例如:
我想要这个:
Box_The_Function_Name() : doxygen_c.h
看起来像这样
Box_The_Function_Name() : doxygen_c.h : brief explanation
Doxygen 会自动为结构而非函数执行此操作。
有什么想法吗?
Doxygen does this automatically for structs but not functions.
不,不是。 Classes/types 根本没有出现在这个页面上,而是出现在 类 的列表中,这是一个完全不同的页面,具有不同的范例。
在这个页面,列出了函数、变量和定义,翻译单元的性质意味着可以在多个文件中找到相同的名称,例如:
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 试图将每个摘要文本塞入此处的列表,那将不是很用户友好。
所以,不,你不能这样做。
但是,您只需单击文件名即可转到该文件中找到的函数的文档。