Packets/DefaultBundle: Fix packet parser documentation using #ifndef DOXYGEN guards

[senf.git] / Packets / DefaultBundle / IpV6Packet.hh

diff --git a/Packets/DefaultBundle/IpV6Packet.hh b/Packets/DefaultBundle/IpV6Packet.hh
index b40ab92..112afdc 100644 (file)
--- a/Packets/DefaultBundle/IpV6Packet.hh
+++ b/Packets/DefaultBundle/IpV6Packet.hh
@@ -25,11 +25,7 @@
 #define HH_IpV6Packet_ 1
 
 // Custom includes
-#include "Packets/PacketType.hh"
-#include "Packets/ParseInt.hh"
-#include "Packets/PacketRegistry.hh"
-#include "Packets/PacketParser.hh"
-#include "Packets/ParseArray.hh"
+#include "Packets/Packets.hh"
 #include "IpV4Packet.hh"
 
 //#include "IpV6Packet.mpp"
@@ -37,13 +33,15 @@
 
 namespace senf {
 
-    // See RFC2460
-    struct Parse_IpV6 : public PacketParserBase
-    {
-        SENF_PACKET_PARSER_NO_INIT(Parse_IpV6);
+    /** \brief Parse an IpV6 packet
 
-        ///////////////////////////////////////////////////////////////////////////
+        Parser implementing the IpV6 header. The fields implemented are:
 
+        \see IpV6PacketType \n
+            <a href="http://tools.ietf.org/html/rfc2460">RFC 2460</a>
+     */
+    struct Parse_IpV6 : public PacketParserBase
+    {
         typedef Parse_UIntField <  0,  4 > Parse_Version;
         typedef Parse_UIntField <  4, 12 > Parse_Class;
         typedef Parse_UIntField < 12, 32 > Parse_FlowLabel;
@@ -52,6 +50,10 @@ namespace senf {
 
         typedef Parse_Array < 16, Parse_8bit > Parse_Addr;
 
+#       ifndef DOXYGEN
+
+        SENF_PACKET_PARSER_NO_INIT(Parse_IpV6);
+
         SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS(
             ((OverlayField)( version,      Parse_Version   ))
             ((OverlayField)( trafficClass, Parse_Class     ))
@@ -62,11 +64,37 @@ namespace senf {
             ((Field       )( source,       Parse_Addr      ))
             ((Field       )( destination,  Parse_Addr      )) );
 
+#       else
+
+        Parse_Version version();
+        Parse_Class trafficClass();
+        Parse_FlowLabel flowLabel();
+        Parse_16bit length();
+        Parse_8bit nextHeader();
+        Parse_8bit hopLimit();
+        Parse_Addr source();
+        Parse_Addr destination();
+
+#       endif
+
         void init() {
             version() = 6;
         }
     };
 
+    /** \brief IpV6 packet
+
+        \par Packet type (typedef):
+            \ref IpV6Packet
+        
+        \par Fields:
+            \ref Parse_IpV6
+
+        \par Associated registries:
+            \ref IpTypes
+
+        \ingroup protocolbundle_default
+     */
     struct IpV6PacketType
         : public PacketTypeBase,
           public PacketTypeMixin<IpV6PacketType, IpTypes>
@@ -86,11 +114,15 @@ namespace senf {
         static void dump(packet p, std::ostream & os);
     };
 
+    /** \brief IpV6 packet typedef */
     typedef IpV6PacketType::packet IpV6Packet;
 
+    ///@}
 }
 
 ///////////////////////////////hh.e////////////////////////////////////////
+#endif
+#ifndef SENF_PACKETS_DECL_ONLY
 //#include "IpV6Packet.cci"
 //#include "IpV6Packet.ct"
 //#include "IpV6Packet.cti"