NEW FILE HEADER / COPYRIGHT FORMAT

[senf.git] / Socket / Protocols / Raw / LLAddressing.hh

diff --git a/Socket/Protocols/Raw/LLAddressing.hh b/Socket/Protocols/Raw/LLAddressing.hh
index bed2c13..e910b95 100644 (file)
--- a/Socket/Protocols/Raw/LLAddressing.hh
+++ b/Socket/Protocols/Raw/LLAddressing.hh
@@ -1,9 +1,9 @@
 // $Id$
 //
 // Copyright (C) 2006
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
-//     Stefan Bund <stefan.bund@fokus.fraunhofer.de>
+// Fraunhofer Institute for Open Communication Systems (FOKUS) 
+// Competence Center NETwork research (NET), St. Augustin, GERMANY 
+//     Stefan Bund <g0dil@berlios.de>
 //
 // This program is free software; you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
@@ -30,9 +30,9 @@
 // Custom includes
 #include <sys/socket.h>
 #include <netpacket/packet.h>
-#include "Socket/SocketPolicy.hh"
-#include "Socket/FileHandle.hh"
-#include "Socket/Protocols/GenericAddressingPolicy.hh"
+#include "../../../Socket/SocketPolicy.hh"
+#include "../../../Socket/FileHandle.hh"
+#include "../../../Socket/Protocols/GenericAddressingPolicy.hh"
 #include "MACAddress.hh"
 
 //#include "LLAddressing.mpp"
@@ -51,13 +51,14 @@ namespace senf {
         class only allows changing those fields which need to be changed. The other fields are
         read-only. They are filled by the operating system when receiving a packet
 
+        \nosubgrouping
      */
     class LLSocketAddress
     {
     public:
         /** \brief Valid pkttype() values
 
-            These are the possible values returned by arptype() 
+            These are the possible values returned by pkttype() 
          */
         enum PktType { Undefined = 0
                      , Host      = PACKET_HOST      /**< Packet destined for this host */
@@ -68,12 +69,16 @@ namespace senf {
                      , Outgoing  = PACKET_OUTGOING  /**< Packet sent out from this host */
         };
         
+        ///////////////////////////////////////////////////////////////////////////
+        ///\name Structors and default members
+        ///@{
+
         LLSocketAddress();              ///< Create empty address
         explicit LLSocketAddress(unsigned proto, std::string const & iface="");
                                         ///< 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()
@@ -90,6 +95,9 @@ namespace senf {
                                              \param addr Address to send data to
                                              \param iface Interface to send packet from */
 
+        ///@}
+        ///////////////////////////////////////////////////////////////////////////
+
         void clear();                   ///< Clear the address
 
         unsigned protocol() const;      ///< Return address protocol (ethertype)
@@ -102,7 +110,7 @@ namespace senf {
         // changing those members, which are sensible to be changed.
 
         void address(MACAddress const & addr); ///< Change address
-        void interface(std::string iface); ///< Change interface
+        void interface(std::string const & iface); ///< Change interface
         void protocol(unsigned prot);   ///< Change protocol
 
         ///\name Generic SocketAddress interface