simplified (hopefully) to documentation for the PacketTypes
tho [Tue, 13 Nov 2007 15:35:45 +0000 (15:35 +0000)]
git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@513 270642c3-0616-0410-b53a-bc976706d245

Packets/DefaultBundle/EthernetPacket.hh
Packets/DefaultBundle/IpV4Packet.hh
Packets/DefaultBundle/IpV6Extensions.hh
Packets/DefaultBundle/IpV6Packet.hh
Packets/DefaultBundle/UDPPacket.hh
Packets/MPEGDVBBundle/TLVPacket.hh

index f7d8e6d..98d09ab 100644 (file)
@@ -109,10 +109,11 @@ namespace senf {
         : public PacketTypeBase,
           public PacketTypeMixin<EthernetPacketType, EtherTypes>
     {
+#ifndef DOXYGEN
         typedef PacketTypeMixin<EthernetPacketType, EtherTypes> mixin;
         typedef ConcretePacket<EthernetPacketType> packet;
         typedef Parse_Ethernet parser;
-
+#endif
         using mixin::nextPacketRange;
         using mixin::nextPacketType;
         using mixin::initSize;
@@ -128,7 +129,7 @@ namespace senf {
     };
 
     /** \brief Ethernet packet typedef */
-    typedef EthernetPacketType::packet EthernetPacket;
+    typedef ConcretePacket<EthernetPacketType> EthernetPacket;
 
     /** \brief Parse an ethernet VLAN tag
         
@@ -169,10 +170,11 @@ namespace senf {
         : public PacketTypeBase, 
           public PacketTypeMixin<EthVLanPacketType, EtherTypes>
     {
+#ifndef DOXYGEN
         typedef PacketTypeMixin<EthVLanPacketType, EtherTypes> mixin;
         typedef ConcretePacket<EthVLanPacketType> packet;
         typedef Parse_EthVLan parser;
-
+#endif
         using mixin::nextPacketRange;
         using mixin::nextPacketType;
         using mixin::initSize;
@@ -188,7 +190,7 @@ namespace senf {
     };
 
     /** \brief Ethernet VLAN tag typedef */
-    typedef EthVLanPacketType::packet EthVLanPacket;
+    typedef ConcretePacket<EthVLanPacketType> EthVLanPacket;
 }
 
 
index 00e2fdb..5b45f69 100644 (file)
@@ -135,10 +135,11 @@ namespace senf {
         : public PacketTypeBase,
           public PacketTypeMixin<IpV4PacketType, IpTypes>
     {
+#ifndef DOXYGEN
         typedef PacketTypeMixin<IpV4PacketType, IpTypes> mixin;
         typedef ConcretePacket<IpV4PacketType> packet;
         typedef Parse_IpV4 parser;
-
+#endif
         using mixin::nextPacketRange;
         using mixin::nextPacketType;
         using mixin::initSize;
@@ -152,7 +153,7 @@ namespace senf {
     };
         
     /** \brief IpV4 packet typedef */
-    typedef IpV4PacketType::packet IpV4Packet;
+    typedef ConcretePacket<IpV4PacketType> IpV4Packet;
 }
 
 
index 8d922b7..96a2ab4 100644 (file)
@@ -75,10 +75,11 @@ namespace senf {
         : public PacketTypeBase,
           public PacketTypeMixin<IpV6ExtensionType_Fragment, IpTypes>
     {
+#ifndef DOXYGEN
         typedef PacketTypeMixin<IpV6ExtensionType_Fragment, IpTypes> mixin;
         typedef ConcretePacket<IpV6ExtensionType_Fragment> packet;
         typedef Parse_IpV6Extension_Fragment parser;
-
+#endif
         using mixin::nextPacketRange;
         using mixin::nextPacketType;
         using mixin::initSize;
@@ -94,7 +95,7 @@ namespace senf {
     };
 
     /** \brief IpV6 fragment extension packet typedef */
-    typedef IpV6ExtensionType_Fragment::packet IpV6Extension_Fragment;
+    typedef ConcretePacket<IpV6ExtensionType_Fragment> IpV6Extension_Fragment;
 }
 
 ///////////////////////////////hh.e////////////////////////////////////////
index da0b046..bb7feb4 100644 (file)
@@ -102,10 +102,11 @@ namespace senf {
         : public PacketTypeBase,
           public PacketTypeMixin<IpV6PacketType, IpTypes>
     {
+#ifndef DOXYGEN
         typedef PacketTypeMixin<IpV6PacketType, IpTypes> mixin;
         typedef ConcretePacket<IpV6PacketType> packet;
         typedef Parse_IpV6 parser;
-
+#endif
         using mixin::nextPacketRange;
         using mixin::nextPacketType;
         using mixin::initSize;
@@ -120,7 +121,7 @@ namespace senf {
     };
 
     /** \brief IpV6 packet typedef */
-    typedef IpV6PacketType::packet IpV6Packet;
+    typedef ConcretePacket<IpV6PacketType> IpV6Packet;
 
     ///@}
 }
index 9e0177b..2c662d3 100644 (file)
@@ -77,10 +77,11 @@ namespace senf {
         : public PacketTypeBase,
           public PacketTypeMixin<UDPPacketType>
     {
+#ifndef DOXYGEN
         typedef PacketTypeMixin<UDPPacketType> mixin;
         typedef ConcretePacket<UDPPacketType> packet;
         typedef Parse_UDP parser;
-
+#endif
         using mixin::nextPacketRange;
         using mixin::initSize;
         using mixin::init;
@@ -91,7 +92,7 @@ namespace senf {
     };
 
     /** \brief UDP packet typedef */
-    typedef UDPPacketType::packet UDPPacket;
+    typedef ConcretePacket<UDPPacketType> UDPPacket;
 }
 
 
index 955160e..3954df9 100644 (file)
@@ -114,9 +114,10 @@ namespace senf {
     struct TLVPacketType
         : public PacketTypeBase
     {
+#ifndef DOXYGEN
         typedef ConcretePacket<TLVPacketType<LengthParser> > packet;
         typedef Parse_TLVPacket<LengthParser> parser;
-
+#endif
         static optional_range nextPacketRange(packet p);
         static size_type initSize();
         
@@ -127,10 +128,10 @@ namespace senf {
 
     typedef TLVPacketType<Parse_TLVPacketLength>::packet TLVPacket;
     
-    typedef TLVPacketType<Parse_UInt8>::packet  TLVFix8Packet;
-    typedef TLVPacketType<Parse_UInt16>::packet TLVFix16Packet;
-    typedef TLVPacketType<Parse_UInt24>::packet TLVFix24Packet;
-    typedef TLVPacketType<Parse_UInt32>::packet TLVFix32Packet;
+    typedef ConcretePacket<TLVPacketType<Parse_UInt8> >  TLVFix8Packet;
+    typedef ConcretePacket<TLVPacketType<Parse_UInt16> > TLVFix16Packet;
+    typedef ConcretePacket<TLVPacketType<Parse_UInt24> > TLVFix24Packet;
+    typedef ConcretePacket<TLVPacketType<Parse_UInt32> > TLVFix32Packet;
 }