代码之家  ›  专栏  ›  技术社区  ›  tomlogic

记录结构成员的宏(使用doxygen)

  •  2
  • tomlogic  · 技术社区  · 14 年前

    typedef struct foo_t {
        uint16_t flags;
            #define FOO_FLAG_BELL       0x0001
            #define FOO_FLAG_BOOK       0x0002
            #define FOO_FLAG_CANDLE     0x0004
            #define FOO_FLAG_LANTERN    0x0008
    }
    

    Doxygen希望在顶部列出这些宏,以及所有其他宏。我已经利用了分组标签( //@{ //@} foo_t.flags ,但我想找到一种更紧密地将这些值与结构联系起来的方法。我应该用吗 \link \endlink

    1 回复  |  直到 14 年前
        1
  •  5
  •   Patrick Schlüter    14 年前

    使用枚举。

    typedef struct foo_t {
      enum flag_define { 
        FOO_FLAG_BELL    =  0x0001,    /**< The flag for the bell or whatever. */
        FOO_FLAG_BOOK    =  0x0002,
        FOO_FLAG_CANDLE  =  0x0004,
        FOO_FLAG_LANTERN =  0x0008,
      } flags:16;                      /**< My flag thing */
    }  foo_t;