Используйте 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...
 */

Какой тег использовать вместо of @ ??? , чтобы получить правильный вывод doxygen (где «правильный» означает сгенерированный вывод для mystruct и foreignstruct одинаковы)?

12
задан Ben 26 August 2011 в 01:30
поделиться