From 1140ee2fa9e23430ac2dfc1939197e5d6089b093 Mon Sep 17 00:00:00 2001
From: tho <tho@wiback.org>
Date: Fri, 20 Jul 2007 14:33:44 +0000
Subject: [PATCH] added documentation stub for the MPEG/DVB Bundle
---
Packets/MPEGDVBBundle/DSMCCSection.hh | 7 +++-
Packets/MPEGDVBBundle/DatagramSection.hh | 7 +++-
Packets/MPEGDVBBundle/MPEGDVBBundle.dox | 46 ++++++++++++++++++++++++
3 files changed, 58 insertions(+), 2 deletions(-)
create mode 100644 Packets/MPEGDVBBundle/MPEGDVBBundle.dox
diff --git a/Packets/MPEGDVBBundle/DSMCCSection.hh b/Packets/MPEGDVBBundle/DSMCCSection.hh
index ae4f78788..70eeceaf3 100644
--- a/Packets/MPEGDVBBundle/DSMCCSection.hh
+++ b/Packets/MPEGDVBBundle/DSMCCSection.hh
@@ -1,4 +1,4 @@
-// $Id$
+// $Id:DSMCCSection.hh 327 2007-07-20 10:03:44Z tho $
//
// Copyright (C) 2007
// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
@@ -35,6 +35,9 @@
namespace senf {
+ ///\addtogroup protocolbundle_mpegdvb
+ ///@{
+
struct Parse_DSMCCSection : public PacketParserBase
{
SENF_PACKET_PARSER_INIT(Parse_DSMCCSection);
@@ -86,6 +89,8 @@ namespace senf {
};
typedef DSMCCSectionType::packet DSMCCSection;
+
+ ///@}
}
diff --git a/Packets/MPEGDVBBundle/DatagramSection.hh b/Packets/MPEGDVBBundle/DatagramSection.hh
index 70227093b..467fdbd94 100644
--- a/Packets/MPEGDVBBundle/DatagramSection.hh
+++ b/Packets/MPEGDVBBundle/DatagramSection.hh
@@ -1,4 +1,4 @@
-// $Id$
+// $Id:DatagramSection.hh 327 2007-07-20 10:03:44Z tho $
//
// Copyright (C) 2007
// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
@@ -37,6 +37,9 @@
namespace senf {
+ ///\addtogroup protocolbundle_mpegdvb
+ ///@{
+
struct Parse_DatagramSection : public Parse_DSMCCSection
{
//SENF_PACKET_PARSER_NO_INIT(Parse_DatagramSection);
@@ -94,6 +97,8 @@ namespace senf {
};
typedef DatagramSectionType::packet DatagramSection;
+
+ ///@}
}
diff --git a/Packets/MPEGDVBBundle/MPEGDVBBundle.dox b/Packets/MPEGDVBBundle/MPEGDVBBundle.dox
new file mode 100644
index 000000000..9a5a80559
--- /dev/null
+++ b/Packets/MPEGDVBBundle/MPEGDVBBundle.dox
@@ -0,0 +1,46 @@
+// Copyright (C) 2007
+// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
+// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// Stefan Bund <g0dil@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
+// 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.
+
+/** \mainpage The MPEG/DVB Bundle
+
+ \ref protocolbundle_mpegdvb
+ */
+
+/** \defgroup protocolbundle_mpegdvb Protocols of the MPEG/DVB bundle
+
+ Each protocol consists of several objects
+
+ \li The packet \c typedef symbol. This is the only object explicitly accessed from the outside
+ \li The associated parser object. This is, where the field names are documented
+ \li The internal packet type object
+ */
+
+
+// Local Variables:
+// mode: c++
+// fill-column: 100
+// comment-column: 40
+// c-file-style: "senf"
+// indent-tabs-mode: nil
+// ispell-local-dictionary: "american"
+// compile-command: "scons -u doc"
+// mode: auto-fill
+// End:
+
--
GitLab