Add missing doxygen \file comments
g0dil [Wed, 25 Jul 2007 08:26:41 +0000 (08:26 +0000)]
git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@350 270642c3-0616-0410-b53a-bc976706d245

25 files changed:
Packets/DefaultBundle/EthernetPacket.cc
Packets/DefaultBundle/EthernetPacket.hh
Packets/DefaultBundle/IpV4Packet.cc
Packets/DefaultBundle/IpV4Packet.hh
Packets/DefaultBundle/UDPPacket.cc
Packets/DefaultBundle/UDPPacket.hh
Packets/MPEGDVBBundle/DSMCCSection.cc
Packets/MPEGDVBBundle/DSMCCSection.hh
Packets/MPEGDVBBundle/DatagramSection.cc
Packets/MPEGDVBBundle/DatagramSection.hh
Packets/MPEGDVBBundle/TransportPacket.cc
Packets/MPEGDVBBundle/TransportPacket.hh
Socket/Protocols/DVB/DVBDemuxHandles.cc
Socket/Protocols/DVB/DVBDemuxHandles.hh
Socket/Protocols/DVB/DVBDemuxProtocol.cc
Socket/Protocols/DVB/DVBDemuxProtocol.hh
Socket/Protocols/DVB/DVBFrontendHandle.cc
Socket/Protocols/DVB/DVBFrontendHandle.hh
Utils/SafeBool.cci
Utils/SafeBool.cti
Utils/SafeBool.hh
Utils/TypeIdValue.cci
Utils/TypeIdValue.cti
Utils/TypeIdValue.hh
senf.dict

index 99e61bb..9720986 100644 (file)
@@ -20,7 +20,8 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
-// Definition of non-inline non-template functions
+/** \file
+    \brief EthernetPacket non-inline non-template implementation */
 
 #include "EthernetPacket.hh"
 //#include "EthernetPacket.ih"
index 2bc9fb6..7cd5347 100644 (file)
@@ -20,6 +20,9 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
+/** \file
+    \brief EthernetPacket public header */
+
 #ifndef HH_EthernetPacket_
 #define HH_EthernetPacket_ 1
 
index 4241379..aa5018c 100644 (file)
@@ -20,7 +20,8 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
-// Definition of non-inline non-template functions
+/** \file
+    \brief IpV4Packet non-inline non-template implementation */
 
 #include "IpV4Packet.hh"
 //#include "IpV4Packet.ih"
index 9d451c5..773345e 100644 (file)
@@ -20,6 +20,9 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
+/** \file
+    \brief IpV4Packet public header */
+
 #ifndef HH_IpV4Packet_
 #define HH_IpV4Packet_ 1
 
index 4b6fe1e..6f30ea4 100644 (file)
@@ -20,7 +20,8 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
-// Definition of non-inline non-template functions
+/** \file 
+    \brief UDPPacket non-inline non-template implementation */
 
 #include "UDPPacket.hh"
 //#include "UDPPacket.ih"
index 5ea93db..560c360 100644 (file)
@@ -20,6 +20,9 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
+/** \file
+    \brief UDPPacket public header */
+
 #ifndef HH_UDPPacket_
 #define HH_UDPPacket_ 1
 
index f34ed91..b6092bb 100644 (file)
@@ -20,7 +20,8 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
-// Definition of non-inline non-template functions
+/** \file
+    \brief DSMCCSection non-inline non-template implementation */
 
 #include "DSMCCSection.hh"
 //#include "DSMCCSection.ih"
index 70eecea..5fe02fc 100644 (file)
@@ -20,6 +20,9 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
+/** \file
+    \brief DSMCCSection public header */
+
 #ifndef HH_DSMCCSection_
 #define HH_DSMCCSection_ 1
 
index d25f515..6df71f7 100644 (file)
@@ -20,7 +20,8 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
-// Definition of non-inline non-template functions
+/** \file
+    \brief DatagramSection non-inline non-template implementation */
 
 #include "DatagramSection.hh"
 //#include "DatagramSection.ih"
index 467fdbd..316dc17 100644 (file)
@@ -20,6 +20,9 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
+/** \brief
+    \file DatagramSection public header */
+
 #ifndef HH_DatagramSection_
 #define HH_DatagramSection_ 1
 
index bd416fd..3f12c75 100644 (file)
@@ -20,7 +20,8 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
-// Definition of non-inline non-template functions
+/** \file
+    \brief TransportPacket non-inline non-template implementation */
 
 #include "TransportPacket.hh"
 //#include "TransportPacket.ih"
