[Boost-commit] svn:boost r72406 - trunk/libs/asio/doc

Subject: [Boost-commit] svn:boost r72406 - trunk/libs/asio/doc
From: chris_at_[hidden]
Date: 2011-06-05 10:09:06

Author: chris_kohlhoff
Date: 2011-06-05 10:09:04 EDT (Sun, 05 Jun 2011)
New Revision: 72406
URL: http://svn.boost.org/trac/boost/changeset/72406

Log:
Include the io_service::service class's private member functions in the documentation.

Text files modified: 
   trunk/libs/asio/doc/reference.dox |     3 +                                       
   trunk/libs/asio/doc/reference.qbk |    47 ++++++++++++++++++++++++++++++++        
   trunk/libs/asio/doc/reference.xsl |    58 ++++++++++++++++++++++++++++++++++++++++
   3 files changed, 107 insertions(+), 1 deletions(-)

Modified: trunk/libs/asio/doc/reference.dox
==============================================================================
--- trunk/libs/asio/doc/reference.dox	(original)
+++ trunk/libs/asio/doc/reference.dox	2011-06-05 10:09:04 EDT (Sun, 05 Jun 2011)
@@ -194,7 +194,8 @@
                          BOOST_ASIO_NETDB_ERROR(e)=implementation_defined \
                          BOOST_ASIO_EOF_ERROR(e)=implementation_defined \
                          BOOST_ASIO_OS_ERROR(e1,e2)=implementation_defined \
-                         BOOST_ASIO_MOVE_ARG(a)=a
+                         BOOST_ASIO_MOVE_ARG(a)=a \
+                         BOOST_ASIO_DECL=
 EXPAND_AS_DEFINED      = 
 SKIP_FUNCTION_MACROS   = YES
 #---------------------------------------------------------------------------

Modified: trunk/libs/asio/doc/reference.qbk
==============================================================================
--- trunk/libs/asio/doc/reference.qbk	(original)
+++ trunk/libs/asio/doc/reference.qbk	2011-06-05 10:09:04 EDT (Sun, 05 Jun 2011)
@@ -54036,6 +54036,22 @@
   
 ]
 
+[heading Private Member Functions]
+[table
+  [[Name][Description]]
+
+  [
+    [[link boost_asio.reference.io_service__service.fork_service [*fork_service]]]
+    [Handle notification of a fork-related event to perform any necessary housekeeping. ]
+  ]
+  
+  [
+    [[link boost_asio.reference.io_service__service.shutdown_service [*shutdown_service]]]
+    [Destroy all user-defined handler objects owned by the service. ]
+  ]
+  
+]
+
 [heading Requirements]
 
 [*Header: ][^boost/asio/io_service.hpp]
@@ -54098,6 +54114,37 @@
 
 
 
+[section:fork_service io_service::service::fork_service]
+
+[indexterm2 fork_service..io_service::service] 
+Handle notification of a fork-related event to perform any necessary housekeeping. 
+
+
+  virtual void fork_service(
+      boost::asio::io_service::fork_event event);
+
+
+This function is not a pure virtual so that services only have to implement it if necessary. The default implementation does nothing. 
+
+
+[endsect]
+
+
+
+[section:shutdown_service io_service::service::shutdown_service]
+
+[indexterm2 shutdown_service..io_service::service] 
+Destroy all user-defined handler objects owned by the service. 
+
+
+  void shutdown_service();
+
+
+
+[endsect]
+
+
+
 [endsect]
 
 [section:io_service__strand io_service::strand]

Modified: trunk/libs/asio/doc/reference.xsl
==============================================================================
--- trunk/libs/asio/doc/reference.xsl	(original)
+++ trunk/libs/asio/doc/reference.xsl	2011-06-05 10:09:04 EDT (Sun, 05 Jun 2011)
@@ -944,6 +944,56 @@
 ]
 </xsl:if>
 
+<xsl:if test="$class-name = 'io_service::service'">
+<xsl:if test="count(sectiondef[@kind='private-func']) > 0">
+[heading Private Member Functions]
+[table
+  [[Name][Description]]
+<xsl:for-each select="sectiondef[@kind='private-func']/memberdef" mode="class-table">
+  <xsl:sort select="name"/>
+  <xsl:variable name="name">
+    <xsl:value-of select="name"/>
+  </xsl:variable>
+  <xsl:variable name="id">
+    <xsl:call-template name="make-id">
+      <xsl:with-param name="name" select="$name"/>
+    </xsl:call-template>
+  </xsl:variable>
+  <xsl:variable name="doxygen-id">
+    <xsl:value-of select="@id"/>
+  </xsl:variable>
+  <xsl:variable name="overload-count">
+    <xsl:value-of select="count(../memberdef[name = $name])"/>
+  </xsl:variable>
+  <xsl:variable name="overload-position">
+    <xsl:for-each select="../memberdef[name = $name]">
+      <xsl:if test="@id = $doxygen-id">
+        <xsl:value-of select="position()"/>
+      </xsl:if>
+    </xsl:for-each>
+  </xsl:variable>
+  <xsl:if test="$overload-position = 1">
+  [
+    [[link boost_asio.reference.<xsl:value-of select="$class-id"/>.<xsl:value-of select="$id"/>
+      <xsl:text> </xsl:text>[*<xsl:value-of select="$name"/><xsl:text>]]]
+    [</xsl:text><xsl:value-of select="briefdescription"/>
+  </xsl:if>
+  <xsl:if test="not($overload-position = 1) and not(briefdescription = preceding-sibling::*/briefdescription)">
+    <xsl:value-of select="$newline"/>
+    <xsl:value-of select="$newline"/>
+    <xsl:text>     </xsl:text>
+    <xsl:value-of select="briefdescription"/>
+  </xsl:if>
+  <xsl:if test="$overload-position = $overload-count">
+  <xsl:text>]
+  ]
+  </xsl:text>
+  </xsl:if>
+</xsl:for-each>
+]
+</xsl:if>
+</xsl:if>
+
 <xsl:if test="count(sectiondef[@kind='public-attrib' or @kind='public-static-attrib']) > 0">
 [heading Data Members]
 [table
@@ -1083,6 +1133,14 @@
   <xsl:with-param name="class-id" select="$class-id"/>
   <xsl:with-param name="class-file" select="$class-file"/>
 </xsl:apply-templates>
+<xsl:if test="$class-name = 'io_service::service'">
+  <xsl:apply-templates select="sectiondef[@kind='private-func']/memberdef[not(type = 'friend class') and not(contains(name, '_helper'))]" mode="class-detail">
+    <xsl:sort select="name"/>
+    <xsl:with-param name="class-name" select="$class-name"/>
+    <xsl:with-param name="class-id" select="$class-id"/>
+    <xsl:with-param name="class-file" select="$class-file"/>
+  </xsl:apply-templates>
+</xsl:if>
 </xsl:template>