Fix documentation build under maverick (doxygen 1.7.1)
[senf.git] / senf / Socket / Protocols / Raw / EUI64.hh
index aa70d01..c76813d 100644 (file)
@@ -1,6 +1,6 @@
 // $Id$
 //
-// Copyright (C) 2009 
+// Copyright (C) 2009
 // Fraunhofer Institute for Open Communication Systems (FOKUS)
 // Competence Center NETwork research (NET), St. Augustin, GERMANY
 //     Stefan Bund <g0dil@berlios.de>
 #include <iostream>
 #include <boost/cstdint.hpp>
 #include <boost/array.hpp>
-#include "../../../Utils/Tags.hh"
-#include "../../../Utils/safe_bool.hh"
+#include <senf/Utils/Tags.hh>
+#include <senf/Utils/safe_bool.hh>
 
 //#include "EUI64.mpp"
-///////////////////////////////hh.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 
 namespace senf {
 
     class MACAddress;
 
     /** \brief EUI-64 data type
-        
+
         An EUI-64 is a 64 bit (8 octet) id. The id is represented as an 8 byte sequence in network
         byte order. An EUI64 can be converted from/to several other representations
 
@@ -78,9 +78,11 @@ namespace senf {
           public senf::comparable_safe_bool<EUI64>
     {
     public:
-        ///////////////////////////////////////////////////////////////////////////
+        //-////////////////////////////////////////////////////////////////////////
         ///\name Structors and default members
-        ///@{
+        //\{
+
+        static EUI64 const None;        ///< The empty (0) address
 
         // default copy constructor
         // default copy assignment
@@ -95,7 +97,7 @@ namespace senf {
         static EUI64 from_string(std::string const & s);
                                         ///< Construct EUI-64 from string representation
                                         /**< The string representation consists of 8 octets in
-                                             hexadecimal notation spearated by ':' or '-'
+                                             hexadecimal notation separated by ':' or '-'
                                              \throws senf::AddressSyntaxException */
         template <class InputIterator>
         static EUI64 from_data(InputIterator i);
@@ -103,8 +105,8 @@ namespace senf {
                                         /**< The iterator \a i must point to a sequence of 8
                                              octets in network byte order. */
 
-        ///@}
-        ///////////////////////////////////////////////////////////////////////////
+        //\}
+        //-////////////////////////////////////////////////////////////////////////
 
         bool isMACCompatible() const;   ///< \c true, if EUI64 is MAC compatible, \c false otherwise
                                         /**< An EUI64 is MAC compatible if bytes 4th and 5th byte
@@ -115,7 +117,7 @@ namespace senf {
                                           */
         bool group() const;             ///< \c true if the \e group bit is set, \c false otherwise
                                         /**< The \e group bit is the least significant bit of the
-                                             first octed (bit 7 in standard RFC bit numbering). */
+                                             first octet (bit 7 in standard RFC bit numbering). */
         bool boolean_test() const;      ///< \c true, if EUI64 is != 0, \c false otherwise
         boost::uint64_t uint64() const; ///< Return EUI64 as integer number
     };
@@ -132,7 +134,7 @@ namespace senf {
 
 }
 
-///////////////////////////////hh.e////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 #include "EUI64.cci"
 //#include "EUI64.ct"
 #include "EUI64.cti"