Я использую 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
- один и тот же)?