summaryrefslogtreecommitdiff
path: root/librabbitmq/amqp_tcp_socket.h
diff options
context:
space:
mode:
authorAlan Antonuk <alan.antonuk@gmail.com>2012-07-16 23:12:22 -0400
committerAlan Antonuk <alan.antonuk@gmail.com>2013-08-13 16:40:48 -0700
commit8554733a88a19b19637be4b03b0e570e6dc75be9 (patch)
treecc0d5efdd950f0ec4924ceb1257f44b8011f106d /librabbitmq/amqp_tcp_socket.h
parent8efc95955770989b3d09c011bc3e311f84787f1d (diff)
downloadrabbitmq-c-github-ask-8554733a88a19b19637be4b03b0e570e6dc75be9.tar.gz
Document public API
Diffstat (limited to 'librabbitmq/amqp_tcp_socket.h')
-rw-r--r--librabbitmq/amqp_tcp_socket.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/librabbitmq/amqp_tcp_socket.h b/librabbitmq/amqp_tcp_socket.h
index 2fcd2cb..4b1b133 100644
--- a/librabbitmq/amqp_tcp_socket.h
+++ b/librabbitmq/amqp_tcp_socket.h
@@ -1,4 +1,5 @@
/* vim:set ft=c ts=2 sw=2 sts=2 et cindent: */
+/** \file */
/*
* Copyright 2012-2013 Michael Steinert
*
@@ -38,6 +39,8 @@ AMQP_BEGIN_DECLS
* Call amqp_socket_close() to release socket resources.
*
* \return A new socket object or NULL if an error occurred.
+ *
+ * \since v0.4.0
*/
AMQP_PUBLIC_FUNCTION
amqp_socket_t *
@@ -53,6 +56,8 @@ amqp_tcp_socket_new(amqp_connection_state_t state);
*
* \param [in,out] self A TCP socket object.
* \param [in] sockfd An open socket descriptor.
+ *
+ * \since v0.4.0
*/
AMQP_PUBLIC_FUNCTION
void