Fix documentation build under maverick (doxygen 1.7.1)
[senf.git] / senf / Socket / Protocols / INet / INet4Address.hh
index 6651d68..be0d4db 100644 (file)
 #include <boost/cstdint.hpp>
 #include <boost/array.hpp>
 #include <boost/operators.hpp>
-#include "../../../Utils/safe_bool.hh"
-#include "../../../Utils/Tags.hh"
-#include "../AddressExceptions.hh"
+#include <senf/Utils/safe_bool.hh>
+#include <senf/Utils/Tags.hh>
 
 //#include "INet4Address.mpp"
-///////////////////////////////hh.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 
 namespace senf {
 
@@ -91,7 +90,7 @@ namespace senf {
           public comparable_safe_bool<INet4Address>
     {
     public:
-        ///////////////////////////////////////////////////////////////////////////
+        //-////////////////////////////////////////////////////////////////////////
         // Types
 
         typedef uint32_t address_type;  ///< Address representation as number in host byte order
@@ -101,9 +100,9 @@ namespace senf {
         static INet4Address const Loopback; ///< The loopback (127.0.0.1) address
         static INet4Address const Broadcast; ////< The global broadcast (255.255.255.255) address
 
-        ///////////////////////////////////////////////////////////////////////////
+        //-////////////////////////////////////////////////////////////////////////
         ///\name Structors and default members
-        ///@{
+        //\{
 
         INet4Address();                 ///< Construct an empty address
         explicit INet4Address(senf::NoInit_t); ///< Construct uninitialized (!) address
@@ -120,6 +119,8 @@ namespace senf {
                                                  protocol like DNS or NIS
                                              \throws AddressSyntaxException if the address cannot be
                                                  converted for some reason
+                                             \throws UnknownHostnameException if the hostname cannot
+                                                 be resolved
                                              \param[in] s Address literal or hostname */
 
         template <class InputIterator>
@@ -134,10 +135,10 @@ namespace senf {
                                              code to convert a network byte order address in an
                                              integer number into an INet4Address. */
 
-        ///@}
-        ///////////////////////////////////////////////////////////////////////////
+        //\}
+        //-////////////////////////////////////////////////////////////////////////
         ///\name Accessors
-        ///@{
+        //\{
 
         bool local() const;             ///< \c true, if address is locally administered
                                         /**< This call checks, if the address is within one of the
@@ -159,7 +160,7 @@ namespace senf {
                                         /**< This member returns the address as an integer number in
                                              host byte order. This representation allows simple
                                              network math operations. */
-        ////@}
+        //-/////////////////////////////////////////////////////////////////////////////////////////
 
     private:
         enum InAddr_t { IsInAddr };
@@ -180,7 +181,7 @@ namespace senf {
      */
     std::istream & operator>>(std::istream & os, INet4Address & addr);
 
-    /** \brief CHeck INet4Address against a fixed network prefix
+    /** \brief Check INet4Address against a fixed network prefix
 
         This helper allows to easily and efficiently check an INet4Address against an arbitrary but
         constant network prefix. The network prefix is represented by
@@ -219,17 +220,17 @@ namespace senf {
           public comparable_safe_bool<INet4Network>
     {
     public:
-        ///////////////////////////////////////////////////////////////////////////
+        //-////////////////////////////////////////////////////////////////////////
         ///\name Structors and default members
-        ///@{
+        //\{
 
         INet4Network();                 ///< Construct empty (0.0.0.0/0) network
         INet4Network(INet4Address const & address, unsigned prefix_len);
                                         ///< Construct network from given address and prefix length
         explicit INet4Network(std::string const & s); ///< Construct network from CIDR notation
 
-        ///@}
-        ///////////////////////////////////////////////////////////////////////////
+        //\}
+        //-////////////////////////////////////////////////////////////////////////
 
         INet4Address const & address() const; ///< Get the networks address
         unsigned prefix_len() const;    ///< Get the networks prefix length
@@ -278,6 +279,7 @@ namespace senf {
     std::ostream & operator<<(std::ostream & os, INet4Network const & addr);
 
     /** \brief Initialize INet4Address instance from a string representation
+
         sets std::ios::failbit on the stream if an error occurred
         \see INet4Address from_string()
         \related INet4Network
@@ -286,7 +288,7 @@ namespace senf {
 
 }
 
-///////////////////////////////hh.e////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 #include "INet4Address.cci"
 #include "INet4Address.ct"
 #include "INet4Address.cti"