Build and check reference documentation for MAMA C.
From 5268a28a4b8755ebd078d1af39d25936fc6e8436 Mon Sep 17 00:00:00 2001
Message-Id: <5268a28a4b8755ebd078d1af39d25936fc6e8436.1403606176.git.ibell@...>
In-Reply-To: <0e8aa6503fa2861fa4a03fc84888408d09b65127.1403606176.git.ibell@...>
References: <0e8aa6503fa2861fa4a03fc84888408d09b65127.1403606176.git.ibell@...>
From: unknown <ibell@...>
Date: Mon, 23 Jun 2014 16:44:04 +0100
Subject: [PATCH 2/5] [MAMAC] Doxygen updates
Updated comments conflation and clientmanage.h header files to improve
reference documentation.
Signed-off-by: Ian Bell <ibell@...>
---
mama/c_cpp/src/c/mama/clientmanage.h | 31 ++-
mama/c_cpp/src/c/mama/conflation/connection.h | 106 ++++++++-
mama/c_cpp/src/c/mama/conflation/manager.h | 263 ++++++++++++++++++---
.../c_cpp/src/c/mama/conflation/serverconnection.h | 27 ++-
4 files changed, 369 insertions(+), 58 deletions(-)
diff --git a/mama/c_cpp/src/c/mama/clientmanage.h b/mama/c_cpp/src/c/mama/clientmanage.h
index 0127b34..963a0ba 100644
--- a/mama/c_cpp/src/c/mama/clientmanage.h
+++ b/mama/c_cpp/src/c/mama/clientmanage.h
@@ -61,18 +61,29 @@ extern "C" {
/** Commands */
+/**
+ *@brief The enumeration of supported commands
+ */
+
typedef enum
{
- /** Sync Request */
- MAMA_COMMAND_SYNC = 1
+ MAMA_COMMAND_SYNC = 1 /** Sync Request */
} mamaCmCommand;
/**
- * This structure allows for generic commands to be destroyed by the
- * clientmanageresponder. It contains a handle and a pointer to a destructor
- * function.
+ * @brief The function prototype for command
+ */
+
+typedef void (*cmCommandDtor)(void* handle);
+
+/**
+ * @brief This structure allows for generic commands to be destroyed by the
+ * clientmanageresponder.
+ *
+ * @param[in] mHandle Command handler
+ * @param[in] mDtor Callback destructor
*
- * It is not correct for the commands to destroy themselves on completion
+ * @details It is not correct for the commands to destroy themselves on completion
* since the responder creates them. Furthermore, there would be problems at
* shutdown.
*
@@ -80,9 +91,6 @@ typedef enum
*
*/
-
-typedef void (*cmCommandDtor)(void* handle);
-
typedef struct
{
void* mHandle;
@@ -90,8 +98,11 @@ typedef struct
} mamaCommand;
/**
- * Commands invoke this callback when they complete so the responder can
+ * @brief Commands invoke this callback when they complete so the responder can
* destroy them.
+ *
+ * @param[in] command The sync command
+ * @param[in] closure User supplied data
*/
typedef void (*mamaCommandEndCB)(mamaCommand* command, void *closure);
diff --git a/mama/c_cpp/src/c/mama/conflation/connection.h b/mama/c_cpp/src/c/mama/conflation/connection.h
index 574d00b..7f8e76b 100644
--- a/mama/c_cpp/src/c/mama/conflation/connection.h
+++ b/mama/c_cpp/src/c/mama/conflation/connection.h
@@ -35,84 +35,166 @@ extern "C" {
#endif
/**
- * Free the connection.
+ * @brief Free the connection.
+ *
+ * @param[in] connection The mama connection
+ *
+ * @return mama_status return code MAMA_STATUS_OK
*/
MAMAExpDLL
mama_status
mamaConnection_free (mamaConnection connection);
/**
- * Convenience method for returnining the transport.
+ * @brief Convenience method for returnining the transport.
+ *
+ * @param[in] connection The mama connection
+ * @param[out] result Returning the associated transport.
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_NULL_ARG
+ * MAMA_STATUS_OK
*/
MAMAExpDLL
mama_status
mamaConnection_getTransport (mamaConnection connection, mamaTransport *result);
/**
- * Return the IP address of the connected client.
+ * @brief Return the IP address of the connected client.
+ *
+ * @param[in] connection The mama connection
+ * @param[out] address Returning the associated IP address
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_NULL_ARG
+ * MAMA_STATUS_OK
*/
MAMAExpDLL
mama_status
mamaConnection_getIpAddress (mamaConnection connection, const char** address);
/**
- * Return the port of the connected client. This will usually be an ephemeral
+ * @brief Return the port of the connected client. This will usually be an ephemeral
* port selected by the client's ip stack.
+ *
+ * @param[in] connection The mama connection
+ * @param[out] port Returning the associated port
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_NULL_ARG
+ * MAMA_STATUS_OK
*/
MAMAExpDLL
mama_status
mamaConnection_getPort (mamaConnection connection, uint16_t* port);
/*
- * Return the user name of the connected client.
+ * @brief Return the user name of the connected client.
+ *
+ * @param[in] connection The mama connection
+ * @param[out] userName Returning the associated user name
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_NULL_ARG
+ * MAMA_STATUS_OK
*/
MAMAExpDLL
mama_status
mamaConnection_getUserName (mamaConnection connection, const char** userName);
/**
- * Return the application name of the connected client.
+ * @brief Return the application name of the connected client.
+ *
+ * @param[in] connection The mama connection
+ * @param[out] appName Returning the associated application name
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_NULL_ARG
+ * MAMA_STATUS_OK
*/
MAMAExpDLL
mama_status
mamaConnection_getAppName (mamaConnection connection, const char** appName);
/**
- * Return the maximum allowable outbound queue size for the client.
+ * @brief Return the maximum allowable outbound queue size for the client.
+ *
+ * @param[in] connection The mama connection
+ * @param[out] queueSize Returning the associated maximum queue size
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_NULL_ARG
+ * MAMA_STATUS_OK
*/
MAMAExpDLL
mama_status
mamaConnection_getMaxQueueSize(mamaConnection connection, uint32_t *queueSize);
/**
- * Get the number of items in the queue when structure was created.
+ * @brief Get the number of items in the queue when structure was created.
+ *
+ * @param[in] connection The mama connection
+ * @param[out] numItems Returning the associated number of items in the
+ * queue
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_NULL_ARG
+ * MAMA_STATUS_OK
*/
MAMAExpDLL
mama_status
mamaConnection_getQueueSize (mamaConnection connection, uint32_t *numItems);
/**
- * Get the number of messages sent on the connection.
+ * @brief Get the number of messages sent on the connection.
+ *
+ * @param[in] connection The mama connection
+ * @param[out] msgCount Returning the number of messages per connection
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_NULL_ARG
+ * MAMA_STATUS_OK
*/
MAMAExpDLL
mama_status
mamaConnection_getMsgCount (mamaConnection connection, uint32_t *msgCount);
/**
- * Get the number of bytes sent on the connection.
+ * @brief Get the number of bytes sent on the connection.
+ *
+ * @param[in] connection The mama connection
+ * @param[out] bytesSent Returning the number of bytes sent per
+ * connection
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_NULL_ARG
+ * MAMA_STATUS_OK
*/
MAMAExpDLL
mama_status
mamaConnection_getBytesSent (mamaConnection connection, uint32_t *bytesSent);
/**
- * Convert a connection to a string.
+ * @brief Convert a connection to a string.
+ *
+ * @param[in] connection The mama connection
+ *
+ * @return String representation of the mama connection object
*/
MAMAExpDLL
const char*
mamaConnection_toString (mamaConnection connection);
-/* Result is 0 if connection is not intercepted */
+/**
+ * @brief Check if the conneciton is intercepted
+ *
+ * @param[in] connection The mama connection
+ * @param[out] result Returns 0 if connection is not intercepted.
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_NULL_ARG
+ * MAMA_STATUS_NOT_INSTALLED
+ */
MAMAExpDLL
mama_status
mamaConnection_isIntercepted (mamaConnection connection, uint8_t* result);
diff --git a/mama/c_cpp/src/c/mama/conflation/manager.h b/mama/c_cpp/src/c/mama/conflation/manager.h
index a13f8e5..bb51363 100644
--- a/mama/c_cpp/src/c/mama/conflation/manager.h
+++ b/mama/c_cpp/src/c/mama/conflation/manager.h
@@ -36,40 +36,90 @@ typedef void (MAMACALLTYPE *mamaConflationEnqueueCallback)(mamaMsg msg,
const char* topic,
void* closure);
+/**
+ * @brief Allocation of memory for the mama conflation manager
+ *
+ * @param[out] mgr The mama conflation manager
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_NOMEM
+ * MAMA_STATUS_OK
+ */
mama_status
mamaConflationManager_allocate (mamaConflationManager* mgr);
+/**
+ * @brief Creation of the mama conflation manager
+ *
+ * @param[in] mgr The mama conflation manager
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_INVALID_ARG
+ * MAMA_STATUS_NOMEM
+ * MAMA_STATUS_CONFLATE_ERROR
+ */
mama_status
mamaConflationManager_create (mamaConflationManager mgr);
+/**
+ * @brief Destroy the mama conflation manager
+ *
+ * @param[in] mgr The mama conflation manager
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_INVALID_ARG
+ * MAMA_STATUS_OK
+ */
mama_status
mamaConflationManager_destroy (mamaConflationManager mgr);
/*
- * Start conflating. After this call, MAMA routes outbound messages
+ * @brief Start conflating. After this call, MAMA routes outbound messages
* through the conflation manager until the publisher calls end().
+ *
+ * @param[in] mgr The mama conflation manager
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_INVALID_ARG
+ * MAMA_STATUS_CONFLATE_ERROR
+ * MAMA_STATUS_OK
*/
mama_status
mamaConflationManager_start (mamaConflationManager mgr);
/*
- * End conflation. Invoking this method flushes the queue and resumes
+ * @brief End conflation. Invoking this method flushes the queue and resumes
* sending messages directly through the transport. Calling start()
* again restarts conflation.
+ *
+ * @param[in] mgr The mama conflation manager
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_INVALID_ARG
+ * MAMA_STATUS_NOT_INSTALLED
+ * MAMA_STATUS_OK
*/
mama_status
mamaConflationManager_end (mamaConflationManager mgr);
/*
- * If set, new messages are passed to the specified callback rather than
+ * @brief If set, new messages are passed to the specified callback rather than
* being queued directly to the conflation queue. If it is set to NULL or
* not set, new messages are automatically appended to the end of the
* conflation queue in the conflation manager.
*
- * In general this method should be called prior to invoking start().
+ * @details In general this method should be called prior to invoking start().
*
- * If you subclass the MamaConflationManager, you can override the
+ * @details If you subclass the MamaConflationManager, you can override the
* mamaConflationManager_enqueue (mamaConflationManager mgr) method rather than setting the enqueue callback.
+ *
+ * @param[in] mgr The mama conflation manager
+ * @param[in] callback Conflation manager callback
+ * @param[in] closure User supplied data
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_INVALID_ARG
+ * MAMA_STATUS_OK
*/
mama_status
mamaConflationManager_setEnqueueCallback (mamaConflationManager mgr,
@@ -77,13 +127,22 @@ mamaConflationManager_setEnqueueCallback (mamaConflationManager mgr,
void* closure);
/*
- * Enqueue a message to the MamaConflationManager's queue. If there is no
+ * @brief Enqueue a message to the MamaConflationManager's queue. If there is no
* MamaConflationEnqueueCallback specified, the conflation manager invokes
* this automatically. Applications may call this from the Enqueue callback
* to append the message to the queue.
*
- * NOTE: Applications should not modify messages as the data may be shared
+ * @details NOTE: Applications should not modify messages as the data may be shared
* in the underlying middleware for efficiency. Use mamaMsg_copy().
+ *
+ * @param[in] mgr The mama conflation manager
+ * @param[in] msg The mama message
+ * @param[in] topic The Topic
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_INVALID_ARG
+ * MAMA_STATUS_NOT_INSTALLED
+ * MAMA_STATUS_NOMEM
*/
mama_status
mamaConflationManager_enqueue (mamaConflationManager mgr,
@@ -91,10 +150,20 @@ mamaConflationManager_enqueue (mamaConflationManager mgr,
const char* topic);
/*
- * Remove the first message from the queue. This method blocks if the queue is empty.
+ * @brief Remove the first message from the queue. This method blocks if the queue is empty.
*
- * NOTE: Applications should not modify messages as the data may be shared
+ * @details NOTE: Applications should not modify messages as the data may be shared
* in the underlying middleware for efficiency. Use mamaMsg_copy().
+ *
+ * @param[in] mgr The mama conflation manager
+ * @param[in] msg The mama message
+ * @param[in] topic The topic
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_INVALID_ARG
+ * MAMA_STATUS_NOT_INSTALLED
+ * MAMA_STATUS_CONFLATE_ERROR
+ * MAMA_STATUS_OK
*/
mama_status
mamaConflationManager_dequeue(mamaConflationManager mgr,
@@ -102,10 +171,20 @@ mamaConflationManager_dequeue(mamaConflationManager mgr,
const char** topic);
/*
- * Remove a message from the queue. If the queue is empty, return immediately.
+ * @brief Remove a message from the queue. If the queue is empty, return immediately.
*
- * NOTE: Applications should not modify messages as the data may be shared
+ * @details NOTE: Applications should not modify messages as the data may be shared
* in the underlying middleware for efficiency. Use mamaMsg_copy().
+ *
+ * @param[in] mgr The mama conflation manager
+ * @param[in] msg The mama message
+ * @param[in] topic The topic
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_INVALID_ARG
+ * MAMA_STATUS_NOT_INSTALLED
+ * MAMA_STATUS_CONFLATE_ERROR
+ * MAMA_STATUS_OK
*/
mama_status
mamaConflationManager_poll(mamaConflationManager mgr,
@@ -113,12 +192,21 @@ mamaConflationManager_poll(mamaConflationManager mgr,
const char** topic);
/*
- * Send a message. Pass the message to the transport to be sent. This
+ * @brief Send a message. Pass the message to the transport to be sent. This
* message does not return to the conflation queue, it gets sent over the
* network.
*
- * NOTE: Applications should not modify messages as the data may be shared
+ * @details NOTE: Applications should not modify messages as the data may be shared
* in the underlying middleware for efficiency. Use mamaMsg_copy().
+ *
+ * @param[in] mgr The mama conflation manager
+ * @param[in] msg The mama message
+ * @param[in] topic The topic
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_INVALID_ARG
+ * MAMA_STATUS_NOT_IMPLEMENTED
+ * MAMA_STATUS_OK
*/
mama_status
mamaConflationManager_publish (mamaConflationManager mgr,
@@ -126,7 +214,14 @@ mamaConflationManager_publish (mamaConflationManager mgr,
const char* topic);
/*
- * Send all the messages on the queue until it is empty.
+ * @brief Send all the messages on the queue until it is empty.
+ *
+ * @param[in] mgr The mama conflation manager
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_INVALID_ARG
+ * MAMA_STATUS_CONFLATE_ERROR
+ * MAMA_STATUS_OK
*/
mama_status
mamaConflationManager_flush (mamaConflationManager mgr);
@@ -140,11 +235,20 @@ mamaConflationManager_flush (mamaConflationManager mgr);
* the message that dequeue() would remove).
*/
-/* Get the current message without removing it. Or advancing the iterator.
+/* @brief Get the current message without removing it. Or advancing the iterator.
* Returns MAMA_STATUS_QUEUE_END if the queue is empty.
*
- * NOTE: Applications should not modify messages as the data may be shared
+ * @details NOTE: Applications should not modify messages as the data may be shared
* in the underlying middleware for efficiency. Use mamaMsg_copy().
+ *
+ * @param[in] mgr The mama conflation manager
+ * @param[in] msg The mama message
+ * @param[in] topic The topic
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_INVALID_ARG
+ * MAMA_STATUS_QUEUE_END
+ * MAMA_STATUS_OK
*/
mama_status
mamaConflationManager_currentMsg (mamaConflationManager mgr,
@@ -152,11 +256,20 @@ mamaConflationManager_currentMsg (mamaConflationManager mgr,
const char** topic);
/*
- * Get the next message in the queue. Returns MAMA_STATUS_QUEUE_END if the
+ * @brief Get the next message in the queue. Returns MAMA_STATUS_QUEUE_END if the
* iterator is at the end of the queue.
*
- * NOTE: Applications should not modify messages as the data may be shared
+ * @details NOTE: Applications should not modify messages as the data may be shared
* in the underlying middleware for efficiency. Use mamaMsg_copy().
+ *
+ * @param[in] mgr The mama conflation manager
+ * @param[in] msg The mama message
+ * @param[in] topic The topic
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_INVALID_ARG
+ * MAMA_STATUS_QUEUE_END
+ * MAMA_STATUS_OK
*/
mama_status
mamaConflationManager_nextMsg (mamaConflationManager mgr,
@@ -164,71 +277,141 @@ mamaConflationManager_nextMsg (mamaConflationManager mgr,
const char** topic);
/*
- * Get the previous message in the queue. Returns MAMA_STATUS_QUEUE_END if the
+ * @brief Get the previous message in the queue. Returns MAMA_STATUS_QUEUE_END if the
* iterator is at the beginning of the queue.
*
- * NOTE: Applications should not modify messages as the data may be shared
+ * @details NOTE: Applications should not modify messages as the data may be shared
* in the underlying middleware for efficiency. Use mamaMsg_copy().
+ *
+ * @param[in] mgr The mama conflation manager
+ * @param[in] msg The mama message
+ * @param[in] topic The topic
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_INVALID_ARG
+ * MAMA_STATUS_QUEUE_END
+ * MAMA_STATUS_OK
*/
mama_status
mamaConflationManager_prevMsg (mamaConflationManager mgr,
mamaMsg* msg,
const char** topic);
-/* Remove and return the current message. The iterator advances to the next
+/* @brief Remove and return the current message. The iterator advances to the next
* message. Returns MAMA_STATUS_QUEUE_END if queue not positioned on valid
* element.
*
- * NOTE: Applications should not modify messages as the data may be shared
+ * @details NOTE: Applications should not modify messages as the data may be shared
* in the underlying middleware for efficiency. Use mamaMsg_copy().
+ *
+ * @param[in] mgr The mama conflation manager
+ * @param[in] msg The mama message
+ * @param[in] topic The topic
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_INVALID_ARG
+ * MAMA_STATUS_QUEUE_END
+ * MAMA_STATUS_OK
*/
mama_status
mamaConflationManager_removeMsg (mamaConflationManager mgr,
mamaMsg* msg,
const char** topic);
-/* Insert a message in front of the current message.
+/* @brief Insert a message in front of the current message.
*
- * NOTE: Applications should not modify messages as the data may be shared
+ * @details NOTE: Applications should not modify messages as the data may be shared
* in the underlying middleware for efficiency. Use mamaMsg_copy().
+ *
+ * @param[in] mgr The mama conflation manager
+ * @param[in] msg The mama message
+ * @param[in] topic The topic
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_INVALID_ARG
+ * MAMA_STATUS_QUEUE_FULL
+ * MAMA_STATUS_OK
*/
mama_status
mamaConflationManager_insertBefore (mamaConflationManager mgr,
mamaMsg msg,
const char* topic);
-/* Insert a message behind the current message
+/* @brief Insert a message behind the current message
*
- * NOTE: Applications should not modify messages as the data may be shared
+ * @details NOTE: Applications should not modify messages as the data may be shared
* in the underlying middleware for efficiency. Use mamaMsg_copy().
+ *
+ * @param[in] mgr The mama conflation manager
+ * @param[in] msg The mama message
+ * @param[in] topic
+ * @param[in] topic The topic
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_INVALID_ARG
+ * MAMA_STATUS_QUEUE_FULL
+ * MAMA_STATUS_OK
*/
mama_status
mamaConflationManager_insertAfter (mamaConflationManager mgr,
mamaMsg msg,
const char* topic);
-/* Replace the current message. Return message being replaced
+/* @brief Replace the current message. Return message being replaced
*
- * NOTE: Applications should not modify messages as the data may be shared
+ * @details NOTE: Applications should not modify messages as the data may be shared
* in the underlying middleware for efficiency. Use mamaMsg_copy().
+ *
+ * @param[in] mgr The mama conflation manager
+ * @param[in] newMsg
+ * @param[in] topic
+ * @param[in] topic The topic
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_INVALID_ARG
+ * MAMA_STATUS_QUEUE_FULL
+ * MAMA_STATUS_OK
*/
mama_status
mamaConflationManager_replaceMsg (mamaConflationManager mgr,
mamaMsg newMsg,
const char* topic);
-/* Put the iterator at the tail of the queue. Algorithms that
+/* @brief Put the iterator at the tail of the queue. Algorithms that
* process the most recent message first may use this.
+ *
+ * @param[in] mgr The mama conflation manager
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_INVALID_ARG
+ * MAMA_STATUS_CONFLATE_ERROR
+ * MAMA_STATUS_OK
*/
mama_status
mamaConflationManager_gotoTail (mamaConflationManager mgr);
+/**
+ * @brief Put the iterator at the head of the queue. Algorithms that
+ * process the most recent message first may use this.
+ *
+ * @param[in] mgr The mama conflation manager
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_INVALID_ARG
+ * MAMA_STATUS_CONFLATE_ERROR
+ * MAMA_STATUS_OK
+ */
mama_status
mamaConflationManager_gotoHead (mamaConflationManager mgr);
/**
- * Associate this conflation manager with a transport. The manager must
+ * @brief Associate this conflation manager with a transport. The manager must
* not be already installed for a transport or connection.
+ *
+ * @param[in] mgr The mama conflation manager
+ * @param[in] transport
+ *
+ * @return mama_status return code MAMA_STATUS_NOT_IMPLEMENTED
*/
mama_status
mamaConflationManager_installTransportConflationManager (
@@ -236,8 +419,17 @@ mamaConflationManager_installTransportConflationManager (
mamaTransport transport);
/**
- * Associate this conflation manager with a connection. The manager must
+ * @brief Associate this conflation manager with a connection. The manager must
* not be already installed for a transport or connection.
+ *
+ * @param[in] mgr The mama conflation manager
+ * @param[in] transport
+ * @param[in] connection
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_INVALID_ARG
+ * MAMA_STATUS_CONFLATE_ERROR
+ * MAMA_STATUS_OK
*/
mama_status
mamaConflationManager_installConnectionConflationManager (
@@ -246,9 +438,16 @@ mamaConflationManager_installConnectionConflationManager (
mamaConnection connection);
/**
- * Uninstall the conflation manager if it is associated with a transport
+ * @brief Uninstall the conflation manager if it is associated with a transport
* or connection. After invoking this method it may be installed for
* another connection or transport.
+ *
+ * @param[in] mgr The mama conflation manager
+ *
+ * @return mama_status return code can be one of:
+ * MAMA_STATUS_INVALID_ARG
+ * MAMA_STATUS_CONFLATE_ERROR
+ * MAMA_STATUS_OK
*/
mama_status
mamaConflationManager_uninstallConflationManager (mamaConflationManager mgr);
diff --git a/mama/c_cpp/src/c/mama/conflation/serverconnection.h b/mama/c_cpp/src/c/mama/conflation/serverconnection.h
index e9d861c..9fd0b44 100644
--- a/mama/c_cpp/src/c/mama/conflation/serverconnection.h
+++ b/mama/c_cpp/src/c/mama/conflation/serverconnection.h
@@ -34,14 +34,23 @@ extern "C" {
#endif
/**
- * Free the server connection.
+ * @brief Free the server connection.
+ *
+ * @param[in] connection The mama server connection
+ *
+ * @return mama_status return code MAMA_STATUS_OK
*/
MAMAExpDLL
mama_status
mamaServerConnection_free (mamaServerConnection connection);
/**
- * Get the IP address of the connected server.
+ * @brief Get the IP address of the connected server.
+ *
+ * @param[in] connection The mama server connection
+ * @param[out] address Returning the associated IP address
+ *
+ * @return mama_status return code MAMA_STATUS_OK
*/
MAMAExpDLL
mama_status
@@ -49,14 +58,24 @@ mamaServerConnection_getIpAddress (mamaServerConnection connection,
const char** address);
/**
- * Get the port of the connected server.
+ * @brief Get the port of the connected server.
+ *
+ * @param[in] connection The mama server connection
+ * @param[out] port Returning the associated port
+ *
+ * @return mama_status return code MAMA_STATUS_OK
*/
MAMAExpDLL
mama_status
mamaServerConnection_getPort (mamaServerConnection connection, uint16_t* port);
/**
- * Get the status of the server connection.
+ * @brief Get the status of the server connection.
+ *
+ * @param[in] connection The mama server connection
+ * @param[out] connectionStatus Returning the connection status
+ *
+ * @return mama_status return code MAMA_STATUS_OK
*/
MAMAExpDLL
mama_status
--
1.8.4.msysgit.0