gpt4 book ai didi

C 和 doxygen - 删除变量文档的重复项

转载 作者:行者123 更新时间:2023-12-02 01:42:14 25 4
gpt4 key购买 nike

我正在使用 doxygen 记录我的 C 代码。为了更好的可读性,我将每个 .c/.h 文件对(有时还有更多文件)的文档与 defgroupaddtogroup 分组(参见 doxygen in c: grouping of defines )。文件页面看起来不错,但在组/模块页面上,所有变量文档都加倍了。在头文件中声明(使用 extern)并在 .c 文件中(在摘要和描述部分)定义的每个变量都有 2 个条目。功能和其他一切都只列出一次......

如何去除组/模块页面上重复的变量文档?

我的源文件如下所示:.h 文件:

/** @file
* blabla
* @author bla
*/
/// @addtogroup MY_GRP
/// @{
#define SOMEDEF1 1
/// @name Special defs
/// @{
#define SOMEDEF2 2
/// @}
enum someenum {
foo,
bar
};

extern int some_variables;

extern void some_proc(int baz);

/// @}

.c文件:

/** @file
* blabla
* @author bla
*/
/** @defgroup MY_GRP A test group.
* Description
*/
/// @{
#include "my.h"

/// Important variable.
int some_variable;

/** Important proc
* Description
* @param baz need this
*/
void some_proc(int baz) {
// code
}

/// @}

最佳答案

无法真正解决问题,但找到了一个解决方法:我将 INPUT_FILTER 选项与 grep -Eve "extern" (cygwin) 一起使用,以筛选出所有带有“extern”函数或变量声明的行。因为我只记录实际的函数实现和变量定义,所以前面带有“extern”的所有内容都没有文档,可以为 doxygen 删除。这确实也删除了 doxygen 输出中变量的所有重复条目。

关于C 和 doxygen - 删除变量文档的重复项,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/27845542/

25 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com