如何关闭Doxygen对typedef struct的自动文档化功能?
解决Doxygen自动生成typedef struct文档的问题
要停用Doxygen自动将头文件中所有typedef struct生成文档并显示在侧边栏“Data structures”中的功能,你需要调整以下配置项:
核心配置项:
EXTRACT_STRUCTS
将该选项从默认的YES修改为NO:EXTRACT_STRUCTS = NO这个设置会让Doxygen完全停止提取任何
struct和typedef struct类型的文档,无论这些结构是否带有文档注释,自然不会在“Data structures”中列出。注意
EXTRACT_ALL的影响
如果你的配置中EXTRACT_ALL = YES,它会强制提取所有元素的文档,此时EXTRACT_STRUCTS的设置会被覆盖。这种情况下,你需要先将EXTRACT_ALL改为NO,再设置EXTRACT_STRUCTS = NO才能生效。可选替代:调整typedef的展示分类
如果你只是不想让typedef struct以结构形式出现在“Data structures”中,而是希望将其作为类型别名显示在“Typedefs”分类下,可以设置:TYPEDEF_HIDES_STRUCT = YES这个选项会让Doxygen将
typedef struct识别为普通typedef,而非单独的结构类型。
内容的提问来源于stack exchange,提问作者Lecram_420
相关产品推荐
相关产品推荐

