Packets documentation updates

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

diff --git a/Packets/DefaultBundle/LlcSnapPacket.hh b/Packets/DefaultBundle/LlcSnapPacket.hh
index 9612690..5d0f7e9 100644 (file)
--- a/Packets/DefaultBundle/LlcSnapPacket.hh
+++ b/Packets/DefaultBundle/LlcSnapPacket.hh
@@ -1,9 +1,9 @@
 // $Id$
 //
 // Copyright (C) 2007
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
-//     Thorsten Horstmann <thorsten.horstmann@fokus.fraunhofer.de>
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
+//     Thorsten Horstmann <tho@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
@@ -23,8 +23,8 @@
 /** \file
     \brief LLC/SNAP public header */
 
-#ifndef HH_LlcSnapPacket_
-#define HH_LlcSnapPacket_ 1
+#ifndef HH_SENF_Packets_DefaultBundle_LlcSnapPacket_
+#define HH_SENF_Packets_DefaultBundle_LlcSnapPacket_ 1
 
 // Custom includes
 #include <algorithm>
@@ -38,6 +38,7 @@ namespace senf {
 
     /** \brief Parse a LLC/SNAP header
         
+        \image html LlcSnapPacket.png
         \todo document me
      */
     struct LlcSnapPacketParser : public PacketParserBase
@@ -85,18 +86,21 @@ namespace senf {
     {
 #ifndef DOXYGEN
         typedef PacketTypeMixin<LlcSnapPacketType, EtherTypes> mixin;
-        typedef ConcretePacket<LlcSnapPacketType> packet;
-        typedef LlcSnapPacketParser parser;
 #endif
+        typedef ConcretePacket<LlcSnapPacketType> packet; ///< LLC/SNAP packet typedef
+        typedef LlcSnapPacketParser parser;               ///< typedef to the parser of LLC/SNAP packet
+
         using mixin::nextPacketRange;
         using mixin::initSize;
         using mixin::init;
         
         static factory_t nextPacketType(packet p);
-        static void dump(packet p, std::ostream & os);
+        /** \brief Dump given LlcSnapPacket in readable form to given output stream */
+        static void dump(packet p, std::ostream & os); 
         static void finalize(packet p);
     };
 
+    /** \brief LLC/SNAP packet typedef */
     typedef ConcretePacket<LlcSnapPacketType> LlcSnapPacket;
 }