Complete Socket library documentation

[senf.git] / Socket / SocketHandle.cc

diff --git a/Socket/SocketHandle.cc b/Socket/SocketHandle.cc
index 1400d35..807639b 100644 (file)
--- a/Socket/SocketHandle.cc
+++ b/Socket/SocketHandle.cc
@@ -20,7 +20,9 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
-// Definition of non-inline non-template functions
+/** \file
+    \brief SocketHandle non-inline non-template implementation
+ */
 
 #include "SocketHandle.hh"
 #include "SocketHandle.ih"
@@ -76,7 +78,7 @@ prefix_ void senf::SocketBody::state(SocketStateMap & map, unsigned lod)
 // senf::detail::StateMapOrdering
 
 namespace {
-    bool contains(std::string::iterator b, std::string::iterator e, char c)
+    bool contains(std::string::const_iterator b, std::string::const_iterator e, char c)
     {
         for (; b != e; ++b)
             if (*b == c)
@@ -85,13 +87,14 @@ namespace {
     }
 }
 
-prefix_ bool senf::detail::StateMapOrdering::operator()(std::string a1, std::string a2)
+prefix_ bool senf::detail::StateMapOrdering::operator()(std::string const & a1,
+                                                        std::string const & a2)
     const
 {
-    std::string::iterator i1 (a1.begin());
-    std::string::iterator const i1_end (a1.end());
-    std::string::iterator i2 (a2.begin());
-    std::string::iterator const i2_end (a2.end());
+    std::string::const_iterator i1 (a1.begin());
+    std::string::const_iterator const i1_end (a1.end());
+    std::string::const_iterator i2 (a2.begin());
+    std::string::const_iterator const i2_end (a2.end());
     for(; i1 != i1_end && i2 != i2_end && *i1 == *i2; ++i1, ++i2) ;
     if (i1 == i1_end) {
         if (i2 == i2_end)
@@ -99,14 +102,14 @@ prefix_ bool senf::detail::StateMapOrdering::operator()(std::string a1, std::str
             return false;
         if (contains(i2,i2_end,'.'))
             // the longer string is a sub-'directory' of the shorter
-           // FIXME: shouldn't this be *i2 == '.' ?
+           /** \fixme shouldn't this be *i2 == '.' ? */
             return true;
         return *i1 < *i2;
     }
     else if (i2 == i2_end) { // && i1 != i1_end
         if (contains(i1,i1_end,'.'))
             // the longer string is a sub-'directory' of the shorter
-           // FIXME: shouldn't this be *i1 == '.' ?
+           /** \fixme shouldn't this be *i1 == '.' ? */
             return false;
         return *i1 < *i2;
     }