Index: src/OFHTTPClient.h ================================================================== --- src/OFHTTPClient.h +++ src/OFHTTPClient.h @@ -35,11 +35,12 @@ * * @brief A delegate for OFHTTPClient. */ @protocol OFHTTPClientDelegate /** - * @brief A callback which is called when an OFHTTPClient performed a request. + * @brief A callback which is called when an @ref OFHTTPClient performed a + * request. * * @param client The OFHTTPClient which performed the request * @param request The request the OFHTTPClient performed * @param response The response to the request performed, or nil on error * @param exception An exception if the request failed, or nil on success @@ -49,11 +50,12 @@ response: (nullable OFHTTPResponse *)response exception: (nullable id)exception; @optional /** - * @brief A callback which is called when an OFHTTPClient creates a TCP socket. + * @brief A callback which is called when an @ref OFHTTPClient creates a TCP + * socket. * * This can be used to tell the socket about a SOCKS5 proxy it should use for * this connection. * * @param client The OFHTTPClient that created a TCP socket @@ -63,11 +65,12 @@ - (void)client: (OFHTTPClient *)client didCreateTCPSocket: (OFTCPSocket *)TCPSocket request: (OFHTTPRequest *)request; /** - * @brief A callback which is called when an OFHTTPClient creates a TLS stream. + * @brief A callback which is called when an @ref OFHTTPClient creates a TLS + * stream. * * This can be used to tell the TLS stream about a client certificate it should * use before performing the TLS handshake. * * @param client The OFHTTPClient that created a TLS stream @@ -77,12 +80,12 @@ - (void)client: (OFHTTPClient *)client didCreateTLSStream: (OFTLSStream *)TLSStream request: (OFHTTPRequest *)request; /** - * @brief A callback which is called when an OFHTTPClient wants to send the - * body for a request. + * @brief A callback which is called when an @ref OFHTTPClient wants to send + * the body for a request. * * @param client The OFHTTPClient that wants to send the body * @param requestBody A stream into which the body of the request should be * written * @param request The request for which the OFHTTPClient wants to send the body @@ -90,11 +93,11 @@ - (void)client: (OFHTTPClient *)client wantsRequestBody: (OFStream *)requestBody request: (OFHTTPRequest *)request; /** - * @brief A callback which is called when an OFHTTPClient received headers. + * @brief A callback which is called when an @ref OFHTTPClient received headers. * * @param client The OFHTTPClient which received the headers * @param headers The headers received * @param statusCode The status code received * @param request The request for which the headers and status code have been @@ -104,12 +107,12 @@ didReceiveHeaders: (OFDictionary OF_GENERIC(OFString *, OFString *) *)headers statusCode: (short)statusCode request: (OFHTTPRequest *)request; /** - * @brief A callback which is called when an OFHTTPClient wants to follow a - * redirect. + * @brief A callback which is called when an @ref OFHTTPClient wants to follow + * a redirect. * * If you want to get the headers and data for each redirect, set the number of * redirects to 0 and perform a new OFHTTPClient for each redirect. However, * this callback will not be called then and you have to look at the status code * to detect a redirect.