如何记录需要回调的函数？

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不以这种方式支持函子，因此这又需要手动进行。