Changeset 3435

Show
Ignore:
Timestamp:
02/28/08 19:11:51
Author:
svillar
Message:

Added some documentation fixes

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • releases/v1.0/pre-releases/v0.0.8/docs/devel/reference/Makefile.am

    r3187 r3435  
     1 
    12## Process this file with automake to produce Makefile.in 
    23 
    …… 
    6869# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). 
    6970# e.g. content_files=running.sgml building.sgml changes-2.0.sgml 
    70 content_files=xml/tree_index.sgml 
     71#content_files=xml/tree_index.sgml 
    7172 
    7273# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded 

  • releases/v1.0/pre-releases/v0.0.8/libtinymail-camel/tny-camel-common.c

    r3280 r3435  
    3636 
    3737/* TODOL Rename to tny_camel_session_check_operation. */ 
    38 /** _tny_session_check_operation: 
     38/**  
     39 * _tny_session_check_operation: 
    3940 * @session: A camel session. 
    40  * @err: A pointer to a GError*, which will be set if the session is not ready.  
     41 * @err: A pointer to a #GError *, which will be set if the session is not ready.  
    4142 * This should be freed with g_error_free(). 
    4243 * @domain The error domain for the GError, if necessary. 
    4344 * @code The error code for the GError if necessary. 
    44  * @result: TRUE if the session is ready to be used. 
    4545 * 
    4646 * Check that the session is ready to be used, and create a GError with the specified  
    4747 * domain and code if the session is not ready. 
     48 * 
     49 * Returns: %TRUE if the session is ready to be used. 
    4850 **/ 
    4951gboolean  

  • releases/v1.0/pre-releases/v0.0.8/libtinymail/tny-account.c

    r3304 r3435  
    835835 * of the account. 
    836836 * 
    837  * returns (null-ok) (caller-owns): the url-string or NULL. 
     837 * Returns: (null-ok) (caller-owns): the url-string or NULL. 
    838838 * since: 1.0 
    839839 * audience: application-developer 

  • releases/v1.0/pre-releases/v0.0.8/libtinymail/tny-common.c

    r1890 r3435  
    2424#undef TINYMAIL_ENABLE_PRIVATE_API 
    2525 
    26 /** TnyIdleStopper: 
     26/**  
     27 * TnyIdleStopper: 
    2728 *  
    2829 * This API can be used to allow 2 idle callbacks to cooperate,  
    …… 
    5758}; 
    5859 
    59 /** tny_idle_stopper_new: 
    60  * @returns: A new TnyIdleStopper instance. Release this with tny_idle_stopper_destroy(). 
     60/**  
     61 * tny_idle_stopper_new: 
    6162 *  
    6263 * Creates a new ref count object, with an initial ref count. 
    …… 
    6566 * You must call tny_idle_stopper_stop() on one of these instances, 
    6667 * and call tny_idle_stopper_destroy() on all instances. 
     68 * 
     69 * Returns: A new #TnyIdleStopper instance. Release this with tny_idle_stopper_destroy(). 
    6770 */ 
    6871TnyIdleStopper* tny_idle_stopper_new() 
    …… 
    7982} 
    8083 
    81 /** tny_idle_stopper_copy 
    82  * @stopper: The TnyIdleStopper instance to be shared. 
     84/**  
     85 * tny_idle_stopper_copy: 
     86 * @stopper: The #TnyIdleStopper instance to be shared. 
    8387 *  
    8488 * Create a shared copy of the stopper,  
    8589 * so that you can call tny_idle_stopper_stop() on one instance,  
    86  * so that tny_idle_stopper_is_stopped() returns TRUE for ther other instance. 
     90 * so that tny_idle_stopper_is_stopped() returns %TRUE for ther other instance. 
    8791 */ 
    8892TnyIdleStopper* tny_idle_stopper_copy (TnyIdleStopper *stopper) 
    …… 
    102106} 
    103107 
    104 /** tny_idle_stopper_stop: 
    105  * @stopper: The TnyIdleStopper instance. 
     108/**  
     109 * tny_idle_stopper_stop: 
     110 * @stopper: The #TnyIdleStopper instance. 
    106111 *  
    107  * Call this to make tny_idle_stopper_is_stopped() return TRUE for all  
     112 * Call this to make tny_idle_stopper_is_stopped() return %TRUE for all  
    108113 * instances of the stopper. 
    109114 */ 
    …… 
    117122} 
    118123 
    119 /** tny_idle_stopper_destroy: 
    120  * @stopper: The TnyIdleStopper instance. 
     124/**  
     125 * tny_idle_stopper_destroy: 
     126 * @stopper: The #TnyIdleStopper instance. 
    121127 *  
    122128 * Call this when you are sure that the callback will never be called again. 
    123  * For instance, in your GDestroyNotify callback provided to g_idle_add_full(). 
     129 * For instance, in your #GDestroyNotify callback provided to g_idle_add_full(). 
    124130 * Do not attempt to use @stopper after calling this. 
    125131 */ 

  • releases/v1.0/pre-releases/v0.0.8/libtinymail/tny-folder.c

    r3315 r3435  
    10461046} 
    10471047 
    1048 /**  
    1049  * TnyTransferMsgsCallback: 
    1050  * @self: a #TnyFolder that caused the callback 
    1051  * @cancelled: if the operation got cancelled 
    1052  * @err: (null-ok): if an error occurred 
    1053  * @user_data: (null-ok):  user data that was passed to the callbacks 
    1054  * 
    1055  * A folder callback for when a transfer of messages was requested. If allocated, 
    1056  * you must cleanup @user_data at the end of your implementation of the callback. 
    1057  * All other fields in the parameters of the callback are read-only. 
    1058  * 
    1059  * When cancelled, @cancelled will be TRUE while @err might nonetheless be NULL. 
    1060  * If @err is not NULL, an error occurred that you should handle gracefully. 
    1061  * 
    1062  * since: 1.0 
    1063  * audience: application-developer 
    1064  **/ 
    1065  
    10661048/** 
    10671049 * tny_folder_transfer_msgs_async: 
    …… 
    12031185} 
    12041186 
    1205  
    1206 /**  
    1207  * TnyGetMsgCallback: 
    1208  * @self: a #TnyFolder that caused the callback 
    1209  * @cancelled: if the operation got cancelled 
    1210  * @msg: (null-ok): a #TnyMsg with the fetched message or NULL 
    1211  * @err: (null-ok): if an error occurred 
    1212  * @user_data: (null-ok):  user data that was passed to the callbacks 
    1213  * 
    1214  * A folder callback for when a message fetch was requested. If allocated, you 
    1215  * must cleanup @user_data at the end of your implementation of the callback. All  
    1216  * other fields in the parameters of the callback are read-only. 
    1217  * 
    1218  * When cancelled, @cancelled will be TRUE while @err might nonetheless be NULL. 
    1219  * If @err is not NULL, an error occurred that you should handle gracefully. 
    1220  * The @msg parameter might be NULL in case of error or cancellation. 
    1221  * 
    1222  * since: 1.0 
    1223  * audience: application-developer 
    1224  **/ 
    12251187 
    12261188/** 

  • releases/v1.0/pre-releases/v0.0.8/libtinymail/tny-mime-part.c

    r3387 r3435  
    822822 * Get the transfer encoding of @self or NULL if default transfer encoding 7bit. 
    823823 *  
    824  * returns (null-ok): transfer encoding 
     824 * Returns: (null-ok): transfer encoding 
    825825 * since: 1.0 
    826826 * audience: application-developer 

  • releases/v1.0/pre-releases/v0.0.8/libtinymail/tny-shared.h

    r3151 r3435  
    116116typedef void (*TnyFolderCallback) (TnyFolder *self, gboolean cancelled, GError *err, gpointer user_data); 
    117117typedef void (*TnyGetHeadersCallback) (TnyFolder *self, gboolean cancelled, TnyList *headers, GError *err, gpointer user_data); 
     118 
     119/**  
     120 * TnyGetMsgCallback: 
     121 * @folder: a #TnyFolder that caused the callback 
     122 * @cancelled: if the operation got cancelled 
     123 * @msg: (null-ok): a #TnyMsg with the fetched message or NULL 
     124 * @err: (null-ok): if an error occurred 
     125 * @user_data: (null-ok):  user data that was passed to the callbacks 
     126 * 
     127 * A folder callback for when a message fetch was requested. If allocated, you 
     128 * must cleanup @user_data at the end of your implementation of the callback. All  
     129 * other fields in the parameters of the callback are read-only. 
     130 * 
     131 * When cancelled, @cancelled will be TRUE while @err might nonetheless be NULL. 
     132 * If @err is not NULL, an error occurred that you should handle gracefully. 
     133 * The @msg parameter might be NULL in case of error or cancellation. 
     134 * 
     135 * since: 1.0 
     136 * audience: application-developer 
     137 **/ 
    118138typedef void (*TnyGetMsgCallback) (TnyFolder *folder, gboolean cancelled, TnyMsg *msg, GError *err, gpointer user_data); 
     139/**  
     140 * TnyTransferMsgsCallback: 
     141 * @folder: a #TnyFolder that caused the callback 
     142 * @cancelled: if the operation got cancelled 
     143 * @err: (null-ok): if an error occurred 
     144 * @user_data: (null-ok):  user data that was passed to the callbacks 
     145 * 
     146 * A folder callback for when a transfer of messages was requested. If allocated, 
     147 * you must cleanup @user_data at the end of your implementation of the callback. 
     148 * All other fields in the parameters of the callback are read-only. 
     149 * 
     150 * When cancelled, @cancelled will be TRUE while @err might nonetheless be NULL. 
     151 * If @err is not NULL, an error occurred that you should handle gracefully. 
     152 * 
     153 * since: 1.0 
     154 * audience: application-developer 
     155 **/ 
    119156typedef void (*TnyTransferMsgsCallback) (TnyFolder *folder, gboolean cancelled, GError *err, gpointer user_data); 
    120157typedef void (*TnyCopyFolderCallback) (TnyFolder *self, gboolean cancelled, TnyFolderStore *into, TnyFolder *new_folder, GError *err, gpointer user_data); 

  • releases/v1.0/pre-releases/v0.0.8/libtinymailui-gtk/tny-gtk-msg-view.c

    r3315 r3435  
    353353 * @self: a #TnyGtkMsgView 
    354354 * @status_callback: (null-ok): a #TnyStatusCallback or NULL 
    355  * @stats_user_data: (null-ok): user data for @status_callback 
     355 * @status_user_data: (null-ok): user data for @status_callback 
    356356 * 
    357357 * Set the status callback info. This callback can be NULL and will be called 
    …… 
    375375 * @self: a #TnyGtkMsgView 
    376376 * @status_callback: (out): byref a #TnyStatusCallback  
    377  * @stats_user_data: (out): byref user data for @status_callback 
     377 * @status_user_data: (out): byref user data for @status_callback 
    378378 * 
    379379 * Get the status callback info. Usually internally used.