Browse Source

misc/cstring.h: fix documentation for b_cstring_memchr()

ambrop7 13 years ago
parent
commit
8adba30d48
1 changed files with 2 additions and 1 deletions
  1. 2 1
      misc/cstring.h

+ 2 - 1
misc/cstring.h

@@ -125,7 +125,8 @@ static int b_cstring_equals_buffer (b_cstring cstr, size_t offset, size_t length
 /**
 /**
  * Determines if a range within a string contains the byte \a ch.
  * Determines if a range within a string contains the byte \a ch.
  * Returns 1 if it does, and 0 if it does not. If it does contain it, and \a out_pos is not
  * Returns 1 if it does, and 0 if it does not. If it does contain it, and \a out_pos is not
- * NULL, *\a out_pos is set to the index of the first matching byte in the range.
+ * NULL, *\a out_pos is set to the index of the first matching byte in the range, relative
+ * to the beginning of the range \a offset.
  */
  */
 static int b_cstring_memchr (b_cstring cstr, size_t offset, size_t length, char ch, size_t *out_pos);
 static int b_cstring_memchr (b_cstring cstr, size_t offset, size_t length, char ch, size_t *out_pos);