qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From acon...@apache.org
Subject svn commit: r1653301 - in /qpid/dispatch/trunk: bin/ doc/ doc/api/ doc/book/ doc/man/ include/qpid/ include/qpid/dispatch/
Date Tue, 20 Jan 2015 17:06:32 GMT
Author: aconway
Date: Tue Jan 20 17:06:32 2015
New Revision: 1653301

URL: http://svn.apache.org/r1653301
Log:
NO-JIRA: Install generated API doc.

- Add generated API doc to install.
- Flesh out some missing doc comments.
- Improve detection of doc generation tools.

Added:
    qpid/dispatch/trunk/bin/rebuild.sh   (contents, props changed)
      - copied, changed from r1653031, qpid/dispatch/trunk/doc/api/doxygen.in
Modified:
    qpid/dispatch/trunk/doc/CMakeLists.txt
    qpid/dispatch/trunk/doc/api/CMakeLists.txt
    qpid/dispatch/trunk/doc/api/doxygen.in
    qpid/dispatch/trunk/doc/book/CMakeLists.txt
    qpid/dispatch/trunk/doc/man/CMakeLists.txt
    qpid/dispatch/trunk/include/qpid/dispatch.h
    qpid/dispatch/trunk/include/qpid/dispatch/amqp.h
    qpid/dispatch/trunk/include/qpid/dispatch/bitmask.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/ctools.h
    qpid/dispatch/trunk/include/qpid/dispatch/dispatch.h
    qpid/dispatch/trunk/include/qpid/dispatch/hash.h
    qpid/dispatch/trunk/include/qpid/dispatch/iovec.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/python_embedded.h
    qpid/dispatch/trunk/include/qpid/dispatch/router.h
    qpid/dispatch/trunk/include/qpid/dispatch/server.h
    qpid/dispatch/trunk/include/qpid/dispatch/threading.h
    qpid/dispatch/trunk/include/qpid/dispatch/timer.h
    qpid/dispatch/trunk/include/qpid/dispatch/user_fd.h

Copied: qpid/dispatch/trunk/bin/rebuild.sh (from r1653031, qpid/dispatch/trunk/doc/api/doxygen.in)
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/bin/rebuild.sh?p2=qpid/dispatch/trunk/bin/rebuild.sh&p1=qpid/dispatch/trunk/doc/api/doxygen.in&r1=1653031&r2=1653301&rev=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/doc/api/doxygen.in (original)
+++ qpid/dispatch/trunk/bin/rebuild.sh Tue Jan 20 17:06:32 2015
@@ -1,3 +1,4 @@
+#!/usr/bin/env bash
 #
 # Licensed to the Apache Software Foundation (ASF) under one
 # or more contributor license agreements.  See the NOTICE file
@@ -17,9 +18,14 @@
 # under the License.
 #
 
-PROJECT_NAME           = "Dispatch"
-OUTPUT_DIRECTORY       = ${DOXYGEN_OUTPUT_DIRECTORY}
-INPUT                  = ${DOXYGEN_INPUT}
-RECURSIVE              = yes
-JAVADOC_AUTOBRIEF      = yes
-${DOXYGEN_MORE}
+set -ev
+
+rm -rf $BUILD_DIR
+rm -rf $INSTALL_DIR
+
+mkdir $BUILD_DIR
+cd $BUILD_DIR
+
+cmake -DCMAKE_INSTALL_PREFIX=$INSTALL_DIR -DCMAKE_BUILD_TYPE=Debug "$@" $SOURCE_DIR
+make -j4
+make install

Propchange: qpid/dispatch/trunk/bin/rebuild.sh
------------------------------------------------------------------------------
    svn:executable = *

Modified: qpid/dispatch/trunk/doc/CMakeLists.txt
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/CMakeLists.txt?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/doc/CMakeLists.txt (original)
+++ qpid/dispatch/trunk/doc/CMakeLists.txt Tue Jan 20 17:06:32 2015
@@ -17,6 +17,32 @@
 ## under the License.
 ##
 
