lib/curl/Handler: add API documentation

1 files changed, 22 insertions, 0 deletions

diff --git a/src/lib/curl/Handler.hxx b/src/lib/curl/Handler.hxx
index c92f9e9b5..22c1a0db2 100644
--- a/src/lib/curl/Handler.hxx
+++ b/src/lib/curl/Handler.hxx
@@ -36,12 +36,34 @@
 #include <string>
 #include <map>
 
+/**
+ * Asynchronous response handler for a #CurlRequest.
+ *
+ * Its methods must be thread-safe.
+ */
 class CurlResponseHandler {
 public:
+	/**
+	 * Status line and headers have been received.
+	 */
 	virtual void OnHeaders(unsigned status,
 			       std::multimap<std::string, std::string> &&headers) = 0;
+
+	/**
+	 * Response body data has been received.
+	 */
 	virtual void OnData(ConstBuffer<void> data) = 0;
+
+	/**
+	 * The response has ended.  The method is allowed delete the
+	 * #CurlRequest here.
+	 */
 	virtual void OnEnd() = 0;
+
+	/**
+	 * An error has occurred.  The method is allowed delete the
+	 * #CurlRequest here.
+	 */
 	virtual void OnError(std::exception_ptr e) noexcept = 0;
 };