Подтвердить что ты не робот

Использовать doxygen для документирования элементов структуры c вне определения структуры

Я использую doxygen, чтобы прокомментировать мой C-код. Я использую внешний API (т.е. Не свой), для которого недостаточно документации, поэтому я намерен документировать некоторые из этих API в своих собственных исходных файлах. У меня есть файл заголовка для внешнего API, но нецелесообразно добавлять мои собственные комментарии к этому файлу.

Внешний заголовок

struct foreignstruct
{
    int a;
    int b;
};

Мой заголовок

/** My structure comments...
struct mystruct
{
    /** Describe field here... */
    int field;
};

/** @struct foreignstruct
 *  @brief This structure blah blah blah...
 *  @??? a Member 'a' contains...
 *  @??? b Member 'b' contains...
 */

Какой тег я использую вместо @??? для получения правильного вывода doxygen (где "правильный" означает, что сгенерированный вывод для mystruct и foreignstruct - один и тот же)?

4b9b3361

Ответ 1

Возможно, в один прекрасный день у doxygen будет специальный тег @field для этого, до этого времени можно использовать следующее:

/** @struct foreignstruct
 *  @brief This structure blah blah blah...
 *  @var foreignstruct::a 
 *  Member 'a' contains...
 *  @var foreignstruct::b 
 *  Member 'b' contains...
 */

Это короткая нотация для

/** @struct foreignstruct
 *  @brief This structure blah blah blah...
 */
/** @var foreignstruct::a 
 *  Member 'a' contains...
 */
/** @var foreignstruct::b 
 *  Member 'b' contains...
 */