From a5d46bdbb091849f1afddb18409f67eab4fc55aa Mon Sep 17 00:00:00 2001
From: g0dil <g0dil@wiback.org>
Date: Tue, 31 Jul 2007 12:32:56 +0000
Subject: [PATCH] Minor documentation fix
---
Socket/Protocols/INet/INet4Address.hh | 6 ++++++
Socket/Protocols/INet/INet6Address.hh | 6 ++++++
Socket/Protocols/Raw/MACAddress.hh | 2 ++
3 files changed, 14 insertions(+)
diff --git a/Socket/Protocols/INet/INet4Address.hh b/Socket/Protocols/INet/INet4Address.hh
index d00fb8667..b2d466d23 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 2b93f7b6a..097022b1f 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 367839d00..8511bb224 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>,
--
GitLab