Socket: BUGFIX: Explicitly copy image
[senf.git] / Packets / DefaultBundle / DefaultBundle.dox
index 5891ca8..e902443 100644 (file)
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
-/** \defgroup protocolbundles Protocol Bundles
+/** \mainpage The Default Bundle
 
-    Each protocol bundle provides a collection of related concrete packet classes for a group of
-    related protocols.    
+    The default bundle combines a set of basic low level protocols like Ethernet or IP. You can find
+    the list of implemented protocols at \ref protocolbundle_default (see the list of typedefs)
  */
 
-/** \defgroup protocolbundle_default The Default Bundle
+/** \defgroup protocolbundle_default Protocols of the default bundle
 
-    The default bundle combines a set of basic low level protocols like Ethernet or IP.
+    Each protocol consists of several objects
 
-    \ingroup protocolbundles
+    \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
  */
 
 \f
@@ -39,8 +41,7 @@
 // c-file-style: "senf"
 // indent-tabs-mode: nil
 // ispell-local-dictionary: "american"
-// compile-command: "scons -u test"
-// mode: flyspell
+// compile-command: "scons -u doc"
 // mode: auto-fill
-// ispell-local-dictionary: "american"
 // End:
+