From: g0dil <g0dil@270642c3-0616-0410-b53a-bc976706d245>
Date: Tue, 31 Jul 2007 12:32:56 +0000 (+0000)
Subject: Minor documentation fix
X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=c6cd064f971bf42f49af7841550d352fc9240520;p=senf.git

Minor documentation fix

git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@367 270642c3-0616-0410-b53a-bc976706d245
---

diff --git a/Socket/Protocols/INet/INet4Address.hh b/Socket/Protocols/INet/INet4Address.hh
index d00fb86..b2d466d 100644
--- a/Socket/Protocols/INet/INet4Address.hh
+++ b/Socket/Protocols/INet/INet4Address.hh
@@ -42,6 +42,12 @@ namespace senf {
         INet4Address represents a simple IP address. It is modelled as a fixed-size
         container/sequence of 4 bytes.
 
+        \implementation We awkwardly need to use static named constructors (<tt>from_</tt> members)
+            instead of ordinarily overloaded constructors for one simple reason: <tt>char *</tt>
+            doubles as string literal and as arbitrary data iterator. The iterator constructor can
+            therefore not be distinguished from initialization with a string literal. Therefore we
+            need to disambiguate using the named constructors.
+
         \todo Add additional classes for CIDR addresses and networks and network math.
         \ingroup addr_group
       */
diff --git a/Socket/Protocols/INet/INet6Address.hh b/Socket/Protocols/INet/INet6Address.hh
index 2b93f7b..097022b 100644
--- a/Socket/Protocols/INet/INet6Address.hh
+++ b/Socket/Protocols/INet/INet6Address.hh
@@ -81,6 +81,12 @@ namespace senf {
 
         \see CheckINet6Network Helper to check address against an arbitrary fixed network prefix
         \ingroup addr_group
+
+        \implementation We awkwardly need to use static named constructors (<tt>from_</tt> members)
+            instead of ordinarily overloaded constructors for one simple reason: <tt>char *</tt>
+            doubles as string literal and as arbitrary data iterator. The iterator constructor can
+            therefore not be distinguished from initialization with a string literal. Therefore we
+            need to disambiguate using the named constructors.
      */
     class INet6Address
         : public boost::array<boost::uint8_t,16>,
diff --git a/Socket/Protocols/Raw/MACAddress.hh b/Socket/Protocols/Raw/MACAddress.hh
index 367839d..8511bb2 100644
--- a/Socket/Protocols/Raw/MACAddress.hh
+++ b/Socket/Protocols/Raw/MACAddress.hh
@@ -46,6 +46,8 @@ namespace senf {
             doubles as string literal and as arbitrary data iterator. The iterator constructor can
             therefore not be distinguished from initialization with a string literal. Therefore we
             need to disambiguate using the named constructors.
+
+        \ingroup addr_group
      */
     struct MACAddress
         : public boost::array<boost::uint8_t,6>,