Как мне задокументировать функцию макроса на C++ с помощью Doxygen и ссылаться на нее в документации моего кода, отличного от Evil?
В частности, у меня есть некоторый обычный класс под названием «Сообщение», определенный в Message.H, от которого пользователи могут наследоваться для определения своих собственных сообщений. В другом файле ("MessageHelpers.H") у меня есть такой сумасшедший макрос:
//! Users must call this macro to register their messages...
/*!
...lest they be forced to type all sorts of boring and
error-prone boiler plate code.
blah blah blah... More specific documentation and explanation...
*/
#define REGISTER_MESSAGE_TYPE(MSGTYPE) \
do_some(MSGTYPE); \
seriously(); \
crazy_stuff(MSGTYPE);
В документации к Message мне бы понравилось, если бы фраза «REGISTER_MESSAGE_TYPE» могла автоматически становиться ссылкой и указывать на мою документацию для макроса. Например.
//! A cool message class
/*!
Users can inherit from this class to create their own cool messages.
Just be sure to call REGISTER_MESSAGE_TYPE after your class definition!
*/
class Message
{
virtual void doSomeStuff();
};
Это возможно?
