Changeset 3530

Show
Ignore:
Timestamp:
03/26/08 14:53:39
Author:
pvanhoof
Message:

Documentation fixes

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/libtinymail/tny-header.c

    r3526 r3530  
    225225 * @self: a #TnyHeader 
    226226 *  
    227  * Get the CC header. The returned value should not be freed. 
     227 * Get the CC header. If not NULL, the returned value must be freed. 
    228228 *  
    229229 * returns: (null-ok) (caller-owns): CC header as a alloc'd string or NULL 
    …… 
    246246 * @self: a #TnyHeader 
    247247 *  
    248  * Get the BCC header. The returned value should not be freed. 
     248 * Get the BCC header. If not NULL, the returned value must be freed. 
    249249 *  
    250250 * returns: (null-ok) (caller-owns): BCC header as an alloc'd string or NULL 
    …… 
    311311 *  
    312312 * Get an unique id of the message of which @self is a message header. The UID 
    313  * corresponds to the UID in 
    314  * IMAP and the UIDL in POP if UIDL is supported or the UID if not. 
     313 * corresponds to the UID in IMAP and the UIDL in POP if UIDL is supported or  
     314 * the UID if not. If not NULL, the returned value must be freed. 
    315315 *  
    316316 * returns: (null-ok) (caller-owns): unique follow-up uid as an alloc'd string or NULL 
    …… 
    334334 *  
    335335 * Get an unique id of the message of which self is a message header. The  
    336  * returned value should be freed. The message-id corresponds to the 
    337  * message-id header in the MIME message. 
     336 * message-id corresponds to the message-id header in the MIME message. 
     337 * If not NULL, the returned value must be freed. 
    338338 *  
    339339 * returns: (null-ok) (caller-owns): message-id header as an alloc'd string or NULL 
    …… 
    381381 * @self: a #TnyHeader 
    382382 *  
    383  * Get the from header. The returned value should be freed. 
     383 * Get the from header. If not NULL, the returned value must be freed. 
    384384 *  
    385385 * returns: (null-ok) (caller-owns): from header as an alloc'd string or NULL 
    …… 
    402402 * @self: a #TnyHeader 
    403403 *  
    404  * Get the subject header. The returned value should be freed. 
     404 * Get the subject header. If not NULL, the returned value must be freed. 
    405405 *  
    406406 * returns: (null-ok) (caller-owns): subject header as an alloc'd string or NULL 
    …… 
    424424 * @self: a #TnyHeader 
    425425 *  
    426  * Get the to header. The returned value should be freed. 
     426 * Get the to header. If not NULL, the returned value must be freed. 
    427427 *  
    428428 * returns: (null-ok) (caller-owns): to header as an alloc'd string or NULL