Utils/Termlib: Extend the completion API

[senf.git] / Packets / 80221Bundle / MIHPacket.hh

diff --git a/Packets/80221Bundle/MIHPacket.hh b/Packets/80221Bundle/MIHPacket.hh
index 0b970ff..5f4f997 100644 (file)
--- a/Packets/80221Bundle/MIHPacket.hh
+++ b/Packets/80221Bundle/MIHPacket.hh
@@ -41,27 +41,31 @@
 
 namespace senf {
 
-    // the maximum length of a MIHF_ID is 253 octets (see F.3.11 in 802.21)
-    // we could set maxLengthValue in INIT, but for the most MIHF_IDs the default
-    // maximum length of 127 should be enough.
-    // The user must call mihPacket->src_mihfId().maxLengthValue( 127) before 
-    // setting longer MIHF_IDs
+    /** \brief Parse a MIHF_ID
+
+         the maximum length of a MIHF_ID is 253 octets (see F.3.11 in 802.21)
+         we could set maxLengthValue in init(), but for the most MIHF_IDs the default
+         maximum length of 127 should be enough.
+         
+         \note you must call mihfIdPacket.maxLengthValue( 253) *before*
+         setting longer MIHF_IDs values.
+    */
     class MIHFId_TLVParser : public BaseTLVPacketParser
     {
-    #   include SENF_PARSER()        
+    #   include SENF_PARSER()
         SENF_PARSER_INHERIT  ( BaseTLVPacketParser );
         SENF_PARSER_SKIP     ( length(), 0         );
         SENF_PARSER_FINALIZE ( MIHFId_TLVParser    );
-                
+
         std::string asString() const;
         void setString(std::string const &id);
-        
+
         senf::MACAddress asMACAddress() const;
         void setMACAddress(senf::MACAddress const &mac);
 
         senf::INet4Address asINet4Address() const;
         void setINet4Address(senf::INet4Address const &addr);
-        
+
         senf::INet6Address asINet6Address() const;
         void setINet6Address(senf::INet6Address const &addr);
 
@@ -70,7 +74,7 @@ namespace senf {
         struct binaryNAIEncoder {
             binaryNAIEncoder(OutputIterator &i) : i_(i) {}
             void operator()(const boost::uint8_t &v) const {
-                *i_++ = '\\'; 
+                *i_++ = '\\';
                 *i_++ = v;
             }
             OutputIterator &i_;
@@ -79,10 +83,10 @@ namespace senf {
         static boost::function_output_iterator<binaryNAIEncoder<OutputIterator> > getNAIEncodedOutputIterator(OutputIterator i) {
             return boost::make_function_output_iterator(binaryNAIEncoder<OutputIterator>(i));
         }
-        
+
         struct binaryNAIDecoder {
             binaryNAIDecoder() : readNextByte_(true) {}
-            bool operator()(const boost::uint8_t &v) { 
+            bool operator()(const boost::uint8_t &v) {
                 readNextByte_ = readNextByte_ ? false : true;
                 return readNextByte_;
             }
@@ -94,10 +98,17 @@ namespace senf {
         }
     };
 
+    /** \brief Parse a MIH packet
+
+        Parser implementing the MIH header. The fields implemented are:
+        \image html MIHPacket.png
+
+        \see MIHPacketType
+     */
     struct MIHPacketParser : public PacketParserBase
     {
     #   include SENF_PARSER()
-        
+
         SENF_PARSER_BITFIELD_RO ( version,       4,  unsigned );
         SENF_PARSER_BITFIELD    ( ackRequest,    1,  bool     );
         SENF_PARSER_BITFIELD    ( ackResponse,   1,  bool     );
@@ -105,32 +116,32 @@ namespace senf {
         SENF_PARSER_BITFIELD    ( moreFragment,  1,  bool     );
         SENF_PARSER_BITFIELD    ( fragmentNr,    7,  unsigned );
         SENF_PARSER_SKIP_BITS   ( 1                           );
-        
+
         // MIH message ID (MID)
         SENF_PARSER_BITFIELD ( sid,     4,  unsigned );
         SENF_PARSER_BITFIELD ( opcode,  2,  unsigned );
         SENF_PARSER_BITFIELD ( aid,    10,  unsigned );
-        
+
         SENF_PARSER_SKIP_BITS ( 4                           );
         SENF_PARSER_BITFIELD  ( transactionId, 12, unsigned );
         SENF_PARSER_FIELD_RO  ( payloadLength, UInt16Parser );
-        
+
         // Source MIHF Id
         SENF_PARSER_FIELD ( src_mihfId, MIHFId_TLVParser );
         // Destination MIHF Id
         SENF_PARSER_FIELD ( dst_mihfId, MIHFId_TLVParser );
-        
+
         SENF_PARSER_FINALIZE ( MIHPacketParser );
-        
+
         SENF_PARSER_INIT() {
             version_() = 1;
             src_mihfId().type() = 1;
             dst_mihfId().type() = 2;
         }
-        
+
         friend class MIHPacketType;
     };
-    
+
     /** \brief MIH packet
 
         \par Packet type (typedef):
@@ -138,55 +149,61 @@ namespace senf {
 
         \par Fields:
             \ref MIHPacketParser
-        
+
         \ingroup protocolbundle_80221
      */
     struct MIHPacketType
         : public PacketTypeBase,
           public PacketTypeMixin<MIHPacketType>
     {
+#ifndef DOXYGEN
         typedef PacketTypeMixin<MIHPacketType> mixin;
-        typedef ConcretePacket<MIHPacketType> packet;
-        typedef MIHPacketParser parser;
+#endif
+        typedef ConcretePacket<MIHPacketType> packet; ///< MIH packet typedef
+        typedef MIHPacketParser parser;               ///< typedef to the parser of MIH packet
 
         using mixin::nextPacketRange;
         using mixin::init;
         using mixin::initSize;
 
+        /** \brief Dump given MIH packet in readable form to given output stream */
         static void dump(packet p, std::ostream &os);
         static void finalize(packet p);
         static factory_t nextPacketType(packet p);
     };
 
+    /** \brief MIH packet typedef */
     typedef ConcretePacket<MIHPacketType> MIHPacket;
-    
-    
+
+
     struct MIHPayloadPacketParser : public PacketParserBase
     {
     #   include SENF_PARSER()
         SENF_PARSER_LIST ( tlv_list, packetSize(), GenericTLVPacketParser );
-        
+
         SENF_PARSER_FINALIZE ( MIHPayloadPacketParser );
     };
-    
+
     struct MIHPayloadPacketType
         : public PacketTypeBase,
           public PacketTypeMixin<MIHPayloadPacketType>
     {
+#ifndef DOXYGEN
         typedef PacketTypeMixin<MIHPayloadPacketType> mixin;
-        typedef ConcretePacket<MIHPayloadPacketType> packet;
-        typedef MIHPayloadPacketParser parser;
+#endif
+        typedef ConcretePacket<MIHPayloadPacketType> packet; ///< MIH Payload packet typedef
+        typedef MIHPayloadPacketParser parser; ///< typedef to the parser of MIH Payload packet
 
         using mixin::nextPacketRange;
         using mixin::init;
         using mixin::initSize;
 
+        /** \brief Dump given MIHPayload in readable form to given output stream */
         static void dump(packet p, std::ostream &os);
     };
-        
-    typedef ConcretePacket<MIHPayloadPacketType> MIHPayloadPacket;
-            
 
+     /** \brief MIH Payload packet typedef */
+    typedef ConcretePacket<MIHPayloadPacketType> MIHPayloadPacket;
 }
 
 
@@ -198,7 +215,7 @@ namespace senf {
 //#include "MIHPacket.cti"
 #endif
 
-\f
+
 // Local Variables:
 // mode: c++
 // fill-column: 100