removed some useless spaces; not very important, I know :)
[senf.git] / Packets / DefaultBundle / UDPPacket.hh
index 296597c..dc82ea2 100644 (file)
@@ -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
@@ -38,19 +38,19 @@ namespace senf {
 
         Parser implementing the UDP header. The fields implemented are:
 
-        \see UDPPacketType
+        \see UDPPacketType \n
             <a href="http://tools.ietf.org/html/rfc768">RFC 768</a>
      */
-    struct Parse_UDP : public PacketParserBase
+    struct UDPPacketParser : public PacketParserBase
     {
 #       include SENF_FIXED_PARSER()
 
-        SENF_PARSER_FIELD( source,      senf::Parse_UInt16 );
-        SENF_PARSER_FIELD( destination, senf::Parse_UInt16 );
-        SENF_PARSER_FIELD( length,      senf::Parse_UInt16 );
-        SENF_PARSER_FIELD( checksum,    senf::Parse_UInt16 );
+        SENF_PARSER_FIELD( source,      senf::UInt16Parser );
+        SENF_PARSER_FIELD( destination, senf::UInt16Parser );
+        SENF_PARSER_FIELD( length,      senf::UInt16Parser );
+        SENF_PARSER_FIELD( checksum,    senf::UInt16Parser );
 
-        SENF_PARSER_FINALIZE(Parse_UDP);
+        SENF_PARSER_FINALIZE(UDPPacketParser);
 
         boost::uint16_t calcChecksum() const;
 
@@ -65,7 +65,11 @@ namespace senf {
             \ref UDPPacket
 
         \par Fields:
-            \ref Parse_UDP
+            \ref UDPPacketParser
+
+        \par Finalize action:
+            Set \a length from payload size\n
+            Calculate \a checksum
 
         \ingroup protocolbundle_default
      */
@@ -73,10 +77,11 @@ namespace senf {
         : public PacketTypeBase,
           public PacketTypeMixin<UDPPacketType>
     {
+#ifndef DOXYGEN
         typedef PacketTypeMixin<UDPPacketType> mixin;
         typedef ConcretePacket<UDPPacketType> packet;
-        typedef Parse_UDP parser;
-
+        typedef UDPPacketParser parser;
+#endif
         using mixin::nextPacketRange;
         using mixin::initSize;
         using mixin::init;
@@ -87,7 +92,7 @@ namespace senf {
     };
 
     /** \brief UDP packet typedef */
-    typedef UDPPacketType::packet UDPPacket;
+    typedef ConcretePacket<UDPPacketType> UDPPacket;
 }