From c34aad6a32842e800f50247507de6d4e911488af Mon Sep 17 00:00:00 2001 From: g0dil <g0dil@wiback.org> Date: Wed, 25 Jul 2007 08:26:41 +0000 Subject: [PATCH] Add missing doxygen \file comments --- Packets/DefaultBundle/EthernetPacket.cc | 3 ++- Packets/DefaultBundle/EthernetPacket.hh | 3 +++ Packets/DefaultBundle/IpV4Packet.cc | 3 ++- Packets/DefaultBundle/IpV4Packet.hh | 3 +++ Packets/DefaultBundle/UDPPacket.cc | 3 ++- Packets/DefaultBundle/UDPPacket.hh | 3 +++ Packets/MPEGDVBBundle/DSMCCSection.cc | 3 ++- Packets/MPEGDVBBundle/DSMCCSection.hh | 3 +++ Packets/MPEGDVBBundle/DatagramSection.cc | 3 ++- Packets/MPEGDVBBundle/DatagramSection.hh | 3 +++ Packets/MPEGDVBBundle/TransportPacket.cc | 3 ++- Packets/MPEGDVBBundle/TransportPacket.hh | 3 +++ Socket/Protocols/DVB/DVBDemuxHandles.cc | 3 +-- Socket/Protocols/DVB/DVBDemuxHandles.hh | 3 +-- Socket/Protocols/DVB/DVBDemuxProtocol.cc | 3 +-- Socket/Protocols/DVB/DVBDemuxProtocol.hh | 3 +-- Socket/Protocols/DVB/DVBFrontendHandle.cc | 3 +-- Socket/Protocols/DVB/DVBFrontendHandle.hh | 3 +-- Utils/SafeBool.cci | 23 ++++++++++++++++++++--- Utils/SafeBool.cti | 23 ++++++++++++++++++++--- Utils/SafeBool.hh | 23 +++++++++++++++++++++-- Utils/TypeIdValue.cci | 3 ++- Utils/TypeIdValue.cti | 3 ++- Utils/TypeIdValue.hh | 3 +++ senf.dict | 1 + 25 files changed, 105 insertions(+), 28 deletions(-) diff --git a/Packets/DefaultBundle/EthernetPacket.cc b/Packets/DefaultBundle/EthernetPacket.cc index 99e61bb1f..9720986bd 100644 --- a/Packets/DefaultBundle/EthernetPacket.cc +++ b/Packets/DefaultBundle/EthernetPacket.cc @@ -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" diff --git a/Packets/DefaultBundle/EthernetPacket.hh b/Packets/DefaultBundle/EthernetPacket.hh index 2bc9fb605..7cd5347ec 100644 --- a/Packets/DefaultBundle/EthernetPacket.hh +++ b/Packets/DefaultBundle/EthernetPacket.hh @@ -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 diff --git a/Packets/DefaultBundle/IpV4Packet.cc b/Packets/DefaultBundle/IpV4Packet.cc index 42413793b..aa5018c9c 100644 --- a/Packets/DefaultBundle/IpV4Packet.cc +++ b/Packets/DefaultBundle/IpV4Packet.cc @@ -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" diff --git a/Packets/DefaultBundle/IpV4Packet.hh b/Packets/DefaultBundle/IpV4Packet.hh index 9d451c564..773345eb7 100644 --- a/Packets/DefaultBundle/IpV4Packet.hh +++ b/Packets/DefaultBundle/IpV4Packet.hh @@ -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 diff --git a/Packets/DefaultBundle/UDPPacket.cc b/Packets/DefaultBundle/UDPPacket.cc index 4b6fe1e9c..6f30ea4fb 100644 --- a/Packets/DefaultBundle/UDPPacket.cc +++ b/Packets/DefaultBundle/UDPPacket.cc @@ -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" diff --git a/Packets/DefaultBundle/UDPPacket.hh b/Packets/DefaultBundle/UDPPacket.hh index 5ea93db33..560c36075 100644 --- a/Packets/DefaultBundle/UDPPacket.hh +++ b/Packets/DefaultBundle/UDPPacket.hh @@ -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 diff --git a/Packets/MPEGDVBBundle/DSMCCSection.cc b/Packets/MPEGDVBBundle/DSMCCSection.cc index f34ed9182..b6092bb9c 100644 --- a/Packets/MPEGDVBBundle/DSMCCSection.cc +++ b/Packets/MPEGDVBBundle/DSMCCSection.cc @@ -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" diff --git a/Packets/MPEGDVBBundle/DSMCCSection.hh b/Packets/MPEGDVBBundle/DSMCCSection.hh index 70eeceaf3..5fe02fc8f 100644 --- a/Packets/MPEGDVBBundle/DSMCCSection.hh +++ b/Packets/MPEGDVBBundle/DSMCCSection.hh @@ -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 diff --git a/Packets/MPEGDVBBundle/DatagramSection.cc b/Packets/MPEGDVBBundle/DatagramSection.cc index d25f515bf..6df71f769 100644 --- a/Packets/MPEGDVBBundle/DatagramSection.cc +++ b/Packets/MPEGDVBBundle/DatagramSection.cc @@ -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" diff --git a/Packets/MPEGDVBBundle/DatagramSection.hh b/Packets/MPEGDVBBundle/DatagramSection.hh index 467fdbd94..316dc177c 100644 --- a/Packets/MPEGDVBBundle/DatagramSection.hh +++ b/Packets/MPEGDVBBundle/DatagramSection.hh @@ -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 diff --git a/Packets/MPEGDVBBundle/TransportPacket.cc b/Packets/MPEGDVBBundle/TransportPacket.cc index bd416fdcb..3f12c75f8 100644 --- a/Packets/MPEGDVBBundle/TransportPacket.cc +++ b/Packets/MPEGDVBBundle/TransportPacket.cc @@ -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" diff --git a/Packets/MPEGDVBBundle/TransportPacket.hh b/Packets/MPEGDVBBundle/TransportPacket.hh index 9a935b9e3..176e133a9 100644 --- a/Packets/MPEGDVBBundle/TransportPacket.hh +++ b/Packets/MPEGDVBBundle/TransportPacket.hh @@ -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 diff --git a/Socket/Protocols/DVB/DVBDemuxHandles.cc b/Socket/Protocols/DVB/DVBDemuxHandles.cc index 8fda3496a..2abb6f97e 100644 --- a/Socket/Protocols/DVB/DVBDemuxHandles.cc +++ b/Socket/Protocols/DVB/DVBDemuxHandles.cc @@ -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" diff --git a/Socket/Protocols/DVB/DVBDemuxHandles.hh b/Socket/Protocols/DVB/DVBDemuxHandles.hh index 2c839e66d..4253abc43 100644 --- a/Socket/Protocols/DVB/DVBDemuxHandles.hh +++ b/Socket/Protocols/DVB/DVBDemuxHandles.hh @@ -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 diff --git a/Socket/Protocols/DVB/DVBDemuxProtocol.cc b/Socket/Protocols/DVB/DVBDemuxProtocol.cc index 141ab55e0..a0eedefae 100644 --- a/Socket/Protocols/DVB/DVBDemuxProtocol.cc +++ b/Socket/Protocols/DVB/DVBDemuxProtocol.cc @@ -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" diff --git a/Socket/Protocols/DVB/DVBDemuxProtocol.hh b/Socket/Protocols/DVB/DVBDemuxProtocol.hh index 49f87b843..2db7ccbea 100644 --- a/Socket/Protocols/DVB/DVBDemuxProtocol.hh +++ b/Socket/Protocols/DVB/DVBDemuxProtocol.hh @@ -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 diff --git a/Socket/Protocols/DVB/DVBFrontendHandle.cc b/Socket/Protocols/DVB/DVBFrontendHandle.cc index b56fb840f..0799ec3c2 100644 --- a/Socket/Protocols/DVB/DVBFrontendHandle.cc +++ b/Socket/Protocols/DVB/DVBFrontendHandle.cc @@ -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" diff --git a/Socket/Protocols/DVB/DVBFrontendHandle.hh b/Socket/Protocols/DVB/DVBFrontendHandle.hh index add8a45cc..219a6158c 100644 --- a/Socket/Protocols/DVB/DVBFrontendHandle.hh +++ b/Socket/Protocols/DVB/DVBFrontendHandle.hh @@ -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 diff --git a/Utils/SafeBool.cci b/Utils/SafeBool.cci index 618be826a..e3e336e1a 100644 --- a/Utils/SafeBool.cci +++ b/Utils/SafeBool.cci @@ -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 diff --git a/Utils/SafeBool.cti b/Utils/SafeBool.cti index a1d4bc094..54f252160 100644 --- a/Utils/SafeBool.cti +++ b/Utils/SafeBool.cti @@ -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" diff --git a/Utils/SafeBool.hh b/Utils/SafeBool.hh index ff10e58bc..7781e1dfb 100644 --- a/Utils/SafeBool.hh +++ b/Utils/SafeBool.hh @@ -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 diff --git a/Utils/TypeIdValue.cci b/Utils/TypeIdValue.cci index 94cb5deaf..9b5a0bfcf 100644 --- a/Utils/TypeIdValue.cci +++ b/Utils/TypeIdValue.cci @@ -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" diff --git a/Utils/TypeIdValue.cti b/Utils/TypeIdValue.cti index 5cb61a7e5..486f41efc 100644 --- a/Utils/TypeIdValue.cti +++ b/Utils/TypeIdValue.cti @@ -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" diff --git a/Utils/TypeIdValue.hh b/Utils/TypeIdValue.hh index 61bcdd1d6..1f261befb 100644 --- a/Utils/TypeIdValue.hh +++ b/Utils/TypeIdValue.hh @@ -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 diff --git a/senf.dict b/senf.dict index 973468e4d..6aa064597 100644 --- a/senf.dict +++ b/senf.dict @@ -55,6 +55,7 @@ ingroup init initHeadSize initSize +inline Institut Int IntField -- GitLab