qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acon...@apache.org
Subject svn commit: r1653647 - in /qpid/dispatch/trunk: doc/api/ include/qpid/dispatch/ src/
Date Wed, 21 Jan 2015 20:43:16 GMT
Author: aconway
Date: Wed Jan 21 20:43:15 2015
New Revision: 1653647

URL: http://svn.apache.org/r1653647
Log:
NO-JIRA: Improved API doc.

- Better dependency checking for regenerating API docs.
- Show warnings from doxygen, fixed all warnings.

Removed:
    qpid/dispatch/trunk/doc/api/doxygen-wrapper.py
Modified:
    qpid/dispatch/trunk/doc/api/CMakeLists.txt
    qpid/dispatch/trunk/doc/api/doxygen.in
    qpid/dispatch/trunk/include/qpid/dispatch/alloc.h
    qpid/dispatch/trunk/include/qpid/dispatch/amqp.h
    qpid/dispatch/trunk/include/qpid/dispatch/bitmask.h
    qpid/dispatch/trunk/include/qpid/dispatch/buffer.h
    qpid/dispatch/trunk/include/qpid/dispatch/compose.h
    qpid/dispatch/trunk/include/qpid/dispatch/connection_manager.h
    qpid/dispatch/trunk/include/qpid/dispatch/container.h
    qpid/dispatch/trunk/include/qpid/dispatch/dispatch.h
    qpid/dispatch/trunk/include/qpid/dispatch/driver.h
    qpid/dispatch/trunk/include/qpid/dispatch/error.h
    qpid/dispatch/trunk/include/qpid/dispatch/iterator.h
    qpid/dispatch/trunk/include/qpid/dispatch/log.h
    qpid/dispatch/trunk/include/qpid/dispatch/message.h
    qpid/dispatch/trunk/include/qpid/dispatch/parse.h
    qpid/dispatch/trunk/include/qpid/dispatch/router.h
    qpid/dispatch/trunk/include/qpid/dispatch/server.h
    qpid/dispatch/trunk/include/qpid/dispatch/timer.h
    qpid/dispatch/trunk/include/qpid/dispatch/user_fd.h
    qpid/dispatch/trunk/src/container.c
    qpid/dispatch/trunk/src/dispatch_private.h
    qpid/dispatch/trunk/src/entity.h
    qpid/dispatch/trunk/src/router_node.c

Modified: qpid/dispatch/trunk/doc/api/CMakeLists.txt
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/api/CMakeLists.txt?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/doc/api/CMakeLists.txt (original)
+++ qpid/dispatch/trunk/doc/api/CMakeLists.txt Wed Jan 21 20:43:15 2015
@@ -17,6 +17,8 @@
 ## under the License.
 ##
 
+set(bin ${CMAKE_CURRENT_BINARY_DIR})
+
 if(USE_DOXYGEN)
 
   # Create doxygen configuration files.
@@ -36,18 +38,20 @@ if(USE_DOXYGEN)
   configure_doxygen(api_dev "${CMAKE_SOURCE_DIR}/include ${CMAKE_SOURCE_DIR}/src"
     "ENABLED_SECTIONS=INTERNAL\nINTERNAL_DOCS=yes\nEXTRACT_ALL=yes")
 
