Как документировать функцию, которая принимает обратный вызов?

Question

Я пишу асинхронную библиотеку, и некоторые из моих методов принимают обратные вызовы в качестве параметров:

/// \brief Opens a connection to the remote server defined by the parameters passed in the constructor.
/// \param[in] callback Callback passed when the connection is estabelished or fails.
/// \return Any errors encountered by the library or the OS.
virtual connect(std::function<void(std::error_code ec)> callback) noexcept = 0;

Как можно документировать параметры обратного вызова в Doxygen?

Answer 1

Вы хотите, чтобы способ документировал сам функтор во вложенном виде (функция в параметре функции), но Doxygen не поддерживает этот AFAIK.Вы можете сделать это вручную с помощью \parblock и некоторых Doxygen Markdown .Другим ручным способом было бы переместить определение обратного вызова в typedef и задокументировать его там с помощью \typedef, что снова потребует ручного усилия, так как Doxygen не поддерживает функторы таким образом.