Changeset 1582

Timestamp:

Nov 16, 2007 3:52:05 AM (16 years ago)

Author:

bennylp

Message:

Fixed wrong doxygen comment on various SIP parsing function, about null-terminating the input text

File:

• pjproject/trunk/pjsip/include/pjsip/sip_parser.h (modified) (6 diffs)

pjproject/trunk/pjsip/include/pjsip/sip_parser.h

@@ -173 +173 @@
  *
  * @param pool          The pool to get memory allocations.
- * @param buf           The input buffer, which size must be at least (size+1)
- *                      because the function will temporarily put NULL 
- *                      termination at the end of the buffer during parsing.
+ * @param buf           The input buffer, which MUST be NULL terminated.
  * @param size          The length of the string (not counting NULL terminator).
  * @param options       If no options are given (value is zero), the object 
@@ -194 +192 @@
  * Parse SIP status line.
  *
- * @param buf           Text buffer to parse.
- * @param size          The size of the buffer.
+ * @param buf           Text buffer to parse, which MUST be NULL terminated.
+ * @param size          The size of the buffer, excluding the NULL character.
  * @param status_line   Structure to receive the parsed elements.
  *
@@ -212 +210 @@
  *
  * @param pool          The pool to allocate memory.
- * @param buf           The input buffer, which size must be at least (size+1)
- *                      because the function will temporarily put NULL 
- *                      termination at the end of the buffer during parsing.
+ * @param buf           The input buffer, which MUST be NULL terminated.
  * @param size          The length of the string (not counting NULL terminator).
  * @param err_list      If this parameter is not NULL, then the parser will
@@ -235 +231 @@
  * This function is normally called by the transport layer.
  *
- * @param buf           The input buffer
- * @param buf           The input buffer, which size must be at least (size+1)
- *                      because the function will temporarily put NULL 
- *                      termination at the end of the buffer during parsing.
+ * @param buf           The input buffer, which MUST be NULL terminated.
  * @param size          The length of the string (not counting NULL terminator).
  * @param rdata         The receive data buffer to store the message and
@@ -273 +266 @@
  * @param hname         Header name which is used to find the correct function
  *                      to parse the header.
- * @param line          Header content, which size must be at least size+1.
+ * @param line          Header content, which must be NULL terminated.
  * @param size          The length of the string (not counting NULL terminator,
  *                      if any).
@@ -297 +290 @@
  *
  * @param pool          the pool.
- * @param input         the input text to parse.
+ * @param input         the input text to parse, which must be NULL terminated.
  * @param size          the text length.
  * @param hlist         the header list to store the parsed headers.