[Boost-commit] svn:boost r44670 - trunk/boost/asio

From: chris_at_[hidden]
Date: 2008-04-20 22:01:35

Author: chris_kohlhoff
Date: 2008-04-20 22:01:34 EDT (Sun, 20 Apr 2008)
New Revision: 44670
URL: http://svn.boost.org/trac/boost/changeset/44670

Log:
Improve documentation for the protected functions and data in basic_io_object<>.

Text files modified: 
   trunk/boost/asio/basic_io_object.hpp |    12 ++++++++++--                            
   1 files changed, 10 insertions(+), 2 deletions(-)

Modified: trunk/boost/asio/basic_io_object.hpp
==============================================================================
--- trunk/boost/asio/basic_io_object.hpp	(original)
+++ trunk/boost/asio/basic_io_object.hpp	2008-04-20 22:01:34 EDT (Sun, 20 Apr 2008)
@@ -64,6 +64,10 @@
 
 protected:
   /// Construct a basic_io_object.
+  /**
+   * Performs:
+   * @code service.construct(implementation); @endcode
+   */
   explicit basic_io_object(boost::asio::io_service& io_service)
     : service(boost::asio::use_service<IoObjectService>(io_service))
   {
@@ -71,15 +75,19 @@
   }
 
   /// Protected destructor to prevent deletion through this type.
+  /**
+   * Performs:
+   * @code service.destroy(implementation); @endcode
+   */
   ~basic_io_object()
   {
     service.destroy(implementation);
   }
 
-  // The backend service implementation.
+  /// The service associated with the I/O object.
   service_type& service;
 
-  // The underlying native implementation.
+  /// The underlying implementation of the I/O object.
   implementation_type implementation;
 };