-  # This is not ideal: if files are added/removed it won't be detected til we re-run cmake.
+  # Dependencies: calculated at configuration time so we won't detect
+  # new/removed files till re-configuration. Usually adding/removing sources
+  # will force a re-configuration so by deleting the output to force a re-build
+  # after re-configuration we should catch most cases.
   file(GLOB_RECURSE API_SOURCES
     ${CMAKE_SOURCE_DIR}/include/*.h
     ${CMAKE_SOURCE_DIR}/src/*.h
     ${CMAKE_SOURCE_DIR}/src/*.c)
+  file(REMOVE_RECURSE ${bin}/api ${bin}/api_dev) # Force rebuild after re-configuration.
 
-  add_custom_command (OUTPUT api
-    COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/doxygen-wrapper.py ${DOXYGEN_EXECUTABLE}
api.doxygen
-    DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/doxygen.in ${API_SOURCES})
-
-  add_custom_command (OUTPUT api_dev
-    COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/doxygen-wrapper.py ${DOXYGEN_EXECUTABLE}
api_dev.doxygen
+  add_custom_command (OUTPUT api api_dev
+    COMMAND ${DOXYGEN_EXECUTABLE} api.doxygen
+    COMMAND ${DOXYGEN_EXECUTABLE} api_dev.doxygen
+    COMMAND ${CMAKE_COMMAND} -E touch api api_dev
     DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/doxygen.in ${API_SOURCES})
 
   add_custom_target(apidocs ALL DEPENDS api api_dev)

Modified: qpid/dispatch/trunk/doc/api/doxygen.in
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/api/doxygen.in?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/doc/api/doxygen.in (original)
+++ qpid/dispatch/trunk/doc/api/doxygen.in Wed Jan 21 20:43:15 2015
@@ -22,6 +22,8 @@ PROJECT_NUMBER          = ${QPID_DISPATC
 INPUT                   = ${INPUT}
 HTML_OUTPUT             = ${HTML_OUTPUT}
 
+WARN_IF_UNDOCUMENTED    = NO    # This should be YES, need to fill in missing doc.
+
 STRIP_FROM_PATH         = ${CMAKE_SOURCE_DIR}/include
 DISABLE_INDEX           = yes
 GENERATE_LATEX          = no
@@ -30,4 +32,6 @@ HAVE_DOT                = ${HAVE_DOT}
 JAVADOC_AUTOBRIEF       = yes
 QUIET                   = yes
 RECURSIVE               = yes
+
 ${MORE_CONFIG}
+

Modified: qpid/dispatch/trunk/include/qpid/dispatch/alloc.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/alloc.h?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/alloc.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/alloc.h Wed Jan 21 20:43:15 2015
@@ -33,16 +33,19 @@
  * @internal
  */
 
+/** Allocation pool */
 typedef struct qd_alloc_pool_t qd_alloc_pool_t;
 
 DEQ_DECLARE(qd_alloc_pool_t, qd_alloc_pool_list_t);
 
+/** Allocation configuration. */
 typedef struct {
     int  transfer_batch_size;
     int  local_free_list_max;
     int  global_free_list_max;
 } qd_alloc_config_t;
 
+/** Allocation statistics. */
 typedef struct {
     uint64_t total_alloc_from_heap;
     uint64_t total_free_to_heap;
@@ -51,6 +54,7 @@ typedef struct {
     uint64_t batches_rebalanced_to_global;
 } qd_alloc_stats_t;
 
+/** Allocation type descriptor. */
 typedef struct {
     uint32_t              header;
     char                 *type_name;
@@ -78,6 +82,10 @@ void qd_dealloc(qd_alloc_type_desc_t *de
     T *new_##T(void);    \
     void free_##T(T *p)
 
+/**
+ * Define allocator configuration.
+ *@internal
+ */
 #define ALLOC_DEFINE_CONFIG(T,S,A,C)                                \
     qd_alloc_type_desc_t __desc_##T = {0, #T, S, A, 0, C, 0, 0, 0, {0,0}, 0}; \
     __thread qd_alloc_pool_t *__local_pool_##T = 0;                     \

Modified: qpid/dispatch/trunk/include/qpid/dispatch/amqp.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/amqp.h?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/amqp.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/amqp.h Wed Jan 21 20:43:15 2015
@@ -22,7 +22,7 @@
 /**@file
  * AMQP constants.
  *
- *@defgroup amqp AMQP
+ *@defgroup amqp amqp
  *
  * AMQP related constant definitions.
  */
@@ -115,6 +115,7 @@ const char * const QD_INTERNODE_LINK_NAM
 
 /** @name AMQP error codes. */
 /// @{
+/** An AMQP error status code and string description  */
 typedef struct qd_amqp_error_t { int status; const char* description; } qd_amqp_error_t;
 extern const qd_amqp_error_t QD_AMQP_OK;
 extern const qd_amqp_error_t QD_AMQP_BAD_REQUEST;

Modified: qpid/dispatch/trunk/include/qpid/dispatch/bitmask.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/bitmask.h?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/bitmask.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/bitmask.h Wed Jan 21 20:43:15 2015
@@ -21,11 +21,21 @@
 
 /**@file
  * Large bit-sets.
+
+ *@defgroup bitmask bitmask
+ *
+ *@{
  */
 
+/** A bit mask */
 typedef struct qd_bitmask_t qd_bitmask_t;
 
+/** Number of bits in a bitmask. */
 int qd_bitmask_width();
+
+/** Create a bitmask.
+ *@param initial if non-zero set all bits, else clear all bits.
+ */
 qd_bitmask_t *qd_bitmask(int initial);
 void qd_bitmask_free(qd_bitmask_t *b);
 void qd_bitmask_set_all(qd_bitmask_t *b);
@@ -35,7 +45,7 @@ void qd_bitmask_clear_bit(qd_bitmask_t *
 int qd_bitmask_value(qd_bitmask_t *b, int bitnum);
 int qd_bitmask_first_set(qd_bitmask_t *b, int *bitnum);
 
-
+///@}
 
 #endif
 

Modified: qpid/dispatch/trunk/include/qpid/dispatch/buffer.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/buffer.h?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/buffer.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/buffer.h Wed Jan 21 20:43:15 2015
@@ -22,6 +22,8 @@
 /** @file
  * Buffer chains.
  * @internal
+ * @defgroup buffer buffer
+ * @{
  */
 
 #include <qpid/dispatch/ctools.h>
@@ -30,6 +32,7 @@ typedef struct qd_buffer_t qd_buffer_t;
 
 DEQ_DECLARE(qd_buffer_t, qd_buffer_list_t);
 
+/** A raw byte buffer .*/
 struct qd_buffer_t {
     DEQ_LINKS(qd_buffer_t);
     unsigned int size;          ///< Size of data content
@@ -89,4 +92,6 @@ size_t qd_buffer_size(qd_buffer_t *buf);
  */
 void qd_buffer_insert(qd_buffer_t *buf, size_t len);
 
+///@}
+
 #endif

Modified: qpid/dispatch/trunk/include/qpid/dispatch/compose.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/compose.h?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/compose.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/compose.h Wed Jan 21 20:43:15 2015
@@ -29,7 +29,7 @@ typedef struct qd_composed_field_t qd_co
 /**@file
  * Composing AMQP data trees.
  * 
- * @defgroup compose
+ * @defgroup compose compose
  *
  * Compose a tree-structure representing an AMQP datatype that can
  * be serialized into a message.
@@ -51,7 +51,7 @@ qd_composed_field_t *qd_compose(uint64_t
 /**
  * Free the resources associated with a composed field.
  *
- * @param A field pointer returned by qd_compose.
+ * @param field A field pointer returned by qd_compose.
  */
 void qd_compose_free(qd_composed_field_t *field);
 
@@ -209,5 +209,7 @@ void qd_compose_insert_symbol(qd_compose
  */
 void qd_compose_insert_typed_iterator(qd_composed_field_t *field, qd_field_iterator_t *iter);
 
+///@}
+
 #endif
 

Modified: qpid/dispatch/trunk/include/qpid/dispatch/connection_manager.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/connection_manager.h?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/connection_manager.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/connection_manager.h Wed Jan 21 20:43:15 2015
@@ -68,7 +68,8 @@ qd_config_connector_t *qd_connection_man
 /**
  * Start an on-demand connector.
  *
- * @param od The pointer to an on-demand connector returned by qd_connections_find_on_demand.
+ * @param qd Pointer to the dispatch instance.
+ * @param cc The pointer to an on-demand connector returned by qd_connections_find_on_demand.
  */
 void qd_connection_manager_start_on_demand(qd_dispatch_t *qd, qd_config_connector_t *cc);
 
@@ -76,7 +77,8 @@ void qd_connection_manager_start_on_dema
 /**
  * Stop an on-demand connector.
  *
- * @param od The pointer to an on-demand connector returned by qd_connections_find_on_demand.
+ * @param qd Pointer to the dispatch instance.
+ * @param cc The pointer to an on-demand connector returned by qd_connections_find_on_demand.
  */
 void qd_connection_manager_stop_on_demand(qd_dispatch_t *qd, qd_config_connector_t *cc);
 

Modified: qpid/dispatch/trunk/include/qpid/dispatch/container.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/container.h?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/container.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/container.h Wed Jan 21 20:43:15 2015
@@ -22,9 +22,10 @@
 /**@file
  * Container for nodes, links and deliveries.
  *
- * @defgroup container
+ * @defgroup container container
  *
  * Container for nodes, links and deliveries.
+ *
  * @{
  */
 
@@ -192,16 +193,5 @@ bool qd_delivery_disp_changed(qd_deliver
 uint64_t qd_delivery_disp(qd_delivery_t *delivery);
 qd_link_t *qd_delivery_link(qd_delivery_t *delivery);
 
-
-typedef struct qd_link_item_t qd_link_item_t;
-
-struct qd_link_item_t {
-    DEQ_LINKS(qd_link_item_t);
-    qd_link_t *link;
-};
-
-ALLOC_DECLARE(qd_link_item_t);
-DEQ_DECLARE(qd_link_item_t, qd_link_list_t);
-
 ///@}
 #endif

Modified: qpid/dispatch/trunk/include/qpid/dispatch/dispatch.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/dispatch.h?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/dispatch.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/dispatch.h Wed Jan 21 20:43:15 2015
@@ -24,9 +24,7 @@
 /**@file
  * Configure and prepare a dispatch instance.
  *
- * @defgroup dispatch
- *
- * Configure and prepare a dispatch instance.
+ * @defgroup dispatch dispatch
  * @{
  */
 
@@ -44,14 +42,14 @@ qd_dispatch_t *qd_dispatch(const char *p
 /**
  * Finalize the Dispatch library after it has stopped running.
  *
- * @param dispatch The dispatch handle returned by qd_dispatch
+ * @param qd The dispatch handle returned by qd_dispatch
  */
 void qd_dispatch_free(qd_dispatch_t *qd);
 
 /**
  * Load the configuration file.
  *
- * @param dispatch The dispatch handle returned by qd_dispatch
+ * @param qd The dispatch handle returned by qd_dispatch
  * @param config_path The path to the configuration file.
  */
 qd_error_t qd_dispatch_load_config(qd_dispatch_t *qd, const char *config_path);

Modified: qpid/dispatch/trunk/include/qpid/dispatch/driver.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/driver.h?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/driver.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/driver.h Wed Jan 21 20:43:15 2015
@@ -35,8 +35,8 @@
  * The driver library provides a simple implementation of a driver for
  * the proton engine. A driver is responsible for providing input,
  * output, and tick events to the bottom half of the engine API. See
- * ::qdpn_transport_input, ::qdpn_transport_output, and
- * ::qdpn_transport_tick. The driver also provides an interface for the
+ * pn_transport_input, pn_transport_output, and
+ * pn_transport_tick. The driver also provides an interface for the
  * application to access the top half of the API when the state of the
  * engine may have changed due to I/O or timing events. Additionally
  * the driver incorporates the SASL engine as well in order to provide

Modified: qpid/dispatch/trunk/include/qpid/dispatch/error.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/error.h?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/error.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/error.h Wed Jan 21 20:43:15 2015
@@ -54,7 +54,7 @@ ENUM_DECLARE(qd_error);
 /**
  * Store thread-local error code and message.
  *@param code Error code. If 0 this is equivalent to calling qd_error_clear()
- *@param fmt printf-stlye format.
+ *@param ... printf-stlye format and arguments.
  *@return code
  */
 #define qd_error(code, ...) qd_error_impl(code, __FILE__, __LINE__, __VA_ARGS__)

Modified: qpid/dispatch/trunk/include/qpid/dispatch/iterator.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/iterator.h?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/iterator.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/iterator.h Wed Jan 21 20:43:15 2015
@@ -8,9 +8,9 @@
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License.  You may obtain a copy of the License at
- * 
+ *
  *   http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -26,70 +26,72 @@
 /**@file
  * Iterate over message buffer chains and addresse fields.
  *
- * @defgroup iterator
+ *
+ * @defgroup iterator iterator
  *
  * Used to access fields within a message buffer chain, in particular address
  * fields.
  *
  * Iterator shields the user from the fact that the field may be split across
  * one or more physical buffers.
+ *
  * @{
  */
 typedef struct qd_field_iterator_t qd_field_iterator_t;
 
 /**
- * Iterator views allow the code traversing the field to see a transformed
- * view of the raw field.
+ * Type of iterator view. Iterator views allow the code traversing an address
+ * field to see a transformed view of the raw field.
  *
  * ITER_VIEW_ALL - No transformation of the raw field data
  *
  * ITER_VIEW_NO_HOST - Remove the scheme and host fields from the view
  *
- *    amqp://host.domain.com:port/node-id/node/specific
- *                                ^^^^^^^^^^^^^^^^^^^^^
- *    node-id/node/specific
- *    ^^^^^^^^^^^^^^^^^^^^^
+ *     amqp://host.domain.com:port/node-id/node/specific
+ *                                 ^^^^^^^^^^^^^^^^^^^^^
+ *     node-id/node/specific
+ *     ^^^^^^^^^^^^^^^^^^^^^
  *
  * ITER_VIEW_NODE_ID - Isolate the node identifier from an address
  *
- *    amqp://host.domain.com:port/node-id/node/specific
+ *     amqp://host.domain.com:port/node-id/node/specific
  *                                ^^^^^^^
- *    node-id/node/specific
- *    ^^^^^^^
+ *     node-id/node/specific
+ *     ^^^^^^^
  *
  * ITER_VIEW_NODE_SPECIFIC - Isolate node-specific text from an address
  *
- *    amqp://host.domain.com:port/node-id/node/specific
- *                                        ^^^^^^^^^^^^^
- *    node-id/node/specific
- *            ^^^^^^^^^^^^^
+ *     amqp://host.domain.com:port/node-id/node/specific
+ *                                         ^^^^^^^^^^^^^
+ *     node-id/node/specific
+ *             ^^^^^^^^^^^^^
  *
  * ITER_VIEW_ADDRESS_HASH - Isolate the hashable part of the address depending on address
syntax
  *
- *    amqp:/_local/<local>
- *                L^^^^^^^
- *    amqp:/_topo/<area>/<router>/<local>
- *               A^^^^^^
- *    amqp:/_topo/<my-area>/<router>/<local>
- *                         R^^^^^^^^
- *    amqp:/_topo/<my_area>/<my-router>/<local>
- *                                     L^^^^^^^
- *    amqp:/_topo/<area>/all/<local>
- *               A^^^^^^
- *    amqp:/_topo/<my-area>/all/<local>
- *                             L^^^^^^^
- *    amqp:/_topo/all/all/<local>
- *                       L^^^^^^^
- *    amqp:/<mobile>
- *         M^^^^^^^^
+ *     amqp:/_local/<local>
+ *                 L^^^^^^^
+ *     amqp:/_topo/<area>/<router>/<local>
+ *                A^^^^^^
+ *     amqp:/_topo/<my-area>/<router>/<local>
+ *                          R^^^^^^^^
+ *     amqp:/_topo/<my_area>/<my-router>/<local>
+ *                                      L^^^^^^^
+ *     amqp:/_topo/<area>/all/<local>
+ *                A^^^^^^
+ *     amqp:/_topo/<my-area>/all/<local>
+ *                              L^^^^^^^
+ *     amqp:/_topo/all/all/<local>
+ *                        L^^^^^^^
+ *     amqp:/<mobile>
+ *          M^^^^^^^^
  *
  * ITER_VIEW_NODE_HASH - Isolate the hashable part of a router-id, used for headers
  *
- *    <area>/<router>
- *   A^^^^^^
+ *      <area>/<router>
+ *     A^^^^^^
  *
- *    <my_area>/<router>
- *             R^^^^^^^^
+ *      <my_area>/<router>
+ *               R^^^^^^^^
  *
  */
 typedef enum {

Modified: qpid/dispatch/trunk/include/qpid/dispatch/log.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/log.h?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/log.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/log.h Wed Jan 21 20:43:15 2015
@@ -47,9 +47,9 @@ void qd_log_impl(qd_log_source_t *source
 
 /** Log a message
  * Note: does not evaluate the format args unless the log message is enabled.
- * @param s qd_log_source_t* source of log message.
- * @param c qd_log_level_t log level of message
- * @param f printf style format string ...
+ * @param source qd_log_source_t* source of log message.
+ * @param level qd_log_level_t log level of message.
+ * @param ... printf style format string and arguments.
  */
 #define qd_log(source, level, ...)                                      \
     do {                                                                \

Modified: qpid/dispatch/trunk/include/qpid/dispatch/message.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/message.h?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/message.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/message.h Wed Jan 21 20:43:15 2015
@@ -30,7 +30,7 @@
 /**@file
  * Message representation. 
  *
- * @defgroup message
+ * @defgroup message message
  *
  * Message representation.
  * @{
@@ -42,11 +42,15 @@ typedef struct qd_message_t qd_message_t
 
 DEQ_DECLARE(qd_message_t, qd_message_list_t);
 
+/** Message representation.
+ *@internal
+ */
 struct qd_message_t {
     DEQ_LINKS(qd_message_t);
     // Private members not listed here.
 };
 
+/** Amount of message to be parsed.  */
 typedef enum {
     QD_DEPTH_NONE,
     QD_DEPTH_HEADER,
@@ -59,6 +63,7 @@ typedef enum {
 } qd_message_depth_t;
 
 
+/** Message fields */
 typedef enum {
     //
     // Message Sections

Modified: qpid/dispatch/trunk/include/qpid/dispatch/parse.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/parse.h?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/parse.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/parse.h Wed Jan 21 20:43:15 2015
@@ -25,10 +25,11 @@
 /**@file
  * Parse raw data fields into AMQP data trees.
  *
- * @defgroup parse
+ * @defgroup parse parse
  *
  * Parse data from qd_field_iterator_t into a tree structure represeniting
  * an AMQP data type tree.
+ *@{
  */
 
 typedef struct qd_parsed_field_t qd_parsed_field_t;
@@ -44,7 +45,7 @@ qd_parsed_field_t *qd_parse(qd_field_ite
 /**
  * Free the resources associated with a parsed field.
  *
- * @param A field pointer returned by qd_parse.
+ * @param field A field pointer returned by qd_parse.
  */
 void qd_parse_free(qd_parsed_field_t *field);
 
@@ -200,5 +201,7 @@ int qd_parse_is_scalar(qd_parsed_field_t
  */
 qd_parsed_field_t *qd_parse_value_by_key(qd_parsed_field_t *field, const char *key);
 
+///@}
+
 #endif
 

Modified: qpid/dispatch/trunk/include/qpid/dispatch/router.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/router.h?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/router.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/router.h Wed Jan 21 20:43:15 2015
@@ -22,8 +22,10 @@
 /**@file
  * Register addresses, send messages.
  *
- * @defgroup router
+ * @defgroup router router
+ *
  * Register addresses, send messages.
+ * @{
  */
 #include <qpid/dispatch/dispatch.h>
 #include <qpid/dispatch/message.h>
@@ -99,9 +101,11 @@ typedef void (*qd_router_message_cb_t)(v
 const char *qd_router_id(const qd_dispatch_t *qd);
 
 /** Register an address in the router's hash table.
+ * @param qd Pointer to the dispatch instance.
  * @param address String form of address
  * @param handler Callback to be called when a message is received for the address.
  * @param semantics Semantics for the address.
+ * @param global True if the address is global.
  * @param context Context to be passed to the handler.
  */
 qd_address_t *qd_router_register_address(qd_dispatch_t          *qd,
@@ -133,4 +137,7 @@ void qd_router_build_node_list(qd_dispat
 
 /** String form of address for logging */
 const char* qd_address_logstr(qd_address_t* address);
+
+///@}
+
 #endif

Modified: qpid/dispatch/trunk/include/qpid/dispatch/server.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/server.h?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/server.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/server.h Wed Jan 21 20:43:15 2015
@@ -27,7 +27,7 @@
  */
 
 /**
- * @defgroup server
+ * @defgroup server server
  *
  * Control server threads, starting and stopping the server.
  * @{
@@ -127,7 +127,7 @@ void qd_server_resume(qd_dispatch_t *qd)
 
 /**
  * @}
- * @defgroup server_signal Server Signal
+ * @defgroup server_signal server_signal
  *
  * Server Signal Handling
  * 
@@ -175,7 +175,7 @@ void qd_server_signal(qd_dispatch_t *qd,
 
 /**
  * @}
- * @defgroup server_connection Server Connection
+ * @defgroup connection connection
  *
  * Server AMQP Connection Handling
  *
@@ -362,7 +362,8 @@ typedef int (*qd_conn_handler_cb_t)(void
  * mandatory and must be set prior to the invocation of qd_server_run.
  *
  * @param qd The dispatch handle returned by qd_dispatch.
- * @param conn_hander The handler for processing connection-related events.
+ * @param conn_handler The handler for processing connection-related events.
+ * @param handler_context Context data to associate with the handler.
  */
 void qd_server_set_conn_handler(qd_dispatch_t *qd, qd_conn_handler_cb_t conn_handler, void
*handler_context);
 

Modified: qpid/dispatch/trunk/include/qpid/dispatch/timer.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/timer.h?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/timer.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/timer.h Wed Jan 21 20:43:15 2015
@@ -25,7 +25,7 @@
 /**@file
  * Server Timer Functions
  * 
- * @defgroup timer
+ * @defgroup timer timer
  *
  * Server Timer Functions
  * @{
@@ -45,7 +45,8 @@ typedef void (*qd_timer_cb_t)(void* cont
 
 /**
  * Create a new timer object.
- *
+ * 
+ * @param qd Pointer to the dispatch instance.
  * @param cb The callback function to be invoked when the timer expires.
  * @param context An opaque, user-supplied context to be passed into the callback.
  * @return A pointer to the new timer object or NULL if memory is exhausted.

Modified: qpid/dispatch/trunk/include/qpid/dispatch/user_fd.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/user_fd.h?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/user_fd.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/user_fd.h Wed Jan 21 20:43:15 2015
@@ -25,7 +25,7 @@
 /**@file
  * Server User-File-Descriptor functions.
  * 
- * @defgroup user_fd User FD
+ * @defgroup user_fd user_fd
  *
  * Server User-File-Descriptor Functions
  * @{
@@ -60,6 +60,7 @@ void qd_server_set_user_fd_handler(qd_di
  * for purposes other than AMQP communication.  Registering a user fd with the dispatch server
  * controls processing of the FD alongside the FDs used for messaging.
  *
+ * @param qd Pointer to the dispatch instance.
  * @param fd The open file descriptor being managed by the application.
  * @param context User context passed back in the connection handler.
  * @return A pointer to the new user_fd.

Modified: qpid/dispatch/trunk/src/container.c
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/src/container.c?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/src/container.c (original)
+++ qpid/dispatch/trunk/src/container.c Wed Jan 21 20:43:15 2015
@@ -47,7 +47,6 @@ struct qd_node_t {
 DEQ_DECLARE(qd_node_t, qd_node_list_t);
 ALLOC_DECLARE(qd_node_t);
 ALLOC_DEFINE(qd_node_t);
-ALLOC_DEFINE(qd_link_item_t);
 
 /** Encapsulates a proton link for sending and receiving messages */
 struct qd_link_t {

Modified: qpid/dispatch/trunk/src/dispatch_private.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/src/dispatch_private.h?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/src/dispatch_private.h (original)
+++ qpid/dispatch/trunk/src/dispatch_private.h Wed Jan 21 20:43:15 2015
@@ -60,25 +60,25 @@ struct qd_dispatch_t {
 /**
  * Configure the AMQP container from a configuration entity.
  *
- * @param dispatch The dispatch handle returned by qd_dispatch
+ * @param qd The dispatch handle returned by qd_dispatch
  * @param entity The configuration entity.
  */
 qd_error_t qd_dispatch_configure_container(qd_dispatch_t *qd, qd_entity_t *entity);
 
 /**
  * Configure the router node from a configuration entity.
- *        If this is not called, the router will run in ENDPOINT mode.
+ * If this is not called, the router will run in ENDPOINT mode.
  *
- * @param dispatch The dispatch handle returned by qd_dispatch.
+ * @param qd The dispatch handle returned by qd_dispatch.
  * @param entity The configuration entity.
  */
 qd_error_t qd_dispatch_configure_router(qd_dispatch_t *qd, qd_entity_t *entity);
 
 /**
  * Prepare Dispatch for operation.  This must be called prior to
- *        calling qd_server_run or qd_server_start.
+ * calling qd_server_run or qd_server_start.
  *
- * @param dispatch The dispatch handle returned by qd_dispatch
+ * @param qd The dispatch handle returned by qd_dispatch
  */
 qd_error_t qd_dispatch_prepare(qd_dispatch_t *qd);
 
@@ -97,7 +97,7 @@ qd_error_t qd_dispatch_configure_waypoin
  *        parsed configuration file.  This must be called after the
  *        call to qd_dispatch_prepare completes.
  *
- * @param dispatch The dispatch handle returned by qd_dispatch
+ * @param qd The dispatch handle returned by qd_dispatch
  */
 qd_error_t qd_dispatch_configure_logging(qd_dispatch_t *qd);
 

Modified: qpid/dispatch/trunk/src/entity.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/src/entity.h?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/src/entity.h (original)
+++ qpid/dispatch/trunk/src/entity.h Wed Jan 21 20:43:15 2015
@@ -23,9 +23,7 @@
 #include <qpid/dispatch/error.h>
 
 /**
- * @defgroup entity-attributes
- *
- * Set/get cached attributes of a managed entity.
+ * @defgroup entity-attributes Set/get cached attributes of a managed entity.
  *
  * @{
  */

Modified: qpid/dispatch/trunk/src/router_node.c
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/src/router_node.c?rev=1653647&r1=1653646&r2=1653647&view=diff
==============================================================================
--- qpid/dispatch/trunk/src/router_node.c (original)
+++ qpid/dispatch/trunk/src/router_node.c Wed Jan 21 20:43:15 2015
@@ -39,19 +39,19 @@ static char *topo_prefix    = "_topo/";
 static char *direct_prefix;
 static char *node_id;
 
-/**
+/*
  * Address Types and Processing:
  *
- *   Address                              Hash Key       onReceive
- *   ===================================================================
- *   _local/<local>                       L<local>               handler
- *   _topo/<area>/<router>/<local>        A<area>        forward
- *   _topo/<my-area>/<router>/<local>     R<router>      forward
- *   _topo/<my-area>/<my-router>/<local>  L<local>              
handler
- *   _topo/<area>/all/<local>             A<area>        forward
- *   _topo/<my-area>/all/<local>          L<local>       forward handler
- *   _topo/all/all/<local>                L<local>       forward handler
- *   <mobile>                             M<mobile>      forward handler
+ *     Address                              Hash Key       onReceive
+ *     ===================================================================
+ *     _local/<local>                       L<local>               handler
+ *     _topo/<area>/<router>/<local>        A<area>        forward
+ *     _topo/<my-area>/<router>/<local>     R<router>      forward
+ *     _topo/<my-area>/<my-router>/<local>  L<local>            
  handler
+ *     _topo/<area>/all/<local>             A<area>        forward
+ *     _topo/<my-area>/all/<local>          L<local>       forward handler
+ *     _topo/all/all/<local>                L<local>       forward handler
+ *     <mobile>                             M<mobile>      forward handler
  */
 
 ALLOC_DEFINE(qd_routed_event_t);
@@ -62,7 +62,6 @@ ALLOC_DEFINE(qd_router_link_ref_t);
 ALLOC_DEFINE(qd_address_t);
 ALLOC_DEFINE(qd_router_conn_t);
 
-
 qd_address_t* qd_address() {
     qd_address_t* addr = new_qd_address_t();
     memset(addr, 0, sizeof(qd_address_t));



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org


Mime
View raw message