index 9a935b9..176e133 100644 (file)
@@ -20,6 +20,9 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
+/** \file
+    \brief TransportPacket public header */
+
 #ifndef HH_TransportPacket_
 #define HH_TransportPacket_ 1
 
index 8fda349..2abb6f9 100644 (file)
@@ -21,8 +21,7 @@
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 /** \file
-    \brief xxx
- */
+    \brief DVBDemuxHandles non-inline non-template implementation */
 
 #include "DVBDemuxHandles.hh"
 //#include "DVBDemuxHandles.ih"
index 2c839e6..4253abc 100644 (file)
@@ -21,8 +21,7 @@
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 /** \file
-    \brief DVBHandles
- */
+    \brief DVBDemuxHandles public header */
 
 #ifndef HH_DVBDemuxHandles_
 #define HH_DVBDemuxHandles_ 1
index 141ab55..a0eedef 100644 (file)
@@ -21,8 +21,7 @@
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 /** \file
-    \brief xxx
- */
+    \brief DVBDemuxProtocol non-inline non-template implementation */
 
 #include "DVBDemuxProtocol.hh"
 //#include "DVBDemuxProtocol.ih"
index 49f87b8..2db7ccb 100644 (file)
@@ -21,8 +21,7 @@
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 /** \file
-    \brief DVBProtocol public header
- */
+    \brief DVBDemuxProtocol public header */
 
 #ifndef HH_DVBDemuxProtocol_
 #define HH_DVBDemuxProtocol_ 1
index b56fb84..0799ec3 100644 (file)
@@ -21,8 +21,7 @@
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 /** \file
-    \brief xxx
- */
+    \brief DVBFrontendHandle non-inline non-template implementation */
 
 #include "DVBFrontendHandle.hh"
 //#include "DVBFrontendHandle.ih"
index add8a45..219a615 100644 (file)
@@ -21,8 +21,7 @@
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 /** \file
-    \brief DVBHandles
- */
+    \brief DVBFrontendHandle public header */
 
 #ifndef HH_DVBFrontendHandle_
 #define HH_DVBFrontendHandle_ 1
index 618be82..e3e336e 100644 (file)
@@ -1,8 +1,25 @@
-// $Id$
+// Copyright (C) 2007 
+// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
+// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+//     Stefan Bund <g0dil@berlios.de>
 //
-// Copyright (C) 2006
+// 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
+// the Free Software Foundation; either version 2 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the
+// Free Software Foundation, Inc.,
+// 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
-// Definition of inline non-template functions
+/** \file
+    \brief SafeBool inline non-template implementation */
 
 // Custom includes
 
index a1d4bc0..54f2521 100644 (file)
@@ -1,8 +1,25 @@
-// $Id$
+// Copyright (C) 2007 
+// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
+// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+//     Stefan Bund <g0dil@berlios.de>
 //
-// Copyright (C) 2006
+// 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
+// the Free Software Foundation; either version 2 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the
+// Free Software Foundation, Inc.,
+// 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
-// Definition of inline template functions
+/** \file
+    \brief SafeBool inline template implementation */
 
 //#include "SafeBool.ih"
 
index ff10e58..7781e1d 100644 (file)
@@ -1,6 +1,25 @@
-// $Id$
+// Copyright (C) 2007 
+// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
+// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+//     Stefan Bund <g0dil@berlios.de>
 //
-// Copyright (C) 2006
+// 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
+// the Free Software Foundation; either version 2 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the
+// Free Software Foundation, Inc.,
+// 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+/** \file
+    \brief SafeBool public header */
 
 #ifndef HH_SafeBool_
 #define HH_SafeBool_ 1
index 94cb5de..9b5a0bf 100644 (file)
@@ -20,7 +20,8 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
-// Definition of inline non-template functions
+/** \file
+    \brief TypeIdValue inline non-template implementation */
 
 //#include "TypeIdValue.ih"
 
index 5cb61a7..486f41e 100644 (file)
@@ -20,7 +20,8 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
-// Definition of inline template functions
+/** \file
+    \brief TypeIdValue inline template implementation */
 
 //#include "TypeIdValue.ih"
 
index 61bcdd1..1f261be 100644 (file)
@@ -20,6 +20,9 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
+/** \file
+    \brief TypeIdValue public header */
+
 #ifndef HH_TypeIdValue_
 #define HH_TypeIdValue_ 1
 
index 973468e..6aa0645 100644 (file)
--- a/senf.dict
+++ b/senf.dict
@@ -55,6 +55,7 @@ ingroup
 init
 initHeadSize
 initSize
+inline
 Institut
 Int
 IntField