Fix documentation build under maverick (doxygen 1.7.1)
[senf.git] / senf / Socket / FileHandle.hh
index 6b9bfb9..526cb63 100644 (file)
 
 /** \defgroup handle_group The Handle Hierarchy
 
-    <div class="diamap" name="FhHierarchy">
-    <span coords="233,47,438,89">\ref SocketHandle</span>
-    <span coords="32,126,281,168">\ref ClientSocketHandle</span>
-    <span coords="0,187,326,229">\ref ProtocolClientSocketHandle</span>
-    <span coords="350,187,684,229">\ref ProtocolServerSocketHandle</span>
-    <span coords="243,0,343,28">\ref FileHandle</span>
-    <span coords="382,126,638,168">\ref ServerSocketHandle</span>
-    </div>
-    \htmlonly <img src="FhHierarchy.png" border="0" alt="FhHierarchy" usemap="#FhHierarchy"> \endhtmlonly
+    \diaimage FhHierarchy.dia
 
     The senf::FileHandle class is the base of a hierarchy of socket handle classes (realized as
     templates). These classes provide an interface to the complete socket API. While going down the
 #include <senf/Scheduler/ClockService.hh>
 
 //#include "FileHandle.mpp"
-///////////////////////////////hh.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 #include "FileHandle.ih"
 
 namespace senf {
 
     /// \addtogroup handle_group
-    /// @{
+    //\{
 
     /** \brief Basic file handle wrapper
 
@@ -112,12 +104,12 @@ namespace senf {
         : public safe_bool<FileHandle>
     {
     public:
-        ///////////////////////////////////////////////////////////////////////////
+        //-////////////////////////////////////////////////////////////////////////
         // Types
 
-        ///////////////////////////////////////////////////////////////////////////
+        //-////////////////////////////////////////////////////////////////////////
         ///\name Structors and default members
-        ///@{
+        //\{
 
         FileHandle();
         ~FileHandle();
@@ -129,8 +121,8 @@ namespace senf {
 
         // no conversion constructors
 
-        ///@}
-        ///////////////////////////////////////////////////////////////////////////
+        //\}
+        //-////////////////////////////////////////////////////////////////////////
 
         void close();                ///< Close filehandle
                                      /**< \throws senf::SystemException */
@@ -138,11 +130,11 @@ namespace senf {
 
         bool readable() const;       ///< Check, whether a read on the handle would not block
                                      ///< (ignoring blocking state)
-        bool waitReadable(senf::ClockService::clock_type timeout = -1) const;  
+        bool waitReadable(senf::ClockService::clock_type timeout = -1) const;
                                      ///< Wait, until read on the handle would not block (ignoring
                                      ///< blocking state)
                                      /**< \param[in] timeout max time to wait, default is to wait
-                                              forever.  
+                                              forever.
                                           \returns \c true, if handle became readable or \c false on
                                               timeout. */
         bool writeable() const;      ///< Check, whether a write on the handle would not block
@@ -151,16 +143,16 @@ namespace senf {
                                      ///< Wait, until a write on the handle would not block
                                      ///< (ignoring blocking state)
                                      /**< \param[in] timeout max time to wait, default is to wait
-                                              forever.  
+                                              forever.
                                           \returns \c true, if handle became writable or \c false on
                                               timeout. */
-        bool oobReadable() const;    ///< Check, whether a read of prioritized data on the handle 
+        bool oobReadable() const;    ///< Check, whether a read of prioritized data on the handle
                                      ///< would not block (ignoring blocking state)
-        bool waitOOBReadable(senf::ClockService::clock_type timeout = -1) const; 
+        bool waitOOBReadable(senf::ClockService::clock_type timeout = -1) const;
                                      ///< Wait, until read of prioritized data on the handle does
                                      ///< not block (ignoring blocking state)
                                      /**< \param[in] timeout max time to wait, default is to wait
-                                              forever.  
+                                              forever.
                                           \returns \c true, if handle became readable for
                                               out-of-band data or \c false on timeout. */
 
@@ -225,11 +217,11 @@ namespace senf {
      */
     int retrieve_filehandle(FileHandle handle);
 
-    /// @}
+    //\}
 
 }
 
-///////////////////////////////hh.e////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 #include "FileHandle.cci"
 //#include "FileHandle.ct"
 //#include "FileHandle.cti"