Doxygen 组警告:组内文件结束
Doxygen group warning: end of file inside a group
我正在尝试在以 @{
结尾的 C 头文件中使用 doxygen(v1.8.9.1) @defgroup
注释,如下所示:
/** @file foo.h
* @brief This is a foo file
*/
#ifndef FOO_H_
#define FOO_H_
#include somebar.h
/** @defgroup foo Foo
* @details This foo file does foo stuff
* @{
*/
#ifdef __cpluplus
extern "C" {
#endif
/* foo declarations here with standard doxygen documentation */
#ifdef __cpluplus
}
#endif
/** @} */
#endif
这与 doxygen-Grouping-Modules 中的示例用法相匹配,但是,当我构建它时,这会在文件 warning: end of file while inside a group
.
的末尾给出错误
然而,如果开头 @{
位于单独的 doxygen 注释中,则一切正常:
/** @defgroup foo Foo
* @details This foo file does foo stuff
*/
/** @{ */
这是一个错误还是我做错了什么?
在我尝试使用两种不同方式打开群组的地方,我将旧的群组打开方式留在了非文档注释中,doxygen 显然仍将其视为文档注释。这意味着 doxygen 认为我正在打开 两个 组并且只关闭其中一个!
例如
/** @defgroup foo Foo
* @details This foo file does foo stuff
* @{
*/
/* @{ */ // Note, only a single leading star so should not be treated as doxygen comment, yet it is.
/* Some code and documentation that is in a group here. */
/**@} */ // Close one group here but the second, unasked-for, group is not closed yet.
/* EOF */
我正在尝试在以 @{
结尾的 C 头文件中使用 doxygen(v1.8.9.1) @defgroup
注释,如下所示:
/** @file foo.h
* @brief This is a foo file
*/
#ifndef FOO_H_
#define FOO_H_
#include somebar.h
/** @defgroup foo Foo
* @details This foo file does foo stuff
* @{
*/
#ifdef __cpluplus
extern "C" {
#endif
/* foo declarations here with standard doxygen documentation */
#ifdef __cpluplus
}
#endif
/** @} */
#endif
这与 doxygen-Grouping-Modules 中的示例用法相匹配,但是,当我构建它时,这会在文件 warning: end of file while inside a group
.
然而,如果开头 @{
位于单独的 doxygen 注释中,则一切正常:
/** @defgroup foo Foo
* @details This foo file does foo stuff
*/
/** @{ */
这是一个错误还是我做错了什么?
在我尝试使用两种不同方式打开群组的地方,我将旧的群组打开方式留在了非文档注释中,doxygen 显然仍将其视为文档注释。这意味着 doxygen 认为我正在打开 两个 组并且只关闭其中一个!
例如
/** @defgroup foo Foo
* @details This foo file does foo stuff
* @{
*/
/* @{ */ // Note, only a single leading star so should not be treated as doxygen comment, yet it is.
/* Some code and documentation that is in a group here. */
/**@} */ // Close one group here but the second, unasked-for, group is not closed yet.
/* EOF */