【问题标题】:Doxygen treats main.c differently from other filesDoxygen 将 main.c 与其他文件区别对待
【发布时间】:2015-10-06 13:33:06
【问题描述】:

我的 main.c 中的标头 cmets 没有被 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 优化,包括调用图表等...

谢谢..

【问题讨论】:

标签: c doxygen


【解决方案1】:

如果不查看您是如何尝试记录的,这有点难以判断...但请确保您在 main.c 文件中有一行读取

/*! file */

/** @file */

(默认情况下,Doxygen 不记录全局对象)

【讨论】:

    【解决方案2】:

    在这里解决了一点问题。 (由 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
    

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

    【讨论】:

      猜你喜欢
      • 2013-10-28
      • 2015-01-13
      • 1970-01-01
      • 2013-06-09
      • 2020-12-15
      • 2011-03-01
      • 1970-01-01
      • 2017-04-27
      • 2021-05-12
      相关资源
      最近更新 更多