aboutsummaryrefslogtreecommitdiffstats
path: root/epan/exceptions.h
diff options
context:
space:
mode:
authorUlf Lamping <ulf.lamping@web.de>2005-03-11 21:14:38 +0000
committerUlf Lamping <ulf.lamping@web.de>2005-03-11 21:14:38 +0000
commite37809885567bc75fb6ce73d8bd58a416560934c (patch)
treee423cb02bde1a88ed4f60f708857b3a24226035a /epan/exceptions.h
parent801e9dd35ed92b0f716e94cc43ab9fc00540021c (diff)
from Micheal Duigou: add some doxygen tags and some changes to README.developer
svn path=/trunk/; revision=13725
Diffstat (limited to 'epan/exceptions.h')
-rw-r--r--epan/exceptions.h29
1 files changed, 25 insertions, 4 deletions
diff --git a/epan/exceptions.h b/epan/exceptions.h
index f8c7388786..436311b929 100644
--- a/epan/exceptions.h
+++ b/epan/exceptions.h
@@ -9,10 +9,31 @@
#define XCEPT_GROUP_ETHEREAL 1
/* Ethereal's exceptions */
-#define BoundsError 1 /* Index is out of range */
-#define ReportedBoundsError 2 /* Index is beyond reported length (not cap_len) */
-#define TypeError 3 /* During dfilter parsing */
-#define DissectorError 4 /* A bug was detected in a dissector */
+
+/**
+ Index is out of range.
+ An attempt was made to read past the end of a buffer.
+**/
+#define BoundsError 1
+
+/**
+ Index is beyond reported length (not cap_len)
+ An attempt was made to read past the logical end of a buffer. This
+ differs from a BoundsError in that the parent protocol established a
+ limit past which this dissector should not process in the buffer and that
+ limit was execeeded.
+**/
+#define ReportedBoundsError 2
+
+/**
+ During dfilter parsing
+**/
+#define TypeError 3
+
+/**
+ A bug was detected in a dissector
+**/
+#define DissectorError 4
/* Usage:
*