Packets/DefaultBundle/Mainpage.dox

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