From: tho <tho@270642c3-0616-0410-b53a-bc976706d245>
Date: Tue, 24 Jul 2007 13:54:54 +0000 (+0000)
Subject: fixed small documentation typo
X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=e61f824b022bb50e9e04598db860a67b644b6818;p=senf.git

fixed small documentation typo

git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@348 270642c3-0616-0410-b53a-bc976706d245
---

diff --git a/Packets/MPEGDVBBundle/TransportPacket.cc b/Packets/MPEGDVBBundle/TransportPacket.cc
index 7cb4c29..bd416fd 100644
--- a/Packets/MPEGDVBBundle/TransportPacket.cc
+++ b/Packets/MPEGDVBBundle/TransportPacket.cc
@@ -35,7 +35,7 @@ prefix_ void senf::TransportPacketType::dump(packet p, std::ostream & os)
 {
     os << "TransportPacket:\n"
        << std::hex
-       << "  syncByte: 0x" << unsigned(p->syncByte()) << "\n"
+       << "  syncByte: 0x" << unsigned(p->sync_byte()) << "\n"
        << "  transport_error_indicator: 0x" << unsigned(p->transport_error_indicator()) << "\n"
        << "  payload_unit_start_indicator (pusi): 0x" << unsigned(p->pusi()) << "\n"
        << "  transport_priority: 0x" << unsigned(p->transport_priority()) << "\n"
@@ -45,6 +45,8 @@ prefix_ void senf::TransportPacketType::dump(packet p, std::ostream & os)
        << "  transport_scrambling_control: 0x" << unsigned(p->transport_scrmbl_ctrl()) << "\n"
        << "  adaptation_field_control: 0x" << unsigned(p->adaptation_field_ctrl()) << "\n"
        << "  continuity_counter: 0x" << unsigned(p->continuity_counter()) << "\n";
+//    if (p->pusi())
+//        os << "  payload_pointer: 0x" << unsigned(p->payload_pointer()) << "\n";
 }
 
 ///////////////////////////////cc.e////////////////////////////////////////
diff --git a/Packets/MPEGDVBBundle/TransportPacket.hh b/Packets/MPEGDVBBundle/TransportPacket.hh
index 86dba04..9a935b9 100644
--- a/Packets/MPEGDVBBundle/TransportPacket.hh
+++ b/Packets/MPEGDVBBundle/TransportPacket.hh
@@ -34,14 +34,15 @@
 ///////////////////////////////hh.p////////////////////////////////////////
 
 namespace senf {
-    
-    ///\addtogroup protocolbundle_mpegdvb
-    ///@{
-    
+
+    /** \brief Parse a UDP packet
+
+        Parser implementing the header of a MPEG Transport Stream Packet.
+        
+        \see TransportPacketType
+     */
     struct Parse_TransportPacket : public PacketParserBase
     {
-        SENF_PACKET_PARSER_INIT(Parse_TransportPacket);
-        
         typedef Parse_Flag      <     0 > Parse_tei; // transport_error_indicator
         typedef Parse_Flag      <     1 > Parse_pusi; // payload_unit_start_indicator
         typedef Parse_Flag      <     2 > Parse_transportPrio;  // transport_priority
@@ -50,10 +51,12 @@ namespace senf {
         typedef Parse_UIntField < 2,  4 > Parse_adaptCtrl; // adaptation_field_control
         typedef Parse_UIntField < 4,  8 > Parse_contCounter; // continuity_counter
     
-        ///////////////////////////////////////////////////////////////////////////
-                
+#       ifndef DOXYGEN
+        
+        SENF_PACKET_PARSER_INIT(Parse_TransportPacket);
+        
         SENF_PACKET_PARSER_DEFINE_FIXED_FIELDS(
-            ((Field       ) ( syncByte,                  Parse_UInt8         )) 
+            ((Field       ) ( sync_byte,                 Parse_UInt8         )) 
             ((OverlayField) ( transport_error_indicator, Parse_tei           ))
             ((OverlayField) ( pusi,                      Parse_pusi          ))
             ((OverlayField) ( transport_priority,        Parse_transportPrio ))
@@ -63,8 +66,34 @@ namespace senf {
             ((Field       ) ( continuity_counter,        Parse_contCounter   ))      
         );
         
+#       else
+        
+        Parse_UInt8         sync_byte() const;
+        Parse_tei           transport_error_indicator() const;
+        Parse_pusi          pusi() const;
+        Parse_transportPrio transport_priority() const;
+        Parse_pid           pid() const;
+        Parse_tsc           transport_scrmbl_ctrl() const;
+        Parse_adaptCtrl     adaptation_field_ctrl() const;
+        Parse_contCounter   continuity_counter() const;
+
+#       endif
+        
+//        Parse_UInt8 payload_pointer() const {
+//            return parse<Parse_UInt8>( Parse_TransportPacket::fixed_bytes ); 
+//        }
     };
     
+    /** \brief Transport Stream packet
+        
+        \par Packet type (typedef):
+            \ref TransportPacket
+
+        \par Fields:
+            \ref Parse_TransportPacket
+
+        \ingroup protocolbundle_mpegdvb
+     */
     struct TransportPacketType
         : public PacketTypeBase,
           public PacketTypeMixin<TransportPacketType>
@@ -80,10 +109,9 @@ namespace senf {
         
         static void dump(packet p, std::ostream & os);
     };
-        
-    typedef TransportPacketType::packet TransportPacket;
     
-    ///@}
+    /** \brief Transport packet typedef */
+    typedef TransportPacketType::packet TransportPacket;
   
 }
 
diff --git a/Packets/Packet.hh b/Packets/Packet.hh
index afdfe7d..d04c6ae 100644
--- a/Packets/Packet.hh
+++ b/Packets/Packet.hh
@@ -354,7 +354,7 @@ namespace senf {
         factory_t factory() const;      ///< Return factory instance of \c this packet
                                         /**< The returned factory instance can be used to create new
                                              packets of the given type without knowing the concrete
-                                             type of the packet. The valid may be stored away for
+                                             type of the packet. The value may be stored away for
                                              later use if needed. */
         
         ///@}