Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r48715 - in trunk: boost/asio/ip libs/asio/doc
From: chris_at_[hidden]
Date: 2008-09-10 20:05:58


Author: chris_kohlhoff
Date: 2008-09-10 20:05:57 EDT (Wed, 10 Sep 2008)
New Revision: 48715
URL: http://svn.boost.org/trac/boost/changeset/48715

Log:
Clarify which resolve functions perform forward or reverse resolution.

Text files modified:
   trunk/boost/asio/ip/basic_resolver.hpp | 13 +++++++------
   trunk/libs/asio/doc/reference.qbk | 32 ++++++++++++++++----------------
   2 files changed, 23 insertions(+), 22 deletions(-)

Modified: trunk/boost/asio/ip/basic_resolver.hpp
==============================================================================
--- trunk/boost/asio/ip/basic_resolver.hpp (original)
+++ trunk/boost/asio/ip/basic_resolver.hpp 2008-09-10 20:05:57 EDT (Wed, 10 Sep 2008)
@@ -76,7 +76,7 @@
     return this->service.cancel(this->implementation);
   }
 
- /// Resolve a query to a list of entries.
+ /// Perform forward resolution of a query to a list of entries.
   /**
    * This function is used to resolve a query into a list of endpoint entries.
    *
@@ -100,7 +100,7 @@
     return i;
   }
 
- /// Resolve a query to a list of entries.
+ /// Perform forward resolution of a query to a list of entries.
   /**
    * This function is used to resolve a query into a list of endpoint entries.
    *
@@ -122,7 +122,7 @@
     return this->service.resolve(this->implementation, q, ec);
   }
 
- /// Asynchronously resolve a query to a list of entries.
+ /// Asynchronously perform forward resolution of a query to a list of entries.
   /**
    * This function is used to asynchronously resolve a query into a list of
    * endpoint entries.
@@ -154,7 +154,7 @@
     return this->service.async_resolve(this->implementation, q, handler);
   }
 
- /// Resolve an endpoint to a list of entries.
+ /// Perform reverse resolution of an endpoint to a list of entries.
   /**
    * This function is used to resolve an endpoint into a list of endpoint
    * entries.
@@ -180,7 +180,7 @@
     return i;
   }
 
- /// Resolve an endpoint to a list of entries.
+ /// Perform reverse resolution of an endpoint to a list of entries.
   /**
    * This function is used to resolve an endpoint into a list of endpoint
    * entries.
@@ -204,7 +204,8 @@
     return this->service.resolve(this->implementation, e, ec);
   }
 
- /// Asynchronously resolve an endpoint to a list of entries.
+ /// Asynchronously perform reverse resolution of an endpoint to a list of
+ /// entries.
   /**
    * This function is used to asynchronously resolve an endpoint into a list of
    * endpoint entries.

Modified: trunk/libs/asio/doc/reference.qbk
==============================================================================
--- trunk/libs/asio/doc/reference.qbk (original)
+++ trunk/libs/asio/doc/reference.qbk 2008-09-10 20:05:57 EDT (Wed, 10 Sep 2008)
@@ -35483,7 +35483,7 @@
 
   [
     [[link boost_asio.reference.ip__basic_resolver.async_resolve [*async_resolve]]]
- [Asynchronously resolve a query to a list of entries. ]
+ [Asynchronously perform forward resolution of a query to a list of entries. ]
   ]
   
   [
@@ -35508,7 +35508,7 @@
   
   [
     [[link boost_asio.reference.ip__basic_resolver.resolve [*resolve]]]
- [Resolve a query to a list of entries. ]
+ [Perform forward resolution of a query to a list of entries. ]
   ]
   
 ]
@@ -35541,7 +35541,7 @@
 
 [section:async_resolve ip::basic_resolver::async_resolve]
 
-[indexterm2 async_resolve..ip::basic_resolver] Asynchronously resolve a query to a list of entries.
+[indexterm2 async_resolve..ip::basic_resolver] Asynchronously perform forward resolution of a query to a list of entries.
 
   template<
       typename ``[link boost_asio.reference.ResolveHandler ResolveHandler]``>
@@ -35558,7 +35558,7 @@
 
 [section:overload1 ip::basic_resolver::async_resolve (1 of 2 overloads)]
 
-Asynchronously resolve a query to a list of entries.
+Asynchronously perform forward resolution of a query to a list of entries.
 
   template<
       typename ``[link boost_asio.reference.ResolveHandler ResolveHandler]``>
@@ -35603,7 +35603,7 @@
 
 [section:overload2 ip::basic_resolver::async_resolve (2 of 2 overloads)]
 
-Asynchronously resolve an endpoint to a list of entries.
+Asynchronously perform reverse resolution of an endpoint to a list of entries.
 
   template<
       typename ``[link boost_asio.reference.ResolveHandler ResolveHandler]``>
@@ -35818,7 +35818,7 @@
 
 [section:resolve ip::basic_resolver::resolve]
 
-[indexterm2 resolve..ip::basic_resolver] Resolve a query to a list of entries.
+[indexterm2 resolve..ip::basic_resolver] Perform forward resolution of a query to a list of entries.
 
   iterator ``[link boost_asio.reference.ip__basic_resolver.resolve.overload1 resolve]``(
       const query & q);
@@ -35837,7 +35837,7 @@
 
 [section:overload1 ip::basic_resolver::resolve (1 of 4 overloads)]
 
-Resolve a query to a list of entries.
+Perform forward resolution of a query to a list of entries.
 
   iterator resolve(
       const query & q);
@@ -35881,7 +35881,7 @@
 
 [section:overload2 ip::basic_resolver::resolve (2 of 4 overloads)]
 
-Resolve a query to a list of entries.
+Perform forward resolution of a query to a list of entries.
 
   iterator resolve(
       const query & q,
@@ -35919,7 +35919,7 @@
 
 [section:overload3 ip::basic_resolver::resolve (3 of 4 overloads)]
 
-Resolve an endpoint to a list of entries.
+Perform reverse resolution of an endpoint to a list of entries.
 
   iterator resolve(
       const endpoint_type & e);
@@ -35963,7 +35963,7 @@
 
 [section:overload4 ip::basic_resolver::resolve (4 of 4 overloads)]
 
-Resolve an endpoint to a list of entries.
+Perform reverse resolution of an endpoint to a list of entries.
 
   iterator resolve(
       const endpoint_type & e,
@@ -37053,7 +37053,7 @@
 
   [
     [[link boost_asio.reference.ip__basic_resolver.async_resolve [*async_resolve]]]
- [Asynchronously resolve a query to a list of entries. ]
+ [Asynchronously perform forward resolution of a query to a list of entries. ]
   ]
   
   [
@@ -37078,7 +37078,7 @@
   
   [
     [[link boost_asio.reference.ip__basic_resolver.resolve [*resolve]]]
- [Resolve a query to a list of entries. ]
+ [Perform forward resolution of a query to a list of entries. ]
   ]
   
 ]
@@ -39149,7 +39149,7 @@
 
   [
     [[link boost_asio.reference.ip__basic_resolver.async_resolve [*async_resolve]]]
- [Asynchronously resolve a query to a list of entries. ]
+ [Asynchronously perform forward resolution of a query to a list of entries. ]
   ]
   
   [
@@ -39174,7 +39174,7 @@
   
   [
     [[link boost_asio.reference.ip__basic_resolver.resolve [*resolve]]]
- [Resolve a query to a list of entries. ]
+ [Perform forward resolution of a query to a list of entries. ]
   ]
   
 ]
@@ -40116,7 +40116,7 @@
 
   [
     [[link boost_asio.reference.ip__basic_resolver.async_resolve [*async_resolve]]]
- [Asynchronously resolve a query to a list of entries. ]
+ [Asynchronously perform forward resolution of a query to a list of entries. ]
   ]
   
   [
@@ -40141,7 +40141,7 @@
   
   [
     [[link boost_asio.reference.ip__basic_resolver.resolve [*resolve]]]
- [Resolve a query to a list of entries. ]
+ [Perform forward resolution of a query to a list of entries. ]
   ]
   
 ]


Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk