some documentation updates

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

diff --git a/Socket/Protocols/INet/INet4Address.cc b/Socket/Protocols/INet/INet4Address.cc
index 4d29a1d..ad51600 100644 (file)
--- a/Socket/Protocols/INet/INet4Address.cc
+++ b/Socket/Protocols/INet/INet4Address.cc
@@ -1,3 +1,5 @@
+// $Id$
+//
 // Copyright (C) 2007 
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)

diff --git a/Socket/Protocols/INet/INet4Address.cci b/Socket/Protocols/INet/INet4Address.cci
index 0f9e232..61b328f 100644 (file)
--- a/Socket/Protocols/INet/INet4Address.cci
+++ b/Socket/Protocols/INet/INet4Address.cci
@@ -1,3 +1,5 @@
+// $Id$
+//
 // Copyright (C) 2007 
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)

diff --git a/Socket/Protocols/INet/INet4Address.ct b/Socket/Protocols/INet/INet4Address.ct
index 0dd4857..648fdb8 100644 (file)
--- a/Socket/Protocols/INet/INet4Address.ct
+++ b/Socket/Protocols/INet/INet4Address.ct
@@ -1,3 +1,5 @@
+// $Id$
+//
 // Copyright (C) 2007 
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)

diff --git a/Socket/Protocols/INet/INet4Address.hh b/Socket/Protocols/INet/INet4Address.hh
index b2d466d..f40b6dc 100644 (file)
--- a/Socket/Protocols/INet/INet4Address.hh
+++ b/Socket/Protocols/INet/INet4Address.hh
@@ -1,3 +1,5 @@
+// $Id$
+//
 // Copyright (C) 2007 
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)

diff --git a/Socket/Protocols/INet/INet4Address.test.cc b/Socket/Protocols/INet/INet4Address.test.cc
index 36e84f4..6b7f84a 100644 (file)
--- a/Socket/Protocols/INet/INet4Address.test.cc
+++ b/Socket/Protocols/INet/INet4Address.test.cc
@@ -1,3 +1,5 @@
+// $Id$
+//
 // Copyright (C) 2007 
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)

diff --git a/Socket/Protocols/INet/INet6Address.cc b/Socket/Protocols/INet/INet6Address.cc
index 03f8944..7dfa642 100644 (file)
--- a/Socket/Protocols/INet/INet6Address.cc
+++ b/Socket/Protocols/INet/INet6Address.cc
@@ -1,3 +1,5 @@
+// $Id$
+//
 // Copyright (C) 2007 
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)

diff --git a/Socket/Protocols/INet/INet6Address.cci b/Socket/Protocols/INet/INet6Address.cci
index 029c4e8..c3072b0 100644 (file)
--- a/Socket/Protocols/INet/INet6Address.cci
+++ b/Socket/Protocols/INet/INet6Address.cci
@@ -1,3 +1,5 @@
+// $Id$
+//
 // Copyright (C) 2007 
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)

diff --git a/Socket/Protocols/INet/INet6Address.ct b/Socket/Protocols/INet/INet6Address.ct
index a93e78a..5e19703 100644 (file)
--- a/Socket/Protocols/INet/INet6Address.ct
+++ b/Socket/Protocols/INet/INet6Address.ct
@@ -1,3 +1,5 @@
+// $Id$
+//
 // Copyright (C) 2007 
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)

diff --git a/Socket/Protocols/INet/INet6Address.cti b/Socket/Protocols/INet/INet6Address.cti
index 9ab78ba..3d5ab8f 100644 (file)
--- a/Socket/Protocols/INet/INet6Address.cti
+++ b/Socket/Protocols/INet/INet6Address.cti
@@ -1,3 +1,5 @@
+// $Id$
+//
 // Copyright (C) 2007 
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)

