Console: Add console logging documentation

[senf.git] / Packets / DataPacket.hh

diff --git a/Packets/DataPacket.hh b/Packets/DataPacket.hh
index 33c2d63..8469e9e 100644 (file)
--- a/Packets/DataPacket.hh
+++ b/Packets/DataPacket.hh
@@ -1,6 +1,8 @@
-// Copyright (C) 2007 
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// $Id$
+//
+// Copyright (C) 2007
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
 //     Stefan Bund <g0dil@berlios.de>
 //
 // This program is free software; you can redistribute it and/or modify
@@ -33,28 +35,27 @@
 
 namespace senf {
 
-    /** \brief Internal: Packet type of DataPacket
-
-        \internal
-     */
-    struct DataPacketType : public PacketTypeBase
-    {};
+    /** \brief Generic payload-only packet
 
+        \par Packet type (typedef):
+            \ref DataPacket
 
-    /** \brief Generic payload-only packet
-        
         DataPacket is a simple generic packet with just a payload of uninterpreted data. This is the
         packet used whenever no more specific packet type can be found for a sub-packet (e.g. as the
         payload data of a UDP packet)
 
         \ingroup packet_module
      */
+    struct DataPacketType : public PacketTypeBase
+    {};
+
+    /** \brief Generic payload-only packet typedef */
     typedef ConcretePacket<DataPacketType> DataPacket;
 }
 
 ///////////////////////////////hh.e////////////////////////////////////////
 #endif
-#if !defined(SENF_PACKETS_DECL_ONLY) && !defined(HH_DataPacket_impl_)
+#if !defined(HH_Packets__decls_) && !defined(HH_DataPacket_impl_)
 #define HH_DataPacket_impl_
 //#include "DataPacket.cci"
 //#include "DataPacket.ct"