生成的 Doxygen 文档中缺少 Javadoc 样式注释
Missing Javadoc style comments in generated Doxygen documentation
我正在努力让我的代码注释出现在 Doxygen 生成的文档中。我一直在使用 Doxygen 向导和 C 语言。这是一个示例评论:
/**
* Takes string formatted plugin information and processes it.
* @param id_orig a constant
* @param group_orig a constant
* @see get_or_add_info(...)
* @return SUCCESS and FAILURE macros.
*/
static RETCODE import_process_element(...) { ...}
开场评论如期出现。这是文件开头的 header 注释:
/**
* @file
* @brief A super great file.
* @author Tinus Lorvolds
*/
JAVA_AUTOBRIEF
开启。 Windows 7 上的 Doxyfile 版本 1.8.14,带有 C 源文件。我确信这很简单,但我已经坚持了很长一段时间。感谢您的帮助和耐心等待。
这是我的配置与标准配置之间的相关差异:
OPTIMIZE_OUTPUT_FOR_C = YES
JAVADOC_AUTOBRIEF = YES
EXTRACT_STATIC = YES
RECURSIVE = YES
解决方法如下。
问题出在来源本身。预处理器指令对 Doxygen 隐藏了源代码。如果上面列出的设置都设置正确,请尝试禁用此功能:
ENABLE_PREPROCESSING = NO
我正在努力让我的代码注释出现在 Doxygen 生成的文档中。我一直在使用 Doxygen 向导和 C 语言。这是一个示例评论:
/**
* Takes string formatted plugin information and processes it.
* @param id_orig a constant
* @param group_orig a constant
* @see get_or_add_info(...)
* @return SUCCESS and FAILURE macros.
*/
static RETCODE import_process_element(...) { ...}
开场评论如期出现。这是文件开头的 header 注释:
/**
* @file
* @brief A super great file.
* @author Tinus Lorvolds
*/
JAVA_AUTOBRIEF
开启。 Windows 7 上的 Doxyfile 版本 1.8.14,带有 C 源文件。我确信这很简单,但我已经坚持了很长一段时间。感谢您的帮助和耐心等待。
这是我的配置与标准配置之间的相关差异:
OPTIMIZE_OUTPUT_FOR_C = YES
JAVADOC_AUTOBRIEF = YES
EXTRACT_STATIC = YES
RECURSIVE = YES
解决方法如下。
问题出在来源本身。预处理器指令对 Doxygen 隐藏了源代码。如果上面列出的设置都设置正确,请尝试禁用此功能:
ENABLE_PREPROCESSING = NO