diff --git a/Socket/Protocols/INet/INet6Address.hh b/Socket/Protocols/INet/INet6Address.hh
index 097022b..808e6b6 100644 (file)
--- a/Socket/Protocols/INet/INet6Address.hh
+++ b/Socket/Protocols/INet/INet6Address.hh
@@ -1,3 +1,5 @@
+// $Id$
+//
 // Copyright (C) 2007 
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
@@ -41,21 +43,26 @@ namespace senf {
 
     /** \brief IpV6 network address
 
-        This implementation of an IpV6 address is based strictly on RFC 4291: Internet Protocol
+        This implementation of an IpV6 address is based strictly on 
+        <a href="http://tools.ietf.org/html/rfc4291">RFC 4291</a>: Internet Protocol
         Version 6 (IPv6) Addressing Architecture. This class provides accessors to all the
         information fields defined in this document.
 
         The IpV6 addressing architecture however has several other components defined in other
         RFC's. These RFC's should be implemented in additional modules:
 
-        \li RFC4193: Unique Local Addresses (ULA). Defines the fc00::/7 prefix
-        \li RFC3306: Unicast-Prefix-based IPv6 Multicast Addresses. Defines the ff30::/12 prefix
-        \li RFC3956: Embedding the Rendezvous Point (RP) Address in an IPv6 Multicast
+        \li <a href="http://tools.ietf.org/html/rfc4193">RFC 4193</a>:
+            Unique Local Addresses (ULA). Defines the fc00::/7 prefix
+        \li <a href="http://tools.ietf.org/html/rfc3306">RFC 3306</a>:
+            Unicast-Prefix-based IPv6 Multicast Addresses. Defines the ff30::/12 prefix
+        \li <a href="http://tools.ietf.org/html/rfc3956">RFC 3956</a>:
+            Embedding the Rendezvous Point (RP) Address in an IPv6 Multicast
             Address. Defines the ff70::/12 prefix
-        \li RFC3056: Connection of IPv6 Domains via IPv4 Clouds. Defines 6to4 tunneling and the
+        \li <a href="http://tools.ietf.org/html/rfc3056">RFC 3056</a>:
+            Connection of IPv6 Domains via IPv4 Clouds. Defines 6to4 tunneling and the
             2002::/16 prefix
-        \li RFC3849: IPv6 Address Prefix Reserved for Documentation. Defines the 2001:db8::/32
-            prefix
+        \li <a href="http://tools.ietf.org/html/rfc3849">RFC 3849</a>:
+            IPv6 Address Prefix Reserved for Documentation. Defines the 2001:db8::/32 prefix
         
         Here an overview of well-known prefixes:
 
@@ -110,8 +117,9 @@ namespace senf {
         /** \brief Possible scope values
 
             List of all possible scope values. This list includes all scope values defined for
-            multicast addresses in RFC4291. The values \ref LinkScope, \ref SiteScope and \ref
-            GlobalScope are also used with unicast addresses.
+            multicast addresses in <a href="http://tools.ietf.org/html/rfc4291">RFC 4291</a>. 
+            The values \ref LinkScope, \ref SiteScope and \ref GlobalScope are also used with 
+            unicast addresses.
          */
         enum ScopeId {
               InterfaceScope    =  1    /**< Interface only scope */
@@ -184,7 +192,9 @@ namespace senf {
                                         /**< This will construct an address of the form
                                              <tt>::FFFF::w.x.y.z</tt> where <tt>w.x.y.z</tt> is
                                              the INet4Address value. This kind of address is called
-                                             an IpV6-mapped IpV4 address (see RFC4291). \par
+                                             an IpV6-mapped IpV4 address (see 
+                                             <a href="http://tools.ietf.org/html/rfc4291">RFC 4291</a>).
+                                             \par 
                                              IpV4 compatible IpV6 addresses are not directly
                                              supported, they are deprecated in the RFC. */
         ///@}
@@ -225,14 +235,18 @@ namespace senf {
 
         bool globalMulticastAddr() const; ///< \c true, if T bit is \e not set
                                         /**< Any multicast address with a cleared T bit must be
-                                             globally assigned. See RFC4291. */
+                                             globally assigned. See 
+                                             <a href="http://tools.ietf.org/html/rfc4291">RFC 4291</a>. */
         bool prefixMulticastAddr() const; ///< \c true, if P bit is set
-                                        /**< In RFC4291, the P bit is specified as defining a
-                                             unicast prefix based multicast address. See RFC3306. */ 
+                                        /**< In <a href="http://tools.ietf.org/html/rfc4291">RFC 4291</a>,
+                                             the P bit is specified as defining a
+                                             unicast prefix based multicast address. See 
+                                             <a href="http://tools.ietf.org/html/rfc3306">RFC 3306</a>. */ 
         bool embeddedRpAddr() const;    ///< \c true, if R bit is set
-                                        /** In RFC4291, the R bit is specified as defining a
-                                            multicast address with embedded rendezvous point. See
-                                            RFC3956. */
+                                        /**< In <a href="http://tools.ietf.org/html/rfc4291">RFC 4291</a>,
+                                             the R bit is specified as defining a multicast address 
+                                             with embedded rendezvous point. See
+                                             <a href="http://tools.ietf.org/html/rfc3956">RFC 3956</a>. */
 
         bool boolean_test() const;      ///< \c true, if address != '::' (None)
 

diff --git a/Socket/Protocols/INet/INet6Address.ih b/Socket/Protocols/INet/INet6Address.ih
index 1dc03ff..782880d 100644 (file)
--- a/Socket/Protocols/INet/INet6Address.ih
+++ b/Socket/Protocols/INet/INet6Address.ih
@@ -1,3 +1,5 @@
+// $Id$
+//
 // Copyright (C) 2007 
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)

diff --git a/Socket/Protocols/INet/INet6Address.test.cc b/Socket/Protocols/INet/INet6Address.test.cc
index 22340c8..240e1d4 100644 (file)
--- a/Socket/Protocols/INet/INet6Address.test.cc
+++ b/Socket/Protocols/INet/INet6Address.test.cc
@@ -1,3 +1,5 @@
+// $Id$
+//
 // Copyright (C) 2007 
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)

diff --git a/Socket/Protocols/INet/UDPSocketHandle.test.cc b/Socket/Protocols/INet/UDPSocketHandle.test.cc
index f251e45..939763b 100644 (file)
--- a/Socket/Protocols/INet/UDPSocketHandle.test.cc
+++ b/Socket/Protocols/INet/UDPSocketHandle.test.cc
@@ -1,3 +1,5 @@
+// $Id$
+//
 // Copyright (C) 2007 
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)

diff --git a/Socket/Protocols/Raw/LLAddressing.hh b/Socket/Protocols/Raw/LLAddressing.hh
index 0a36fbe..90bbafc 100644 (file)
--- a/Socket/Protocols/Raw/LLAddressing.hh
+++ b/Socket/Protocols/Raw/LLAddressing.hh
@@ -73,7 +73,7 @@ namespace senf {
                                         ///< Create address for \c bind()
                                         /**< This constructs an LLSocketAddress valid for calling
                                              PacketSocketHandle::bind() with.
-                                             \param[in] prot Protocol (Ethertype) to listen for
+                                             \param[in] proto Protocol (Ethertype) to listen for
                                              \param[in] iface Interface name to bind to */
         explicit LLSocketAddress(std::string const &iface);
                                         ///< Create address for \c bind()

diff --git a/Utils/Buffer.hh b/Utils/Buffer.hh
index aa4bba9..7cf9626 100644 (file)
--- a/Utils/Buffer.hh
+++ b/Utils/Buffer.hh
@@ -1,3 +1,5 @@
+// $Id$
+//
 // Copyright (C) 2007 
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)

diff --git a/Utils/IteratorTraits.hh b/Utils/IteratorTraits.hh
index 9da7602..1353a5c 100644 (file)
--- a/Utils/IteratorTraits.hh
+++ b/Utils/IteratorTraits.hh
@@ -1,3 +1,5 @@
+// $Id$
+//
 // Copyright (C) 2007 
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)

