Doxygen: Как правильно задокументировать переменную члена структуры C с пределом в 80 символов?

Question

Существует ли правильный / рекомендуемый способ добавления короткого комментария Doxygen к переменной C struct, когда вы пытаетесь соблюдать ограничение ширины в 80 символов?

Например:

// MyStruct.h

#ifndef MY_H
#define MY_H

typedef struct MyStruct
{
  struct in
  {
    int i_;                             ///< A number
    MQTTAsync_connectionLost connLost_; ///< Callback invoked upon loss of
                                        ///< connection
    char c_;                            ///< A letter
  } in_;
} MyStruct;

#endif

Сказанное выше не является правильным способом документировать connLost_ при соблюдении ограничения ширины в 80 символов: в конечном итоге генерируется описание connLost в подразделе «Полевая документация», а не вместе спеременные члена одноранговой сети.

#ifndef MY_H
#define MY_H

typedef struct MyStruct
{
  struct in
  {
    int i_;                             ///< A number
    MQTTAsync_connectionLost connLost_; ///< Callback invoked upon loss of \
                                             connection
    char c_;                            ///< A letter
  } in_;
} MyStruct;

#endif

Это неверно по-другому: хотя connLost_ задокументировано вместе с его одноранговыми узлами, слово "соединение" (все после обратной косой черты) исключено из документации.

#ifndef MY_H
#define MY_H

typedef struct MyStruct
{
  struct in
  {
    int i_;                             ///< A number
    /** Callback invoked upon loss of connection */
    MQTTAsync_connectionLost connLost_;
    char c_;                            ///< A letter
  } in_;
} MyStruct;

#endif

Это не то, что мне нужно: документация connLost_ восходит к разделу «Полевая документация», а не к его аналогам.

Наглядно, что бы яхотел бы достичь "родным по-кислородному" образом:

Answer 1

То, что вы сделали во втором примере, в порядке. Вы просто должны включить \brief!

#ifndef MY_H
#define MY_H

typedef struct MyStruct
{
  struct in
  {
    int i_;                             ///< A number
    // NOTE THE BRIEF HERE
    /** \brief Callback invoked upon loss of connection */
    MQTTAsync_connectionLost connLost_;
    char c_;                            ///< A letter
  } in_;
} MyStruct;
#endif