Есть ли способ, как отличить группы в enum, используя doxygen?

Я хотел бы прокомментировать большой enum и сгруппировать некоторые элементы enum (которые следуют друг за другом)

Представьте enum вот так:

/** @brief device OpCodes
 */
typedef enum opCodes_e {
    A = 0, ///< init
/** @addtogroup bluetooth commands group
 *  @{
 */
    B0 = 1, ///< BLE connect
    B1 = 2, ///< BLE disconnect
/** @} */
    C = 3  ///< handle pressure sensor
} t_opCodes;

и я хочу:

  1. результат в одной таблице.
  2. есть также название группы
  3. визуально отображать, какие элементы перечисления находятся в группе

Например, результат может выглядеть примерно так:

device OpCodes
A        init
---------------------------
bluetooth commands group
  B0     BLE connect
  B1     BLE disconnect
---------------------------
C        handle pressure sensor

Я не желаю какой-либо конкретной точки зрения. Выше просто иллюстрация того, что я хочу. Вы знаете, возможно ли что-то подобное в doxygen? Если так, то как?

1 ответ

Немного сложнее, чтобы заставить его работать, и это решение только для вывода HTML

/** @brief device OpCodes
 */
typedef enum opCodes_e {

A = 0, /**< inlet2 */
/**< @htmlonly <tr><td colspan=2 align=center class="fieldname"><b>BlueTooth</b></td></tr> @endhtmlonly */
B0 = 1, ///< BLE connect2
B1 = 2, ///< BLE disconnect2
C = 3  ///< handle pressure sensor
} t_opCodes;

Примечание: заголовок A должен находиться в /** ..*. в противном случае появляется лишняя пустая строка.

Другие вопросы по тегам