Again some doc-build fixes
[senf.git] / Socket / SocketHandle.cc
index 186953a..f2225a8 100644 (file)
@@ -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 senf::SocketHandle non-inline non-template implementation
+ */
 
 #include "SocketHandle.hh"
 #include "SocketHandle.ih"
@@ -34,7 +36,7 @@
 #define prefix_
 ///////////////////////////////cc.p////////////////////////////////////////
 
-prefix_ void satcom::lib::SocketBody::v_close()
+prefix_ void senf::SocketBody::v_close()
 {
     if (::shutdown(fd(),SHUT_RDWR) < 0)
         throw SystemException(errno);
@@ -42,7 +44,7 @@ prefix_ void satcom::lib::SocketBody::v_close()
         throw SystemException(errno);
 }
 
-prefix_ void satcom::lib::SocketBody::v_terminate()
+prefix_ void senf::SocketBody::v_terminate()
 {
     struct linger ling;
     ling.l_onoff = 0;
@@ -56,13 +58,13 @@ prefix_ void satcom::lib::SocketBody::v_terminate()
     ::close(fd());
 }
 
-prefix_ bool satcom::lib::SocketBody::v_eof()
+prefix_ bool senf::SocketBody::v_eof()
     const
 {
     return protocol().eof();
 }
 
-prefix_ void satcom::lib::SocketBody::state(SocketStateMap & map, unsigned lod)
+prefix_ void senf::SocketBody::state(SocketStateMap & map, unsigned lod)
 {
     map["file.handle"] = fd();
     map["file.refcount"] = refcount();
@@ -73,7 +75,7 @@ prefix_ void satcom::lib::SocketBody::state(SocketStateMap & map, unsigned lod)
 }
 
 ///////////////////////////////////////////////////////////////////////////
-// satcom::lib::detail::StateMapOrdering
+// senf::detail::StateMapOrdering
 
 namespace {
     bool contains(std::string::iterator b, std::string::iterator e, char c)
@@ -85,7 +87,8 @@ namespace {
     }
 }
 
-prefix_ bool satcom::lib::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());
@@ -99,12 +102,14 @@ prefix_ bool satcom::lib::detail::StateMapOrdering::operator()(std::string a1, s
             return false;
         if (contains(i2,i2_end,'.'))
             // the longer string is a sub-'directory' of the shorter
+           /** \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 == '.' ? */
             return false;
         return *i1 < *i2;
     }
@@ -118,7 +123,7 @@ prefix_ bool satcom::lib::detail::StateMapOrdering::operator()(std::string a1, s
     return *i1 < *i2;
 }
 
-prefix_ std::string satcom::lib::detail::dumpState(SocketStateMap const & map)
+prefix_ std::string senf::detail::dumpState(SocketStateMap const & map)
 {
     std::stringstream s;
     SocketStateMap::const_iterator i (map.begin());
@@ -129,7 +134,7 @@ prefix_ std::string satcom::lib::detail::dumpState(SocketStateMap const & map)
 }
 
 template <class Policy>
-prefix_ std::ostream & satcom::lib::operator<<(std::ostream & os, SocketHandle<Policy> handle)
+prefix_ std::ostream & senf::operator<<(std::ostream & os, SocketHandle<Policy> handle)
 {
     os << handle.dumpState();
     return os;
@@ -142,5 +147,5 @@ prefix_ std::ostream & satcom::lib::operator<<(std::ostream & os, SocketHandle<P
 \f
 // Local Variables:
 // mode: c++
-// c-file-style: "satcom"
+// c-file-style: "senf"
 // End: