Packets/DefaultBundle/Mainpage.dox

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \mainpage The Default Bundle
  24
  25     The default bundle combines a set of basic low level protocols like Ethernet or IP. Find the
  26     list of protocols implemented at \ref protocolbundle_default
  27  */
  28
  29 /** \defgroup protocolbundle_default Protocols contained in the DefaultBundle
  30
  31     Each protocol consists of several objects
  32
  33     \li The packet \c typedef symbol. This is the only object explicitly accessed from the outside
  34     \li The associated parser object. This is, where the field names are documented
  35     \li The internal packet type object
  36
  37     Below you find a list of the internal packet type object for each of the implemented
  38     protocols. You will never use this type directly, however the documentation will reference the
  39     packet typedef to use and will document the parser used to parse the packet's fields.
  40  */
  41
  42 \f
  43 // Local Variables:
  44 // mode: c++
  45 // fill-column: 100
  46 // comment-column: 40
  47 // c-file-style: "senf"
  48 // indent-tabs-mode: nil
  49 // ispell-local-dictionary: "american"
  50 // compile-command: "scons -u doc"
  51 // mode: auto-fill
  52 // End:
  53