Try to clarify the documentation for tvb_length_remaining() and tvb_reported_length_remaining() based on Jörg's recommendation from bug 9263.

svn path=/trunk/; revision=53070

1 files changed, 4 insertions, 3 deletions

diff --git a/epan/tvbuff.h b/epan/tvbuff.h
index 6c49a26409..82e4983847 100644
--- a/epan/tvbuff.h
+++ b/epan/tvbuff.h
@@ -225,8 +225,8 @@ WS_DLL_PUBLIC void tvb_composite_finalize(tvbuff_t *tvb);
 WS_DLL_PUBLIC guint tvb_length(const tvbuff_t *tvb);
 
 /** Computes bytes to end of buffer, from offset (which can be negative,
- * to indicate bytes from end of buffer). Function returns 0 if offset is out
- * of bounds. No exception is thrown. */
+ * to indicate bytes from end of buffer). Function returns 0 if offset is
+ * either at the end of the buffer or out of bounds. No exception is thrown. */
 WS_DLL_PUBLIC gint tvb_length_remaining(const tvbuff_t *tvb, const gint offset);
 
 /** Same as above, but throws an exception if the offset is out of bounds. */
@@ -252,7 +252,8 @@ WS_DLL_PUBLIC guint tvb_reported_length(const tvbuff_t *tvb);
 
 /** Computes bytes of reported packet data to end of buffer, from offset
  * (which can be negative, to indicate bytes from end of buffer). Function
- * returns 0 if offset is out of bounds. No exception is thrown. */
+ * returns 0 if offset is either at the end of the buffer or out of bounds.
+ * No exception is thrown. */
 WS_DLL_PUBLIC gint tvb_reported_length_remaining(const tvbuff_t *tvb,
     const gint offset);