Fix documentation build under maverick (doxygen 1.7.1)
[senf.git] / senf / Scheduler / ReadHelper.hh
index 011b51a..2b70f54 100644 (file)
 #include <boost/intrusive_ptr.hpp>
 #include <boost/scoped_ptr.hpp>
 
-#include "../Utils/intrusive_refcount.hh"
-#include "Scheduler.hh"
+#include <senf/Utils/intrusive_refcount.hh>
+#include "FdEvent.hh"
 
 //#include "ReadHelper.mpp"
-///////////////////////////////hh.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 
 namespace senf {
 
 
-    /** \brief Asyncronous reading helper
+    /** \brief Asynchronous reading helper
 
         This class provides a simple asynchronous reading facility. This helper will register with
         the Scheduler and read incoming data. It will collect the data until a specific number of
@@ -70,15 +70,15 @@ namespace senf {
         : public senf::intrusive_refcount
     {
     public:
-        ///////////////////////////////////////////////////////////////////////////
+        //-////////////////////////////////////////////////////////////////////////
         // Types
 
         typedef boost::intrusive_ptr<ReadHelper> ptr; ///< Smart pointer type for this class
         typedef boost::function<void (ptr)> Callback; ///< Callback type
 
-        ///////////////////////////////////////////////////////////////////////////
+        //-////////////////////////////////////////////////////////////////////////
         ///\name Structors and default members
-        ///@{
+        //\{
 
         static ptr dispatch(Handle handle, std::string::size_type maxSize,
                             Callback callback); ///< Register new ReadHandler instance
@@ -109,8 +109,8 @@ namespace senf {
                                              \param[in] callback callback
                                              \returns smart pointer to new ReadHelper instance */
 
-        ///@}
-        ///////////////////////////////////////////////////////////////////////////
+        //\}
+        //-////////////////////////////////////////////////////////////////////////
 
         Handle handle() const;          ///< Access the handle object
         std::string::size_type maxSize() const; ///< Return maximum number of bytes to be read
@@ -129,7 +129,7 @@ namespace senf {
     private:
         struct InternalPredicate;
 
-        ReadHelper(Handle handle, std::string::size_type maxSize,  
+        ReadHelper(Handle handle, std::string::size_type maxSize,
                    InternalPredicate * predicate, Callback cb);
 
         static void dispatchProcess(ptr helper, Handle handle, int event);
@@ -165,7 +165,7 @@ namespace senf {
 
 }
 
-///////////////////////////////hh.e////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 #include "ReadHelper.cci"
 #include "ReadHelper.ct"
 #include "ReadHelper.cti"