Doxygen以不同于其他文件的方式处理main.c.

时间:2015-10-06 13:33:07

标签: c doxygen

我的main.c中的标题注释没有被doxygen处理,但是如果我将文件从main.c重命名为例如mainn.c,它的效果非常好。

为什么main.c与其他文件名的处理方式不同? 如何将Doxygen管理main.c作为其他.c文件?

或者,这里的最佳做法是什么?我在Main.c中的目的是在标题文档中添加一个简短的(可能不是那么简短的)产品描述和用例。

头文件以这样的方式开始:

/**********************************************************//**
* @file    main.c
* @author  Somebody
* @brief   Main function and support functions.
* @details 

然后继续我要记录的应用程序级别的事情。 Doxygen配置是安装时的默认配置,除了一些项目,例如针对C优化,包括呼叫图表等......

谢谢..

2 个答案:

答案 0 :(得分:0)

如果你没有看到你是如何试图记录它的话有点难以辨别...但是请确保你在main.c文件中有一行读取

/*! file */

/** @file */

(Doxygen默认不记录全局对象)

答案 1 :(得分:0)

稍微捣乱一下就是解决方案。 (正如MPI_What提出的那样。

如我的问题所述

/**********************************************************//**
 * @file    main.c
 * @author  Somebody
 * @brief   Main function and support functions.
 * @details

适用于除main.c之外的所有文件(当然@file main.c行与其他文件不同。但是以下适用于main.c:

/**********************************************************//**
 * @file    
 * @author  Somebody
 * @brief   Main function and support functions.
 * @details

为什么它起作用是一个谜,但确实如此。 谢谢,阿德里安