diff options
| author | Alan Antonuk <alan.antonuk@gmail.com> | 2014-01-01 16:37:55 -0800 |
|---|---|---|
| committer | Alan Antonuk <alan.antonuk@gmail.com> | 2014-01-01 16:44:48 -0800 |
| commit | 01d9c3ca607e7a2c52ee8dfcd0766dc55e9ad648 (patch) | |
| tree | 1095be2aca7d9bc3661eb06e953fdcc204aba014 | |
| parent | 693662ef5bcaddcfcf9118e78995d2cb5292664c (diff) | |
| download | rabbitmq-c-github-ask-01d9c3ca607e7a2c52ee8dfcd0766dc55e9ad648.tar.gz | |
Improve documentation for amqp_ssl_socket_* funcs
Correctly document the return values that the amqp_ssl_socket_set_keys,
amqp_ssl_socket_set_cert, and amqp_ssl_socket_set_key_buffer functions
can return.
This fixes #155
| -rw-r--r-- | librabbitmq/amqp_ssl_socket.h | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/librabbitmq/amqp_ssl_socket.h b/librabbitmq/amqp_ssl_socket.h index 3cab291..7f8ea64 100644 --- a/librabbitmq/amqp_ssl_socket.h +++ b/librabbitmq/amqp_ssl_socket.h @@ -61,7 +61,8 @@ amqp_ssl_socket_new(amqp_connection_state_t state); * \param [in,out] self An SSL/TLS socket object. * \param [in] cacert Path to the CA cert file in PEM format. * - * \return \ref AMQP_STATUS_OK on success an enum + * \return \ref AMQP_STATUS_OK on success an \ref amqp_status_enum value on + * failure. * * \since v0.4.0 */ @@ -78,7 +79,8 @@ amqp_ssl_socket_set_cacert(amqp_socket_t *self, * \param [in] cert Path to the client certificate in PEM foramt. * \param [in] key Path to the client key in PEM format. * - * \return Zero if successful, -1 otherwise. + * \return \ref AMQP_STATUS_OK on success an \ref amqp_status_enum value on + * failure. * * \since v0.4.0 */ @@ -97,7 +99,8 @@ amqp_ssl_socket_set_key(amqp_socket_t *self, * \param [in] key A buffer containing client key in PEM format. * \param [in] n The length of the buffer. * - * \return Zero if successful, -1 otherwise. + * \return \ref AMQP_STATUS_OK on success an \ref amqp_status_enum value on + * failure. * * \since v0.4.0 */ |