如果宏或枚举没有记录,强制Doxygen(C)发出警告

时间:2016-07-19 07:33:02

标签: c doxygen

是否有任何doxygen选项可确保Doxygen检查是否记录了所有枚举(和枚举成员)和宏?

我已启动并运行doxygen( v1.8.11 ),但它只会针对缺少的功能文档发出警告。

编辑:我添加了一些源代码,以根据请求显示我的意思。由于Doxyfile很长,我使用pastebin添加它。我还必须编辑一些细节,但主要问题仍然存在。

我想Doxygen告诉我

  1. 未记录enum charger_connection_state_t
  2. 同一个枚举的成员未记录
  3. 顶部的定义应全部记录在案
  4. 如果我从函数调用中删除文档,Doxygen会抱怨一个未记录的函数,所以一般配置至少看起来不错。
  5. 我记得为未记录的枚举成员标记错误,但我不确定我是否记得正确。

    为了说清楚,所有这些实际上也在模块之外使用。

    #ifndef BATTERY_INDICATOR_H_
    #define BATTERY_INDICATOR_H_
    
    #define BATTERY_INDICATOR_BATTERY_LEVEL_EMPTY           15
    #define BATTERY_INDICATOR_BATTERY_LEVEL_LOW             20
    #define BATTERY_INDICATOR_BATTERY_LEVEL_MEDIUM          59
    #define BATTERY_INDICATOR_BATTERY_LEVEL_MEDIUM_HIGH     79
    #define BATTERY_INDICATOR_BATTERY_LEVEL_FULL            95  //!< Everything above 95 [%] will be indicated as fully charged
    
    typedef enum {
        NO_CHARGER,
        CHARGER_CONNECTED
    } charger_connection_state_t;
    
    
    //! This function drives the state machine
    void battery_indicator_sm_run(void);
    
    #endif /* BATTERY_INDICATOR_H_ */enter code here
    

    的Doxyfile http://pastebin.com/0GLzHkp3

0 个答案:

没有答案