+find_package(Doxygen)
+find_program(PANDOC pandoc)
+find_program(PDFLATEX pdflatex)
+
+# Create an option to enable/disable a doc tool and check if the tool is present.
+# If tool is present, option defaults to ON else OFF.
+# If option is set ON by user and tool is not present, that is an error.
+# If tool is not present and option is not set on just issue a status message.
+# 
+macro(doc_tool tool use var what)
+  if(${var})
+    option(${use} "Generate ${what} with ${tool}" ON)
+  else(${var})
+    option(${use} "Generate ${what} with ${tool}" OFF)
+    if(${use})
+      message(SEND_ERROR "${use} enabled but ${tool} not found.")
+    else(${use})
+      message(STATUS "${tool} not found, not generating ${what}.")
+    endif(${use})
+  endif(${var})
+endmacro()
+
+doc_tool(pandoc USE_PANDOC PANDOC "HTML and man page documentation")
+doc_tool(doxygen USE_DOXYGEN DOXYGEN_FOUND "API documentation")
+doc_tool(pdflatex USE_PDFLATEX PDFLATEX "PDF documentation (also requires pandoc)")
+
 add_subdirectory(api)
 add_subdirectory(man)
 add_subdirectory(book)

Modified: qpid/dispatch/trunk/doc/api/CMakeLists.txt
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/api/CMakeLists.txt?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/doc/api/CMakeLists.txt (original)
+++ qpid/dispatch/trunk/doc/api/CMakeLists.txt Tue Jan 20 17:06:32 2015
@@ -17,12 +17,8 @@
 ## under the License.
 ##
 
-find_package(Doxygen)
-if (DOXYGEN_FOUND)
-  option(BUILD_DOCS "Build documentation with doxygen" ON)
-endif (DOXYGEN_FOUND)
+if(USE_DOXYGEN)
 
