small documentation fixes
[senf.git] / Packets / ParseHelpers.hh
index 40403ab..31fa8b5 100644 (file)
@@ -1,8 +1,8 @@
 // $Id$
 //
-// Copyright (C) 2007 
-// Fraunhofer Institute for Open Communication Systems (FOKUS) 
-// Competence Center NETwork research (NET), St. Augustin, GERMANY 
+// Copyright (C) 2007
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
 //     Stefan Bund <g0dil@berlios.de>
 //
 // This program is free software; you can redistribute it and/or modify
     arbitrary incorrect value otherwise.
 
     \pre Field \a name preceded by fixed size fields only
-    \param[in] field or label name
+    \param[in] name field or label name
     \returns compile-time constant offset of the field from parsers start
     \hideinitializer
  */
     This macro will return the current fixed offset, a compile-time constant expression. This is
     always possible when defining a fixed size parser.
 
-    Even in dynamically sized parsers this macro will work, up tp now only fixed size fields have
-    been defined. This macro does \e not validate this condition, it will return an arbitrary
-    incorrect value otherwise.
+    Even in dynamically sized parsers this macro will work, if all parser defined \e before the
+    current position are fixed-size parsers. This macro does \e not validate this condition, it will
+    return an arbitrary incorrect value otherwise.
 
     \pre Current position preceded by fixed-size parsers only
     \returns compile-time constant offset from parsers start