diff --git a/Utils/IteratorTraits.ih b/Utils/IteratorTraits.ih
index 1abcb6a..780490e 100644 (file)
--- a/Utils/IteratorTraits.ih
+++ b/Utils/IteratorTraits.ih
@@ -1,3 +1,5 @@
+// $Id$
+//
 // Copyright (C) 2007 
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)

diff --git a/Utils/Logger.hh b/Utils/Logger.hh
index 7b568e8..99880a8 100644 (file)
--- a/Utils/Logger.hh
+++ b/Utils/Logger.hh
@@ -1,3 +1,5 @@
+// $Id$
+//
 // Copyright (C) 2007
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)

diff --git a/Utils/SafeBool.hh b/Utils/SafeBool.hh
index 7781e1d..eb116da 100644 (file)
--- a/Utils/SafeBool.hh
+++ b/Utils/SafeBool.hh
@@ -1,3 +1,5 @@
+// $Id$
+//
 // Copyright (C) 2007 
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)

diff --git a/Utils/pool_alloc_mixin.hh b/Utils/pool_alloc_mixin.hh
index 6154873..acf36b6 100644 (file)
--- a/Utils/pool_alloc_mixin.hh
+++ b/Utils/pool_alloc_mixin.hh
@@ -1,3 +1,5 @@
+// $Id$
+//
 // Copyright (C) 2007 
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
@@ -42,7 +44,7 @@ namespace senf {
         default. Using this allocator does however introduce a few restrictions:
 
         \li The operator is defined for a fixed size. Therefore if you derive from the class <b>you
-            must not change it's size</t>.
+            must not change it's size</b>.
         \li If you change the size of the class in a derived class you have to derive from
             pool_alloc_mixin again.
 

diff --git a/Utils/singleton.hh b/Utils/singleton.hh
index ade1fa3..24cb1e0 100644 (file)
--- a/Utils/singleton.hh
+++ b/Utils/singleton.hh
@@ -1,3 +1,5 @@
+// $Id$
+//
 // Copyright (C) 2007 
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)