diff options
| author | Alexander Klauer <Alexander.Klauer@itwm.fraunhofer.de> | 2013-10-01 14:27:28 +0200 |
|---|---|---|
| committer | Alan Antonuk <alan.antonuk@gmail.com> | 2013-10-03 23:15:24 -0700 |
| commit | fac34656c0c9ad230232fe7b15a57de6c811d3e5 (patch) | |
| tree | 6995a270af384ab57cc9fafb9899c79af0cd8e33 /librabbitmq | |
| parent | 5ea6a0945accfc8b52023aa82f0002b19c122bac (diff) | |
| download | rabbitmq-c-github-ask-fac34656c0c9ad230232fe7b15a57de6c811d3e5.tar.gz | |
Documentation fixes
* amqp.h: Fix link to amqp_destroy_envelope()
* amqp_ssl_socket.h: Fix typo in parameter name
* amqp_tcp_socket.h: Use correct parameter name
* amqp.h: Typo in amqp_basic_ack() documentation
Diffstat (limited to 'librabbitmq')
| -rw-r--r-- | librabbitmq/amqp.h | 4 | ||||
| -rw-r--r-- | librabbitmq/amqp_ssl_socket.h | 6 | ||||
| -rw-r--r-- | librabbitmq/amqp_tcp_socket.h | 2 |
3 files changed, 6 insertions, 6 deletions
diff --git a/librabbitmq/amqp.h b/librabbitmq/amqp.h index 1f5d2da..830dead 100644 --- a/librabbitmq/amqp.h +++ b/librabbitmq/amqp.h @@ -1873,7 +1873,7 @@ AMQP_CALL amqp_connection_close(amqp_connection_state_t state, int code); * * \param [in] state the connection object * \param [in] channel the channel identifier - * \param [in] delivery_tag the delivery take of the message to be ack'd + * \param [in] delivery_tag the delivery tag of the message to be ack'd * \param [in] multiple if true, ack all messages up to this delivery tag, if * false ack only this delivery tag * \return 0 on success, 0 > on failing to send the ack to the broker. @@ -2152,7 +2152,7 @@ typedef struct amqp_envelope_t_ { * * \param [in,out] state the connection object * \param [in,out] envelope a pointer to a amqp_envelope_t object. Caller - * should call amqp_envelope_destroy() when it is done using + * should call #amqp_destroy_envelope() when it is done using * the fields in the envelope object. The caller is responsible * for allocating/destroying the amqp_envelope_t object itself. * \param [in] timeout a timeout to wait for a message delivery. Passing in diff --git a/librabbitmq/amqp_ssl_socket.h b/librabbitmq/amqp_ssl_socket.h index b9621f3..3cab291 100644 --- a/librabbitmq/amqp_ssl_socket.h +++ b/librabbitmq/amqp_ssl_socket.h @@ -145,9 +145,9 @@ amqp_ssl_socket_set_verify(amqp_socket_t *self, * NOTE: calling this function after the first socket has been opened with * amqp_open_socket() will not have any effect. * - * \param [in] do_initalize If 0 rabbitmq-c will not initialize the SSL - * library, otherwise rabbitmq-c will initialize the - * SSL library + * \param [in] do_initialize If 0 rabbitmq-c will not initialize the SSL + * library, otherwise rabbitmq-c will initialize the + * SSL library * * \since v0.4.0 */ diff --git a/librabbitmq/amqp_tcp_socket.h b/librabbitmq/amqp_tcp_socket.h index 4b1b133..347124c 100644 --- a/librabbitmq/amqp_tcp_socket.h +++ b/librabbitmq/amqp_tcp_socket.h @@ -62,7 +62,7 @@ amqp_tcp_socket_new(amqp_connection_state_t state); AMQP_PUBLIC_FUNCTION void AMQP_CALL -amqp_tcp_socket_set_sockfd(amqp_socket_t *base, int sockfd); +amqp_tcp_socket_set_sockfd(amqp_socket_t *self, int sockfd); AMQP_END_DECLS |