-if (BUILD_DOCS)
   # Create doxygen configuration files.
   function(configure_doxygen DOXYGEN_OUTPUT_DIRECTORY DOXYGEN_INPUT DOXYGEN_MORE)
     configure_file(
@@ -42,9 +38,13 @@ if (BUILD_DOCS)
   add_custom_command (OUTPUT user
     COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/doxygen-wrapper.py ${DOXYGEN_EXECUTABLE}
user.doxygen
     DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/doxygen.in ${API_SOURCES})
+
   add_custom_command (OUTPUT dev
     COMMAND ${PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/doxygen-wrapper.py ${DOXYGEN_EXECUTABLE}
dev.doxygen
     DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/doxygen.in ${API_SOURCES})
 
   add_custom_target(apidocs ALL DEPENDS user dev)
-endif (BUILD_DOCS)
+
+  install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/user/html/ DESTINATION ${QD_DOC_INSTALL_DIR}/api)
+
+endif(USE_DOXYGEN)

Modified: qpid/dispatch/trunk/doc/api/doxygen.in
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/api/doxygen.in?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/doc/api/doxygen.in (original)
+++ qpid/dispatch/trunk/doc/api/doxygen.in Tue Jan 20 17:06:32 2015
@@ -17,9 +17,10 @@
 # under the License.
 #
 
-PROJECT_NAME           = "Dispatch"
+PROJECT_NAME           = "Qpid Dispatch Library"
 OUTPUT_DIRECTORY       = ${DOXYGEN_OUTPUT_DIRECTORY}
 INPUT                  = ${DOXYGEN_INPUT}
 RECURSIVE              = yes
 JAVADOC_AUTOBRIEF      = yes
+GENERATE_LATEX         = no
 ${DOXYGEN_MORE}

Modified: qpid/dispatch/trunk/doc/book/CMakeLists.txt
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/book/CMakeLists.txt?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/doc/book/CMakeLists.txt (original)
+++ qpid/dispatch/trunk/doc/book/CMakeLists.txt Tue Jan 20 17:06:32 2015
@@ -36,9 +36,7 @@ set(BOOK ${src}/introduction.md ${src}/u
 # Install markdown documentation in the doc directory.
 install(FILES ${BOOK} DESTINATION ${QD_DOC_INSTALL_DIR})
 
-# Generate man pages and book if pandoc is installed
-find_program(PANDOC pandoc)
-if (PANDOC)
+if(USE_PANDOC)
   set(PD_ARGS --standalone --toc --number-sections -f markdown -V "title=Qpid Dispatch Router
Book")
 
   # Generate a book with the given suffix. Extra arguments are passed to pandoc
@@ -62,10 +60,7 @@ if (PANDOC)
   else(PDFLATEX)
     message("Not generating PDF format book, pdflatex not available.")
   endif(PDFLATEX)
-else(PANDOC)
-    message("Not generating HTML format book, pandoc not available.")
-endif(PANDOC)
-
+endif(USE_PANDOC)
 
 # Target to generate all chapters and books.
 add_custom_target(book ALL DEPENDS ${BOOK} ${BOOKS})

Modified: qpid/dispatch/trunk/doc/man/CMakeLists.txt
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/man/CMakeLists.txt?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/doc/man/CMakeLists.txt (original)
+++ qpid/dispatch/trunk/doc/man/CMakeLists.txt Tue Jan 20 17:06:32 2015
@@ -22,8 +22,6 @@
 # If pandoc is available, also generate real man pages.
 #
 
-find_program(PANDOC pandoc)
-
 set(src ${CMAKE_CURRENT_SOURCE_DIR})
 set(bin ${CMAKE_CURRENT_BINARY_DIR})
 set(tools ${CMAKE_SOURCE_DIR}/tools)
@@ -50,7 +48,7 @@ macro(manpage program section)
   install(FILES ${manpage}.md DESTINATION ${QD_DOC_INSTALL_DIR})
   set(MANPAGES_OUT ${MANPAGES_OUT} ${manpage}.md)
 
-  if (PANDOC)
+  if (USE_PANDOC)
     # Generate HTML man page
     add_custom_command (
       OUTPUT ${manpage}.html ${manpage}.html.in
@@ -77,10 +75,9 @@ macro(manpage program section)
       )
     install(FILES ${manpage} DESTINATION "${MAN_INSTALL_DIR}/man${section}")
     set(MANPAGES_OUT ${MANPAGES_OUT} ${manpage})
-  endif(PANDOC)
+  endif(USE_PANDOC)
 endmacro(manpage)
 
-
 # Shortcut to run both help2md and manpage
 macro(help2man program section path)
   help2md(${program} ${section} ${path})

Modified: qpid/dispatch/trunk/include/qpid/dispatch.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch.h?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch.h Tue Jan 20 17:06:32 2015
@@ -19,6 +19,24 @@
  * under the License.
  */
 
+/**@file
+ * Includes all dispatch library headers.
+ *
+ * @mainpage API documentation for the Qpid Dispatch library.
+ *
+ * @section intro Introduction
+ *
+ * This library allows you to send, receive, parse, construct, route and otherwise
+ * manipulate AMQP messages.
+ *
+ * The [Qpid Dispatch Router](http://qpid.apache.org/components/dispatch-router)
+ * is a flexible AMQP messaging router based on this library. It should meet
+ * most general-purpose message routing needs.
+ *
+ * If you want to build your own custom router-like application, this library
+ * provides the tools to do so.
+*/
+
 #include <qpid/dispatch/alloc.h>
 #include <qpid/dispatch/bitmask.h>
 #include <qpid/dispatch/buffer.h>

Modified: qpid/dispatch/trunk/include/qpid/dispatch/amqp.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/amqp.h?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/amqp.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/amqp.h Tue Jan 20 17:06:32 2015
@@ -19,7 +19,10 @@
  * under the License.
  */
 
-/** @defgroup amqp AMQP
+/**@file
+ * AMQP constants.
+ *
+ *@defgroup amqp AMQP
  *
  * AMQP related constant definitions.
  */

Modified: qpid/dispatch/trunk/include/qpid/dispatch/bitmask.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/bitmask.h?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/bitmask.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/bitmask.h Tue Jan 20 17:06:32 2015
@@ -19,6 +19,10 @@
  * under the License.
  */
 
+/**@file
+ * Large bit-sets.
+ */
+
 typedef struct qd_bitmask_t qd_bitmask_t;
 
 int qd_bitmask_width();

Modified: qpid/dispatch/trunk/include/qpid/dispatch/compose.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/compose.h?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/compose.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/compose.h Tue Jan 20 17:06:32 2015
@@ -25,7 +25,10 @@
 /** A linked list of buffers composing a sequence of AMQP data objects. */
 typedef struct qd_composed_field_t qd_composed_field_t;
 
-/**
+
+/**@file
+ * Composing AMQP data trees.
+ * 
  * @defgroup compose
  *
  * Compose a tree-structure representing an AMQP datatype that can

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=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/connection_manager.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/connection_manager.h Tue Jan 20 17:06:32 2015
@@ -19,6 +19,10 @@
  * under the License.
  */
 
+/**@file
+ * Manage listeners and connectors.
+ */
+
 #include <qpid/dispatch/dispatch.h>
 
 typedef struct qd_connection_manager_t qd_connection_manager_t;

Modified: qpid/dispatch/trunk/include/qpid/dispatch/container.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/container.h?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/container.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/container.h Tue Jan 20 17:06:32 2015
@@ -19,7 +19,10 @@
  * under the License.
  */
 
-/** @defgroup container
+/**@file
+ * Container for nodes, links and deliveries.
+ *
+ * @defgroup container
  *
  * Container for nodes, links and deliveries.
  * @{

Modified: qpid/dispatch/trunk/include/qpid/dispatch/ctools.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/ctools.h?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/ctools.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/ctools.h Tue Jan 20 17:06:32 2015
@@ -19,6 +19,10 @@
  * under the License.
  */
 
+/**@file
+ * Double-ended queues and other useful macros.
+ */
+
 #include <stdlib.h>
 #include <assert.h>
 

Modified: qpid/dispatch/trunk/include/qpid/dispatch/dispatch.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/dispatch.h?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/dispatch.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/dispatch.h Tue Jan 20 17:06:32 2015
@@ -21,7 +21,9 @@
 
 #include <qpid/dispatch/error.h>
 
-/**
+/**@file
+ * Configure and prepare a dispatch instance.
+ *
  * @defgroup dispatch
  *
  * Configure and prepare a dispatch instance.

Modified: qpid/dispatch/trunk/include/qpid/dispatch/hash.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/hash.h?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/hash.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/hash.h Tue Jan 20 17:06:32 2015
@@ -19,6 +19,10 @@
  * under the License.
  */
 
+/**@file
+ * Hash table.
+ */
+
 #include <stdlib.h>
 #include <qpid/dispatch/iterator.h>
 #include <qpid/dispatch/error.h>

Modified: qpid/dispatch/trunk/include/qpid/dispatch/iovec.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/iovec.h?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/iovec.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/iovec.h Tue Jan 20 17:06:32 2015
@@ -19,6 +19,10 @@
  * under the License.
  */
 
+/**@file
+ * IO Vectors
+ */
+
 #include <sys/uio.h>
 
 typedef struct qd_iovec_t qd_iovec_t;

Modified: qpid/dispatch/trunk/include/qpid/dispatch/iterator.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/iterator.h?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/iterator.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/iterator.h Tue Jan 20 17:06:32 2015
@@ -23,7 +23,9 @@
 #include <qpid/dispatch/buffer.h>
 #include <qpid/dispatch/iovec.h>
 
-/**
+/**@file
+ * Iterate over message buffer chains and addresse fields.
+ *
  * @defgroup iterator
  *
  * Used to access fields within a message buffer chain, in particular address

Modified: qpid/dispatch/trunk/include/qpid/dispatch/log.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/log.h?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/log.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/log.h Tue Jan 20 17:06:32 2015
@@ -20,6 +20,10 @@
  */
 #include <stdbool.h>
 
+/**@file
+ * Sending debug/administrative log messages.
+ */
+
 /** Logging levels */
 typedef enum {
     QD_LOG_NONE     =0x00, ///< No logging

Modified: qpid/dispatch/trunk/include/qpid/dispatch/message.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/message.h?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/message.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/message.h Tue Jan 20 17:06:32 2015
@@ -27,7 +27,9 @@
 #include <qpid/dispatch/parse.h>
 #include <qpid/dispatch/container.h>
 
-/** 
+/**@file
+ * Message representation. 
+ *
  * @defgroup message
  *
  * Message representation.

Modified: qpid/dispatch/trunk/include/qpid/dispatch/parse.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/parse.h?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/parse.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/parse.h Tue Jan 20 17:06:32 2015
@@ -22,8 +22,11 @@
 #include <qpid/dispatch/buffer.h>
 #include <qpid/dispatch/iterator.h>
 
-/** @defgroup parse
- * 
+/**@file
+ * Parse raw data fields into AMQP data trees.
+ *
+ * @defgroup parse
+ *
  * Parse data from qd_field_iterator_t into a tree structure represeniting
  * an AMQP data type tree.
  */

Modified: qpid/dispatch/trunk/include/qpid/dispatch/python_embedded.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/python_embedded.h?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/python_embedded.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/python_embedded.h Tue Jan 20 17:06:32 2015
@@ -19,6 +19,10 @@
  * under the License.
  */
 
+/**@file
+ * Embedded python interpreter.
+ */
+
 #include <Python.h>
 #include <qpid/dispatch/dispatch.h>
 #include <qpid/dispatch/compose.h>

Modified: qpid/dispatch/trunk/include/qpid/dispatch/router.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/router.h?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/router.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/router.h Tue Jan 20 17:06:32 2015
@@ -19,8 +19,10 @@
  * under the License.
  */
 
-/** @defgroup router
- * 
+/**@file
+ * Register addresses, send messages.
+ *
+ * @defgroup router
  * Register addresses, send messages.
  */
 #include <qpid/dispatch/dispatch.h>

Modified: qpid/dispatch/trunk/include/qpid/dispatch/server.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/server.h?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/server.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/server.h Tue Jan 20 17:06:32 2015
@@ -22,6 +22,10 @@
 #include <qpid/dispatch/dispatch.h>
 #include <proton/engine.h>
 
+/**@file
+ * Control server threads, signals and connections.
+ */
+
 /**
  * @defgroup server
  *

Modified: qpid/dispatch/trunk/include/qpid/dispatch/threading.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/threading.h?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/threading.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/threading.h Tue Jan 20 17:06:32 2015
@@ -19,6 +19,10 @@
  * under the License.
  */
 
+/**@file
+ * Portable threading and locking API.
+ */
+
 typedef struct sys_mutex_t sys_mutex_t;
 
 sys_mutex_t *sys_mutex(void);

Modified: qpid/dispatch/trunk/include/qpid/dispatch/timer.h
URL: http://svn.apache.org/viewvc/qpid/dispatch/trunk/include/qpid/dispatch/timer.h?rev=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/timer.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/timer.h Tue Jan 20 17:06:32 2015
@@ -22,7 +22,9 @@
 #include <qpid/dispatch/dispatch.h>
 #include <qpid/dispatch/server.h>
 
-/**
+/**@file
+ * Server Timer Functions
+ * 
  * @defgroup timer
  *
  * Server Timer Functions

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=1653301&r1=1653300&r2=1653301&view=diff
==============================================================================
--- qpid/dispatch/trunk/include/qpid/dispatch/user_fd.h (original)
+++ qpid/dispatch/trunk/include/qpid/dispatch/user_fd.h Tue Jan 20 17:06:32 2015
@@ -22,7 +22,9 @@
 #include <qpid/dispatch/dispatch.h>
 #include <qpid/dispatch/server.h>
 
-/**
+/**@file
+ * Server User-File-Descriptor functions.
+ * 
  * @defgroup user_fd User FD
  *
  * Server User-File-Descriptor Functions
@@ -34,7 +36,7 @@ typedef struct qd_user_fd_t qd_user_fd_t
 
 /**
  * User_fd Handler
- *x
+ *
  * Callback invoked when a user-managed file descriptor is available for reading or writing
or there
  * was an error on the file descriptor.
  *



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


Mime
View raw message