我遇到一个问题,doxygen会从配置中包含的头文件中自动记录所有typedef结构体。它们在侧边栏的HTML文档中被列为“数据结构”。需要哪个选项来停用结构体的自动记录?谢谢!
vuktfyat1#
因为你的结构定义在头文件中,除非你在相关的C文件中定义你的结构,否则doxygen会自动记录它;在这种情况下,它将是私有的,并且可以通过将以下选项设置为NO来阻止输出:
NO
EXTRACT_ALL
EXTRACT_PRIVATE
EXTRACT_STATIC
但是,由于定义位于头文件中,您可以通过将EXCLUDE_SYMBOLS设置为结构体符号/定义名来隐藏它,或者作为EXCLUDE_SYMBOLS选项的替代选项,您可以在源代码中的结构体类型的注解部分使用hideinitializer命令。
EXCLUDE_SYMBOLS
hideinitializer
1条答案
按热度按时间vuktfyat1#
因为你的结构定义在头文件中,除非你在相关的C文件中定义你的结构,否则doxygen会自动记录它;在这种情况下,它将是私有的,并且可以通过将以下选项设置为
NO
来阻止输出:EXTRACT_ALL
EXTRACT_PRIVATE
EXTRACT_STATIC
但是,由于定义位于头文件中,您可以通过将
EXCLUDE_SYMBOLS
设置为结构体符号/定义名来隐藏它,或者作为EXCLUDE_SYMBOLS
选项的替代选项,您可以在源代码中的结构体类型的注解部分使用hideinitializer
命令。