Changeset 3161

Show
Ignore:
Timestamp:
12/20/07 00:50:08
Author:
pvanhoof
Message:
        • Made the new documentation style backward compatible for gtk-doc
Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/ChangeLog

    r3157 r3161  
    112007-12-19  Philip Van Hoof <pvanhoof@gnome.org> 
    22 
    3         * New documentaiton style, third commit (libtinymailui-gtk) 
     3        * New documentation style, third commit (libtinymailui-gtk) 
    44        * Implemented support for LIST-EXTENDED's SUBSCRIBED parameter 
    55        * A fix in TnyGnomeDevice 
    66        * Experimental improvements for LIST 
     7        * Made the new documentation style backward compatible for gtk-doc 
    78 
    892007-12-18  Philip Van Hoof <pvanhoof@gnome.org> 

  • trunk/docs/devel/reference/tmpl/tny-account-store.sgml

    r3151 r3161  
    4949 
    5050</para> 
    51  
    52 @: 
    5351 
    5452@tnyaccountstore: the object which received the signal. 

  • trunk/docs/devel/reference/tmpl/tny-account.sgml

    r3151 r3161  
    2828 
    2929</para> 
     30 
     31@: 
    3032 
    3133@tnyaccount: the object which received the signal. 

  • trunk/docs/devel/reference/tmpl/tny-device.sgml

    r3151 r3161  
    3636 
    3737</para> 
    38  
    39 @:  
    40 @: 
    4138 
    4239@tnydevice: the object which received the signal. 

  • trunk/docs/devel/reference/tmpl/tny-send-queue.sgml

    r3151 r3161  
    4040</para> 
    4141 
     42@:  
     43@:  
     44@:  
     45@: 
     46 
    4247@tnysendqueue: the object which received the signal. 
    4348@arg1:  
    …… 
    4954 
    5055</para> 
     56 
     57@:  
     58@:  
     59@:  
     60@:  
     61@: 
    5162 
    5263@tnysendqueue: the object which received the signal. 
    …… 
    6071 
    6172</para> 
     73 
     74@:  
     75@:  
     76@:  
     77@:  
     78@: 
    6279 
    6380@tnysendqueue: the object which received the signal. 

  • trunk/docs/devel/reference/tmpl/tny-shared.sgml

    r3151 r3161  
    5454</para> 
    5555 
    56 @tnyaccountstore: the object which received the signal. 
     56@:  
    5757 
    5858<!-- ##### STRUCT TnyAccountStoreIface ##### --> 
    …… 
    259259</para> 
    260260 
    261 @:  
     261@tnyaccount: the object which received the signal. 
    262262 
    263263<!-- ##### SIGNAL TnyAccount::connection-status-changed ##### --> 
    …… 
    318318</para> 
    319319 
    320 @tnydevice: the object which received the signal. 
    321 @arg1:  
     320@:  
     321@:  
    322322 
    323323<!-- ##### STRUCT TnyDeviceIface ##### --> 
    …… 
    490490</para> 
    491491 
    492 @:  
    493 @:  
    494 @:  
    495 @:  
     492@tnysendqueue: the object which received the signal. 
     493@arg1:  
     494@arg2:  
     495@arg3:  
    496496 
    497497<!-- ##### SIGNAL TnySendQueue::msg-sending ##### --> 
    …… 
    500500</para> 
    501501 
    502 @:  
    503 @:  
    504 @:  
    505 @:  
    506 @:  
     502@tnysendqueue: the object which received the signal. 
     503@arg1:  
     504@arg2:  
     505@arg3:  
     506@arg4:  
    507507 
    508508<!-- ##### SIGNAL TnySendQueue::msg-sent ##### --> 
    …… 
    511511</para> 
    512512 
    513 @:  
    514 @:  
    515 @:  
    516 @:  
    517 @:  
     513@tnysendqueue: the object which received the signal. 
     514@arg1:  
     515@arg2:  
     516@arg3:  
     517@arg4:  
    518518 
    519519<!-- ##### STRUCT TnySendQueueIface ##### --> 

  • trunk/libtinymail/tny-account-store.c

    r3150 r3161  
    5151 * @url_string. If found, the returned value must be unreferenced. 
    5252 * 
    53  * returns (null-ok) (caller-owns): the found account or NULL 
     53 * returns: (null-ok) (caller-owns): the found account or NULL 
    5454 * since: 1.0 
    5555 * audience: application-developer 
    …… 
    8484 * tny_account_store_alert: 
    8585 * @self: a #TnyAccountStore 
    86  * @account (null-ok): The account or NULL 
     86 * @account: (null-ok): The account or NULL 
    8787 * @type: alert type 
    8888 * @question: whether or not this is a question 
    89  * @error: A #GError with the alert 
     89 * @error: (null-ok): A #GError with the alert 
    9090 * 
    9191 * This callback method must implements showing a message dialog appropriate  
    …… 
    176176 * must unreference the return value after use. 
    177177 * 
    178  * returns (caller-owns): the device used by @self 
     178 * returns: (caller-owns): the device used by @self 
    179179 * since: 1.0 
    180180 * audience: application-developer 
    …… 
    363363 * TnyAccountStore::connecting-started 
    364364 * @self: the object on which the signal is emitted 
    365  * @user_data: user data set when the signal handler was connected. 
     365 * @user_data: (null-ok): user data set when the signal handler was connected. 
    366366 * 
    367367 * Emitted when the store starts trying to connect the accounts. Usage of this 

  • trunk/libtinymail/tny-account.c

    r3150 r3161  
    4848 * value when you are finished with used it. 
    4949 * 
    50  * returns (caller-owns): connection policy 
     50 * returns: (caller-owns): connection policy 
    5151 * since: 1.0 
    5252 * audience: application-developer, platform-developer 
    …… 
    135135 * @domain: the domain of the #TnyStatus that will happen in @status_callback 
    136136 * @code: the code of the #TnyStatus that will happen in @status_callback 
    137  * @status_callback: status callback handler 
    138  * @status_user_data: the user-data to give to the @status_callback 
     137 * @status_callback: (null-ok) status callback handler or NULL 
     138 * @status_user_data: (null-ok): the user-data to give to the @status_callback or NULL 
    139139 * 
    140140 * Starts an operation. This only works for methods that don't end with _async. 
    …… 
    162162 * tny_account_stop_operation: 
    163163 * @self: a #TnyAccount 
    164  * @cancelled (out): NULL or byref whether the operation got canceled 
     164 * @cancelled: (out): NULL or byref whether the operation got canceled 
    165165 * 
    166166 * Stop the current operation. This only works for methods that don't end  
    …… 
    10491049 * @self: the object on which the signal is emitted 
    10501050 * @status: the #TnyConnectionStatus 
    1051  * @user_data: user data set when the signal handler was connected. 
     1051 * @user_data: (null-ok): user data set when the signal handler was connected. 
    10521052 * 
    10531053 * Emitted when the connection status of an account changes. 
    …… 
    10701070 * TnyAccount::changed 
    10711071 * @self: the object on which the signal is emitted 
    1072  * @user_data: user data set when the signal handler was connected. 
     1072 * @user_data: (null-ok): user data set when the signal handler was connected. 
    10731073 * 
    10741074 * Emitted when one of the account's properties changes. 

  • trunk/libtinymail/tny-combined-account.c

    r3150 r3161  
    389389 * actual instances to read these properties. 
    390390 * 
    391  * returns (caller-owns): A new account instance that decorates both @ta and @sa 
     391 * returns: (caller-owns): A new account instance that decorates both @ta and @sa 
    392392 * 
    393393 * since: 1.0 
    …… 
    418418 * the returned value if not needed anymore. 
    419419 * 
    420  * returns (caller-owns): the transport account in @self 
     420 * returns: (caller-owns): the transport account in @self 
    421421 * since: 1.0 
    422422 * complexity: low 
    …… 
    438438 * the returned value if not needed anymore. 
    439439 * 
    440  * returns (caller-owns): the store account in @self 
     440 * returns: (caller-owns): the store account in @self 
    441441 * since: 1.0 
    442442 * complexity: low 

  • trunk/libtinymail/tny-connection-policy.c

    r3150 r3161  
    9595/** 
    9696 * tny_connection_policy_on_disconnect: 
    97  * @self: A #TnyConnectionPolicy 
     97 * @self: a #TnyConnectionPolicy 
    9898 * @account: a #TnyAccount 
    9999 * 

  • trunk/libtinymail/tny-device.c

    r3150 r3161  
    200200 * @self: the object on which the signal is emitted 
    201201 * @arg1: Whether or not the device is now online 
    202  * @user_data: user data set when the signal handler was connected. 
     202 * @user_data: (null-ok): user data set when the signal handler was connected. 
    203203 * 
    204204 * Emitted when the connection status of a device changes. 

  • trunk/libtinymail/tny-folder-change.c

    r3150 r3161  
    8383 * value must be unreferenced after use. 
    8484 * 
    85  * returns (null-ok) (caller-owns): received message or NULL 
     85 * returns: (null-ok) (caller-owns): received message or NULL 
    8686 * since: 1.0 
    8787 * audience: application-developer 
    …… 
    377377 * tny_folder_change_get_rename: 
    378378 * @self: a #TnyFolderChange instance 
    379  * @oldname (null-ok) (out): a byref string or NULL 
     379 * @oldname: (null-ok) (out): a byref string or NULL 
    380380 * 
    381381 * Get the new name of the folder in case of a rename. This will return NULL 
    …… 
    385385 * You must not free the returned value nor the @oldname pointer. 
    386386 * 
    387  * return (null-ok): The new folder name or NULL 
     387 * return: (null-ok): The new folder name or NULL 
    388388 * since: 1.0 
    389389 * audience: application-developer 
    …… 
    441441 * Creates a changeset for @folder 
    442442 * 
    443  * returns (caller-owns): a new #TnyFolderChange instance 
     443 * returns: (caller-owns): a new #TnyFolderChange instance 
    444444 * since: 1.0 
    445445 * audience: application-developer 
    …… 
    464464 * after use. 
    465465 * 
    466  * returns (caller-owns): the #TnyFolder of this changeset 
     466 * returns: (caller-owns): the #TnyFolder of this changeset 
    467467 * since: 1.0 
    468468 * audience: application-developer 

  • trunk/libtinymail/tny-folder-monitor.c

    r3150 r3161  
    355355 * Creates a folder monitor for @folder 
    356356 * 
    357  * returns (caller-owns): a new #TnyFolderMonitor instance 
     357 * returns: (caller-owns): a new #TnyFolderMonitor instance 
    358358 * since: 1.0 
    359359 * audience: application-developer 

  • trunk/libtinymail/tny-folder-stats.c

    r3150 r3161  
    127127 * Creates a stats object for @folder 
    128128 * 
    129  * returns: a new #TnyFolderStats instance 
     129 * returns: a new #TnyFolderStats 
    130130 * since: 1.0 
    131131 * audience: application-developer 
    …… 
    149149 * after use 
    150150 * 
    151  * returns (caller-owns): the #TnyFolder instance related to @self 
     151 * returns: (caller-owns): the #TnyFolder instance related to @self 
    152152 * since: 1.0 
    153153 * audience: application-developer 

  • trunk/libtinymail/tny-folder-store-change.c

    r3150 r3161  
    249249 * Creates a changeset for @folderstore 
    250250 * 
    251  * returns (caller-owns): a new #TnyFolderStoreChange instance 
     251 * returns: (caller-owns): a new #TnyFolderStoreChange instance 
    252252 * since: 1.0 
    253253 * audience: application-developer 
    …… 
    271271 * unreferenced after use 
    272272 * 
    273  * returns (caller-owns): the #TnyFolderStore related to this changeset 
     273 * returns: (caller-owns): the #TnyFolderStore related to this changeset 
    274274 * since: 1.0 
    275275 * audience: application-developer 

  • trunk/libtinymail/tny-folder-store-query.c

    r3150 r3161  
    4545 * Create a new #TnyFolderStoreQuery instance 
    4646 *  
    47  * returns (caller-owns): a new #TnyFolderStoreQuery instance 
     47 * returns: (caller-owns): a new #TnyFolderStoreQuery instance 
    4848 * since: 1.0 
    4949 * audience: application-developer 
    …… 
    194194 * tny_folder_store_query_add_item: 
    195195 * @query: a #TnyFolderStoreQuery 
    196  * @pattern (null-ok): a regular expression or NULL 
     196 * @pattern: (null-ok): a regular expression or NULL 
    197197 * @options: a #TnyFolderStoreQueryOption enum 
    198198 * 
    …… 
    304304 * after use. 
    305305 * 
    306  * returns (caller-owns): a list of query items 
     306 * returns: (caller-owns): a list of query items 
    307307 * since: 1.0 
    308308 * audience: tinymail-developer 
    …… 
    339339 * value. 
    340340 * 
    341  * returns (null-ok): the compiled regular expression of a query item 
     341 * returns: (null-ok): the compiled regular expression of a query item 
    342342 * since: 1.0 
    343343 * audience: tinymail-developer 
    …… 
    357357 * value. 
    358358 * 
    359  * returns (null-ok): the pattern of the regular expression of a query item 
     359 * returns: (null-ok): the pattern of the regular expression of a query item 
    360360 * since: 1.0 
    361361 * audience: tinymail-developer 

  • trunk/libtinymail/tny-folder-store.c

    r3151 r3161  
    112112 * @self: a #TnyFolderStore 
    113113 * @folder: a #TnyFolder to remove 
    114  * @err: a #GError or NULL 
     114 * @err: (null-ok): a #GError or NULL 
    115115 * 
    116116 * Removes a @folder from the folder store @self. You are responsible for  
    …… 
    166166 * @self: a #TnyFolderStore  
    167167 * @name: The folder name to create 
    168  * @err (null-ok): a #GError or NULL 
     168 * @err: (null-ok): a #GError or NULL 
    169169 * 
    170170 * Creates a new folder in @self. If not NULL, the value returned is the newly  
    …… 
    180180 * </programlisting></informalexample> 
    181181 *  
    182  * returns (null-ok) (caller-owns): the folder that was created or NULL 
     182 * returns: (null-ok) (caller-owns): the folder that was created or NULL 
    183183 * since: 1.0 
    184184 * audience: application-developer 
    …… 
    212212 * @self: a #TnyFolderStore that caused the callback 
    213213 * @cancelled: if the operation got cancelled 
    214  * @new_folder (null-ok): a newly created #TnyFolder or NULL 
    215  * @err (null-ok): if an error occurred 
    216  * @user_data (null-ok):  user data that was passed to the callbacks 
     214 * @new_folder: (null-ok): a newly created #TnyFolder or NULL 
     215 * @err: (null-ok): if an error occurred 
     216 * @user_data: (null-ok):  user data that was passed to the callbacks 
    217217 * 
    218218 * A folder store callback for when a folder creation was requested. If allocated, 
    …… 
    233233 * @self: a #TnyFolderStore  
    234234 * @name: The folder name to create 
    235  * @callback (null-ok): a #TnyCreateFolderCallback or NULL 
    236  * @status_callback (null-ok): a #TnyStatusCallback or NULL 
    237  * @user_data (null-ok): user data that will be passed to the callbacks 
     235 * @callback: (null-ok): a #TnyCreateFolderCallback or NULL 
     236 * @status_callback: (null-ok): a #TnyStatusCallback or NULL 
     237 * @user_data: (null-ok): user data that will be passed to the callbacks 
    238238 * 
    239239 * Creates a new folder in @self, asynchronously. 
    …… 
    265265 * @self: a #TnyFolderStore 
    266266 * @list: a #TnyList to to which the folders will be prepended 
    267  * @query (null-ok): a #TnyFolderStoreQuery or NULL 
    268  * @err (null-ok): a #GError or NULL 
     267 * @query: (null-ok): a #TnyFolderStoreQuery or NULL 
     268 * @err: (null-ok): a #GError or NULL 
    269269 * 
    270270 * Get a list of child folders from @self. You can use @query to limit the list  
    …… 
    319319 * @self: a #TnyFolderStore that caused the callback 
    320320 * @cancelled: if the operation got cancelled 
    321  * @list (null-ok): a #TnyList with fetched #TnyFolder instances or NULL 
    322  * @err (null-ok): if an error occurred 
    323  * @user_data (null-ok):  user data that was passed to the callbacks 
     321 * @list: (null-ok): a #TnyList with fetched #TnyFolder instances or NULL 
     322 * @err: (null-ok): if an error occurred 
     323 * @user_data: (null-ok):  user data that was passed to the callbacks 
    324324 * 
    325325 * A folder store callback for when a list of folders was requested. If allocated, 
    …… 
    341341 * @self: a #TnyFolderStore 
    342342 * @list: a #TnyList to to which the folders will be prepended 
    343  * @query (null-ok): A #TnyFolderStoreQuery object 
    344  * @callback (null-ok): a #TnyGetFoldersCallback or NULL 
    345  * @status_callback (null-ok): a #TnyStatusCallback or NULL 
    346  * @user_data (null-ok): user data that will be passed to the callbacks 
     343 * @query: (null-ok): A #TnyFolderStoreQuery object 
     344 * @callback: (null-ok): a #TnyGetFoldersCallback or NULL 
     345 * @status_callback: (null-ok): a #TnyStatusCallback or NULL 
     346 * @user_data: (null-ok): user data that will be passed to the callbacks 
    347347 * 
    348348 * Get a list of child folders from the folder store @self and call back when  

  • trunk/libtinymail/tny-folder.c

    r3151 r3161  
    7676 * the password of the IMAP account but can contain it. 
    7777 *  
    78  * returns (null-ok) (caller-owns): The url string or NULL. 
     78 * returns: (null-ok) (caller-owns): The url string or NULL. 
    7979 * since: 1.0 
    8080 * audience: application-developer 
    …… 
    115115 * this method you get a combined statistic, however. 
    116116 * 
    117  * return (caller-owns): some statistics of the folder 
     117 * return: (caller-owns): some statistics of the folder 
    118118 * since: 1.0 
    119119 * audience: application-developer 
    …… 
    231231 * must be unreferenced after use. 
    232232 * 
    233  * returns (caller-owns): the strategy for receiving a message 
     233 * returns: (caller-owns): the strategy for receiving a message 
    234234 * since: 1.0 
    235235 * audience: application-developer 
    …… 
    306306 * @new_name: the new name in @into 
    307307 * @del: whether or not to delete the original location 
    308  * @err (null-ok): a #GError object or NULL 
     308 * @err: (null-ok): a #GError object or NULL 
    309309 * 
    310310 * Copies @self to @into giving the new folder the name @new_name. Returns the 
    …… 
    340340 * be set in @err and no further action will be performed. 
    341341 *  
    342  * returns (null-ok) (caller-owns): a new folder instance to whom was copied or NULL 
     342 * returns: (null-ok) (caller-owns): a new folder instance to whom was copied or NULL 
    343343 * since: 1.0 
    344344 * audience: application-developer 
    …… 
    379379 * @self: a #TnyFolder that caused the callback 
    380380 * @cancelled: if the operation got cancelled 
    381  * @into (null-ok): where @self got copied to 
    382  * @new_folder (null-ok): the new folder in @into 
    383  * @err (null-ok): if an error occurred 
    384  * @user_data (null-ok):  user data that was passed to the callbacks 
     381 * @into: (null-ok): where @self got copied to 
     382 * @new_folder: (null-ok): the new folder in @into 
     383 * @err: (null-ok): if an error occurred 
     384 * @user_data: (null-ok):  user data that was passed to the callbacks 
    385385 * 
    386386 * A folder callback for when a copy of a folder was requested. If allocated, 
    …… 
    415415 * @new_name: the new name in @into 
    416416 * @del: whether or not to delete the original location 
    417  * @callback (null-ok): a #TnyCopyFolderCallback or NULL 
    418  * @status_callback (null-ok): a #TnyStatusCallback or NULL 
    419  * @user_data (null-ok): user data that will be passed to the callbacks 
     417 * @callback: (null-ok): a #TnyCopyFolderCallback or NULL 
     418 * @status_callback: (null-ok): a #TnyStatusCallback or NULL 
     419 * @user_data: (null-ok): user data that will be passed to the callbacks 
    420420 * 
    421421 * See tny_folder_copy(). This is the asynchronous version of the same function. 
    …… 
    487487 * must be unreferenced after use. 
    488488 * 
    489  * returns (caller-owns): the strategy for removing a message 
     489 * returns: (caller-owns): the strategy for removing a message 
    490490 * since: 1.0 
    491491 * audience: application-developer 
    …… 
    551551 * @self: a #TnyFolder 
    552552 * @expunge: also expunge deleted messages 
    553  * @err (null-ok): a #GError or NULL 
     553 * @err: (null-ok): a #GError or NULL 
    554554 * 
    555555 * Persist changes made to a folder to its backing store, expunging deleted  
    …… 
    588588 * @self: a #TnyFolder 
    589589 * @expunge: also expunge deleted messages 
    590  * @callback (null-ok): a #TnySyncFolderCallback or NULL 
     590 * @callback: (null-ok): a #TnySyncFolderCallback or NULL 
    591591 * @status_callback (null-ok): a #TnyStatusCallback or NULL 
    592  * @user_data (null-ok): user data that will be passed to the callbacks 
     592 * @user_data: (null-ok): user data that will be passed to the callbacks 
    593593 * 
    594594 * The authors of Tinymail know that sync async sounds paradoxical. Though if 
    …… 
    620620 * @self: a #TnyFolder that caused the callback 
    621621 * @cancelled: if the operation got cancelled 
    622  * @err (null-ok): if an error occurred 
    623  * @user_data (null-ok):  user data that was passed to the callbacks 
     622 * @err: (null-ok): if an error occurred 
     623 * @user_data: (null-ok):  user data that was passed to the callbacks 
    624624 * 
    625625 * A generic folder callback. If allocated, you must cleanup @user_data at the 
    …… 
    635635 * @self: a #TnyFolder 
    636636 * @msg: a #TnyMsg 
    637  * @callback (null-ok): a #TnyFolderCallback or NULL 
    638  * @status_callback (null-ok): a #TnyStatusCallback or NULL 
    639  * @user_data (null-ok): user data that will be passed to the callbacks 
     637 * @callback: (null-ok): a #TnyFolderCallback or NULL 
     638 * @status_callback: (null-ok): a #TnyStatusCallback or NULL 
     639 * @user_data: (null-ok): user data that will be passed to the callbacks 
    640640 * 
    641641 * Add a message to a @self. It's recommended to destroy @msg afterwards because  
    …… 
    667667 * @self: a #TnyFolder 
    668668 * @msg: a #TnyMsg 
    669  * @err (null-ok): a #GError or NULL 
     669 * @err: (null-ok): a #GError or NULL 
    670670 * 
    671671 * Add a message to a @self. It's recommended to destroy @msg afterwards because  
    …… 
    696696 * @self: a #TnyFolder 
    697697 * @header: a #TnyHeader of the message to remove 
    698  * @err: a #GError or NULL 
     698 * @err: (null-ok): a #GError or NULL 
    699699 * 
    700700 * Remove a message from a folder. It will use the #TnyMsgRemoveStrategy of  
    …… 
    753753 * @self: a #TnyFolder 
    754754 * @headers: a #TnyList with #TnyHeader items of the messages to remove 
    755  * @err: a #GError or NULL 
     755 * @err: (null-ok): a #GError or NULL 
    756756 * 
    757757 * Remove messages from a folder. It will use the #TnyMsgRemoveStrategy of  
    …… 
    783783 * tny_folder_refresh_async: 
    784784 * @self: a #TnyFolder 
    785  * @callback (null-ok): a #TnyFolderCallback or NULL 
    786  * @status_callback (null-ok): a #TnyStatusCallback or NULL 
    787  * @user_data (null-ok): user data that will be passed to the callbacks 
     785 * @callback: (null-ok): a #TnyFolderCallback or NULL 
     786 * @status_callback: (null-ok): a #TnyStatusCallback or NULL 
     787 * @user_data: (null-ok): user data that will be passed to the callbacks 
    788788 * 
    789789 * Refresh @self and callback when finished. This gets the summary information 
    …… 
    855855 * tny_folder_refresh: 
    856856 * @self: a #TnyFolder 
    857  * @err: a #GError or NULL 
     857 * @err: (null-ok): a #GError or NULL 
    858858 * 
    859859 * Refresh @self. This gets the summary information from the E-Mail service,  
    …… 
    984984 * the return value after use. 
    985985 *  
    986  * returns (null-ok) (caller-owns): the account of this folder or NULL 
     986 * returns: (null-ok) (caller-owns): the account of this folder or NULL 
    987987 * since: 1.0 
    988988 * audience: application-developer 
    …… 
    10151015 * @folder_dst: a destination #TnyFolder 
    10161016 * @delete_originals: TRUE moves msgs, FALSE copies 
    1017  * @err: a #GError or NULL 
     1017 * @err: (null-ok): a #GError or NULL 
    10181018 *  
    10191019 * Transfers messages of which the headers are in @header_list from @self to  
    …… 
    10481048 * @self: a #TnyFolder that caused the callback 
    10491049 * @cancelled: if the operation got cancelled 
    1050  * @err (null-ok): if an error occurred 
    1051  * @user_data (null-ok):  user data that was passed to the callbacks 
     1050 * @err: (null-ok): if an error occurred 
     1051 * @user_data: (null-ok):  user data that was passed to the callbacks 
    10521052 * 
    10531053 * A folder callback for when a transfer of messages was requested. If allocated, 
    …… 
    10681068 * @folder_dst: a destination #TnyFolder 
    10691069 * @delete_originals: TRUE moves msgs, FALSE copies 
    1070  * @callback (null-ok): a #TnyTransferMsgsCallback or NULL 
    1071  * @status_callback (null-ok): a #TnyStatusCallback or NULL 
    1072  * @user_data (null-ok): user data that will be passed to the callbacks 
     1070 * @callback: (null-ok): a #TnyTransferMsgsCallback or NULL 
     1071 * @status_callback: (null-ok): a #TnyStatusCallback or NULL 
     1072 * @user_data: (null-ok): user data that will be passed to the callbacks 
    10731073 *  
    10741074 * Transfers messages of which the headers are in @header_list from @self to  
    …… 
    11041104 * @self: a #TnyFolder 
    11051105 * @header: a #TnyHeader the message to get 
    1106  * @err: a #GError or NULL 
     1106 * @err: (null-ok): a #GError or NULL 
    11071107 *  
    11081108 * Get a message in @self identified by @header. If not NULL, you must  
    …… 
    11161116 * TnyMsg *message = tny_folder_get_msg (folder, header, NULL); 
    11171117 * tny_msg_view_set_msg (message_view, message); 
    1118  * g_object_unref (G_OBJECT (message)); 
     1118 * g_object_unref (message); 
    11191119 * </programlisting></informalexample> 
    11201120 * 
    …… 
    11271127 * updates from the observable folder. 
    11281128 *  
    1129  * returns (null-ok) (caller-owns): The message instance or NULL 
     1129 * returns: (null-ok) (caller-owns): The message instance or NULL 
    11301130 * since: 1.0 
    11311131 * audience: application-developer 
    …… 
    11591159 * @self: a #TnyFolder 
    11601160 * @url_string: the url string 
    1161  * @err: a #GError or NULL 
     1161 * @err: (null-ok): a #GError or NULL 
    11621162 *  
    11631163 * Get the message in @self identified by @url_string. If not NULL, you must  
    …… 
    11741174 * </programlisting></informalexample> 
    11751175 * 
    1176  * returns (null-ok) (caller-owns): The message instance or NULL 
     1176 * returns: (null-ok) (caller-owns): The message instance or NULL 
    11771177 * since: 1.0 
    11781178 * audience: application-developer 
    …… 
    12061206 * @self: a #TnyFolder that caused the callback 
    12071207 * @cancelled: if the operation got cancelled 
    1208  * @msg (null-ok): a #TnyMsg with the fetched message or NULL 
    1209  * @err (null-ok): if an error occurred 
    1210  * @user_data (null-ok):  user data that was passed to the callbacks 
     1208 * @msg: (null-ok): a #TnyMsg with the fetched message or NULL 
     1209 * @err: (null-ok): if an error occurred 
     1210 * @user_data: (null-ok):  user data that was passed to the callbacks 
    12111211 * 
    12121212 * A folder callback for when a message fetch was requested. If allocated, you 
    …… 
    12261226 * @self: a #TnyFolder 
    12271227 * @header: a #TnyHeader of the message to get 
    1228  * @callback (null-ok): a #TnyGetMsgCallback or NULL 
    1229  * @status_callback (null-ok): a #TnyStatusCallback or NULL 
    1230  * @user_data (null-ok): user data that will be passed to the callbacks 
     1228 * @callback: (null-ok): a #TnyGetMsgCallback or NULL 
     1229 * @status_callback: (null-ok): a #TnyStatusCallback or NULL 
     1230 * @user_data: (null-ok): user data that will be passed to the callbacks 
    12311231 * 
    12321232 * Get a message in @self identified by @header asynchronously. 
    …… 
    12751275 * @headers: A #TnyList where the headers will be prepended to 
    12761276 * @refresh: synchronize with the service first 
    1277  * @err: a #GError or NULL 
     1277 * @err: (null-ok): a #GError or NULL 
    12781278 *  
    12791279 * Get the list of message header instances that are in @self. Also read 
    …… 
    13231323 * @self: a #TnyFolder that caused the callback 
    13241324 * @cancelled: if the operation got cancelled 
    1325  * @headers (null-ok): a #TnyList with fetched #TnyHeader instances or NULL 
    1326  * @err (null-ok): if an error occurred 
    1327  * @user_data (null-ok):  user data that was passed to the callbacks 
     1325 * @headers: (null-ok): a #TnyList with fetched #TnyHeader instances or NULL 
     1326 * @err: (null-ok): if an error occurred 
     1327 * @user_data: (null-ok):  user data that was passed to the callbacks 
    13281328 * 
    13291329 * A folder callback for when headers where requested. If allocated, you must 
    …… 
    13441344 * @headers: A #TnyList where the headers will be prepended to 
    13451345 * @refresh: synchronize with the service first 
    1346  * @callback (null-ok): a #TnyGetHeadersCallback or NULL 
    1347  * @status_callback (null-ok): a #TnyStatusCallback or NULL 
    1348  * @user_data (null-ok): user data that will be passed to the callbacks 
     1346 * @callback: (null-ok): a #TnyGetHeadersCallback or NULL 
     1347 * @status_callback: (null-ok): a #TnyStatusCallback or NULL 
     1348 * @user_data: (null-ok): user data that will be passed to the callbacks 
    13491349 *  
    13501350 * Get the list of message header instances that are in @self. Also read 
    …… 
    14741474 * to be inside a folder store. This API will in that case return NULL. 
    14751475 *  
    1476  * returns (null-ok) (caller-owns): the folder store of this folder or NULL 
     1476 * returns: (null-ok) (caller-owns): the folder store of this folder or NULL 
    14771477 * since: 1.0 
    14781478 * complexity: low 

  • trunk/libtinymail/tny-fs-stream.c

    r3150 r3161  
    188188 * kill your cat and dog (yes, both of them). 
    189189 * 
    190  * returns (caller-owns): a new #TnyStream instance 
     190 * returns: (caller-owns): a new #TnyStream instance 
    191191 * since: 1.0 
    192192 * audience: tinymail-developer 
    …… 
    218218        if (priv->fd != -1) { 
    219219                fsync (priv->fd); 
    220                 close (priv->fd);            
     220                close (priv->fd); 
    221221        } 
    222222        priv->fd = -1; 

  • trunk/libtinymail/tny-header.c

    r3150 r3161  
    4040 * tny_header_set_replyto: 
    4141 * @self: a #TnyHeader 
    42  * @to (null-ok): the reply-to header or NULL 
     42 * @to: (null-ok): the reply-to header or NULL 
    4343 *  
    4444 * Set the reply-to header 
    …… 
    6969 * Get the reply-to header 
    7070 *  
    71  * returns (null-ok): reply-to header or NULL 
     71 * returns: (null-ok): reply-to header or NULL 
    7272 * since: 1.0 
    7373 * audience: application-developer 
    …… 
    8787 * tny_header_set_bcc: 
    8888 * @self: a #TnyHeader 
    89  * @bcc (null-ok): the BCC header in a comma separated list or NULL 
     89 * @bcc: (null-ok): the BCC header in a comma separated list or NULL 
    9090 *  
    9191 * Set the BCC header. Look at the To header for more information 
    …… 
    114114 * tny_header_set_cc: 
    115115 * @self: a #TnyHeader 
    116  * @cc (null-ok): the CC header in a comma separated list or NULL 
     116 * @cc: (null-ok): the CC header in a comma separated list or NULL 
    117117 *  
    118118 * Set the CC header. Look at the To header for more information 
    …… 
    141141 * tny_header_set_from: 
    142142 * @self: a #TnyHeader 
    143  * @from (null-ok): the from header or NULL 
     143 * @from: (null-ok): the from header or NULL 
    144144 *  
    145145 * Set the from header 
    …… 
    167167 * tny_header_set_subject: 
    168168 * @self: a #TnyHeader 
    169  * @subject (null-ok): the subject header or NULL 
     169 * @subject: (null-ok): the subject header or NULL 
    170170 *  
    171171 * Set the subject header 
    …… 
    193193 * tny_header_set_to: 
    194194 * @self: a #TnyHeader 
    195  * @to (null-ok): the To header in a comma separated list or NULL 
     195 * @to: (null-ok): the To header in a comma separated list or NULL 
    196196 *  
    197197 * Set the To header. 
    …… 
    227227 * Get the CC header. The returned value should not be freed. 
    228228 *  
    229  * returns (null-ok): CC header as a read-only string or NULL 
     229 * returns: (null-ok): CC header as a read-only string or NULL 
    230230 * since: 1.0 
    231231 * audience: application-developer 
    …… 
    248248 * Get the BCC header. The returned value should not be freed. 
    249249 *  
    250  * returns (null-ok): BCC header as a read-only string or NULL 
     250 * returns: (null-ok): BCC header as a read-only string or NULL 
    251251 * since: 1.0 
    252252 * audience: application-developer 
    …… 
    314314 * IMAP and the UIDL in POP if UIDL is supported or the UID if not. </