Changeset 1582 for pjproject/trunk


Ignore:
Timestamp:
Nov 16, 2007 3:52:05 AM (17 years ago)
Author:
bennylp
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r1417 r1582  
    173173 * 
    174174 * @param pool          The pool to get memory allocations. 
    175  * @param buf           The input buffer, which size must be at least (size+1) 
    176  *                      because the function will temporarily put NULL  
    177  *                      termination at the end of the buffer during parsing. 
     175 * @param buf           The input buffer, which MUST be NULL terminated. 
    178176 * @param size          The length of the string (not counting NULL terminator). 
    179177 * @param options       If no options are given (value is zero), the object  
    … …  
    194192 * Parse SIP status line. 
    195193 * 
    196  * @param buf           Text buffer to parse. 
    197  * @param size          The size of the buffer. 
     194 * @param buf           Text buffer to parse, which MUST be NULL terminated. 
     195 * @param size          The size of the buffer, excluding the NULL character. 
    198196 * @param status_line   Structure to receive the parsed elements. 
    199197 * 
    … …  
    212210 * 
    213211 * @param pool          The pool to allocate memory. 
    214  * @param buf           The input buffer, which size must be at least (size+1) 
    215  *                      because the function will temporarily put NULL  
    216  *                      termination at the end of the buffer during parsing. 
     212 * @param buf           The input buffer, which MUST be NULL terminated. 
    217213 * @param size          The length of the string (not counting NULL terminator). 
    218214 * @param err_list      If this parameter is not NULL, then the parser will 
    … …  
    235231 * This function is normally called by the transport layer. 
    236232 * 
    237  * @param buf           The input buffer 
    238  * @param buf           The input buffer, which size must be at least (size+1) 
    239  *                      because the function will temporarily put NULL  
    240  *                      termination at the end of the buffer during parsing. 
     233 * @param buf           The input buffer, which MUST be NULL terminated. 
    241234 * @param size          The length of the string (not counting NULL terminator). 
    242235 * @param rdata         The receive data buffer to store the message and 
    … …  
    273266 * @param hname         Header name which is used to find the correct function 
    274267 *                      to parse the header. 
    275  * @param line          Header content, which size must be at least size+1. 
     268 * @param line          Header content, which must be NULL terminated. 
    276269 * @param size          The length of the string (not counting NULL terminator, 
    277270 *                      if any). 
    … …  
    297290 * 
    298291 * @param pool          the pool. 
    299  * @param input         the input text to parse. 
     292 * @param input         the input text to parse, which must be NULL terminated. 
    300293 * @param size          the text length. 
    301294 * @param hlist         the header list to store the parsed headers.  
Note: See TracChangeset for help on using the changeset viewer.