Doxygen @file删除除@brief之外的其他命令格式

时间:2012-04-16 15:55:26

标签: comments doxygen

如果我有一个带有doxygen注释的c头文件:

/*!
*    @file    MyHeaderFile.h
*    @brief   Brief header file description
*    @author  Me Myself
*    @date    2012.4.16
*/  

这导致html像这样:

enter image description here

同样的语法在函数注释中工作正常:

enter image description here

我做错了什么或这是否支持了?

编辑:正常功能评论:

/*!
*    @brief This function does things
*
*    @author Me Myself
*    @date   2012.4.16
*   
*    @returns    void
*/
void MyFunctionThing(void)
{
}

1 个答案:

答案 0 :(得分:0)

虽然我无法真正重现问题,但这很可能是Markdown支持(在1.8.0版本中引入)的结果,特别是code blocks feature。 您可以尝试避免/解决此问题的选项:

  • 在配置文件中将MARKDOWN_SUPPORT设置为NO
  • 使用少于4个空格(*之后)缩进评论栏中的文字。