NEW FILE HEADER / COPYRIGHT FORMAT

[senf.git] / Packets / DataPacket.hh

diff --git a/Packets/DataPacket.hh b/Packets/DataPacket.hh
index a6d936e..8a4f818 100644 (file)
--- a/Packets/DataPacket.hh
+++ b/Packets/DataPacket.hh
@@ -1,6 +1,8 @@
+// $Id$
+//
 // Copyright (C) 2007 
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// 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
@@ -32,14 +34,29 @@
 ///////////////////////////////hh.p////////////////////////////////////////
 
 namespace senf {
-    
+
+    /** \brief Generic payload-only packet
+
+        \par Packet type (typedef):
+            \ref DataPacket
+
+        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(HH_Packets__decls_) && !defined(HH_DataPacket_impl_)
+#define HH_DataPacket_impl_
 //#include "DataPacket.cci"
 //#include "DataPacket.ct"
 //#include "DataPacket.cti"
@@ -55,3 +72,4 @@ namespace senf {
 // ispell-local-dictionary: "american"
 // compile-command: "scons -u test"
 // End:
+