Changeset 1343

Show
Ignore:
Timestamp:
12/25/06 23:14:07
Author:
pvanhoof
Message:

API docs update

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/docs/devel/reference/libtinymail-docs.sgml

    r1280 r1343  
    2222<!ENTITY libtinymail-TnyMsgRemoveStrategy SYSTEM "xml/tny-msg-remove-strategy.xml"> 
    2323<!ENTITY libtinymail-TnySendQueue SYSTEM "xml/tny-send-queue.xml"> 
     24<!ENTITY libtinymail-TnyShared SYSTEM "xml/tny-shared.xml"> 
    2425 
    2526<!ENTITY libtinymail-camel-TnyCamelSendQueue SYSTEM "xml/tny-camel-send-queue.xml"> 
    …… 
    127128                &libtinymail-TnySimpleList; 
    128129                &libtinymail-TnyEnums; 
     130                &libtinymail-TnyShared; 
    129131        </chapter> 
    130132 

  • trunk/docs/devel/reference/tmpl/tny-camel-mime-part.sgml

    r1243 r1343  
    2424 
    2525 
     26<!-- ##### FUNCTION tny_camel_mime_part_new_with_part ##### --> 
     27<para> 
     28 
     29</para> 
     30 
     31@part:  
     32@Returns:  
     33 
     34 
    2635<!-- ##### FUNCTION tny_camel_mime_part_new ##### --> 
    2736<para> 
    …… 
    2938</para> 
    3039 
    31 @part:  
    3240@Returns:  
    3341 

  • trunk/docs/devel/reference/tmpl/tny-camel-msg.sgml

    r910 r1343  
    4444 
    4545 
     46<!-- ##### FUNCTION tny_camel_msg_new_with_part ##### --> 
     47<para> 
     48 
     49</para> 
     50 
     51@part:  
     52@Returns:  
     53 
     54 
     55<!-- ##### FUNCTION tny_camel_msg_new_with_part_and_header ##### --> 
     56<para> 
     57 
     58</para> 
     59 
     60@part:  
     61@header:  
     62@Returns:  
     63 
     64 

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

    r1263 r1343  
    3636@set_msg_remove_strategy_func:  
    3737@get_msg_func:  
     38@get_msg_async_func:  
    3839@get_headers_func:  
    3940@get_name_func:  
    …… 
    4849@refresh_func:  
    4950@transfer_msgs_func:  
     51@transfer_msgs_async_func:  
     52@copy_func:  
    5053 
    5154<!-- ##### MACRO TNY_TYPE_FOLDER_TYPE ##### --> 
    …… 
    120123@err:  
    121124@Returns:  
     125 
     126 
     127<!-- ##### FUNCTION tny_folder_get_msg_async ##### --> 
     128<para> 
     129 
     130</para> 
     131 
     132@self:  
     133@header:  
     134@callback:  
     135@user_data:  
    122136 
    123137 
    …… 
    238252 
    239253 
     254<!-- ##### FUNCTION tny_folder_transfer_msgs_async ##### --> 
     255<para> 
     256 
     257</para> 
     258 
     259@self:  
     260@header_list:  
     261@folder_dst:  
     262@delete_originals:  
     263@callback:  
     264@user_data:  
     265 
     266 
     267<!-- ##### FUNCTION tny_folder_copy ##### --> 
     268<para> 
     269 
     270</para> 
     271 
     272@self:  
     273@into:  
     274@new_name:  
     275@del:  
     276@err:  
     277@Returns:  
     278 
     279 

  • trunk/docs/devel/reference/tmpl/tny-gtk-msg-view.sgml

    r1200 r1343  
    7676 
    7777 
    78 <!-- ##### FUNCTION tny_gtk_msg_view_set_display_one_body ##### --> 
    79 <para> 
    80  
    81 </para> 
    82  
    83 @self:  
    84 @setting:  
    85  
    86  
    8778<!-- ##### FUNCTION tny_gtk_msg_view_get_display_html ##### --> 
    8879<para> 
    …… 
    121112 
    122113 
    123 <!-- ##### FUNCTION tny_gtk_msg_view_get_display_one_body ##### --> 
    124 <para> 
    125  
    126 </para> 
    127  
    128 @self:  
    129 @Returns:  
    130  
    131  

  • trunk/docs/devel/reference/tmpl/tny-platform-factory.sgml

    r910 r1343  
    3333@new_device_func:  
    3434@new_msg_view_func:  
     35@new_msg_func:  
     36@new_mime_part_func:  
     37@new_header_func:  
    3538 
    3639<!-- ##### FUNCTION tny_platform_factory_new_account_store ##### --> 
    …… 
    6164 
    6265 
     66<!-- ##### FUNCTION tny_platform_factory_new_msg ##### --> 
     67<para> 
     68 
     69</para> 
     70 
     71@self:  
     72@Returns:  
     73 
     74 
     75<!-- ##### FUNCTION tny_platform_factory_new_mime_part ##### --> 
     76<para> 
     77 
     78</para> 
     79 
     80@self:  
     81@Returns:  
     82 
     83 
     84<!-- ##### FUNCTION tny_platform_factory_new_header ##### --> 
     85<para> 
     86 
     87</para> 
     88 
     89@self:  
     90@Returns:  
     91 
     92 

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

    r1289 r1343  
    3939 
    4040</para> 
     41 
     42@:  
     43@:  
     44@:  
     45@: 
    4146 
    4247@tnysendqueue: the object which received the signal. 

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

    r1289 r1343  
    115115@set_msg_remove_strategy_func:  
    116116@get_msg_func:  
     117@get_msg_async_func:  
    117118@get_headers_func:  
    118119@get_name_func:  
    …… 
    127128@refresh_func:  
    128129@transfer_msgs_func:  
     130@transfer_msgs_async_func:  
     131@copy_func:  
    129132 
    130133<!-- ##### STRUCT TnyHeader ##### --> 
    …… 
    302305<!-- ##### USER_FUNCTION TnyGetPassFunc ##### --> 
    303306<para> 
    304  
    305 </para> 
    306  
    307 @self:  
    308 @prompt:  
    309 @cancel:  
    310 @Returns:  
     307This method happens whenever the password is needed. You must return the password for #TnyAccount self. 
     308</para> 
     309 
     310@self: The #TnyAccount instance for which the password is needed 
     311@prompt: A promp that you can display to your user 
     312@cancel: A by-ref boolean for if the user wants to cancel the connection request 
     313@Returns: Return the password for #TnyAccount self 
    311314 
    312315 
    313316<!-- ##### USER_FUNCTION TnyForgetPassFunc ##### --> 
    314317<para> 
    315  
    316 </para> 
    317  
    318 @self:  
     318This method happens in case the password was wrong. Also take a look at tny_account_set_forget_pass_func 
     319</para> 
     320 
     321@self: the #TnyAccount instance of which the password was wrong 
    319322 
    320323 
    321324<!-- ##### USER_FUNCTION TnyRefreshFolderCallback ##### --> 
    322325<para> 
    323  
    324 </para> 
    325  
    326 @self:  
    327 @cancelled:  
    328 @err:  
    329 @user_data:  
     326A method that gets called after tny_folder_refresh_async is finished 
     327refreshing the folder, in case there was an error or in case the  
     328refreshing of the folder got cancelled. 
     329</para> 
     330 
     331@self: the #TnyFolder instance that got refreshed 
     332@cancelled: whether or not the operation got cancelled 
     333@err: in case there was an error, this !GError instance is not NULL 
     334@user_data: user data passed at the caller 
     335 
     336 
     337<!-- ##### USER_FUNCTION TnyGetMsgCallback ##### --> 
     338<para> 
     339A method that gets called after tny_folder_get_msg_async is finished 
     340getting the message or in case there was an error. 
     341</para> 
     342 
     343@folder: the #TnyFolder instance from which the message was requested 
     344@msg: the #TnyMsg instance that was requested 
     345@err: in case there was an error, this !GError instance is not NULL 
     346@user_data: user data passed at the caller 
     347 
     348 
     349<!-- ##### USER_FUNCTION TnyTransferMsgsCallback ##### --> 
     350<para> 
     351A method that gets called after tny_folder_transfer_msgs_async is finished 
     352transferring the messages. 
     353</para> 
     354 
     355@folder: the #TnyFolder instance from which the messages where transferred 
     356@err: in case there was an error, this !GError instance is not NULL 
     357@user_data: user data passed at the caller 
    330358 
    331359 
    332360<!-- ##### USER_FUNCTION TnyRefreshFolderStatusCallback ##### --> 
    333361<para> 
    334  
    335 </para> 
    336  
    337 @self:  
    338 @what:  
    339 @status:  
    340 @user_data:  
     362A method that frequently gets called while a folder is being refreshed 
     363</para> 
     364 
     365@self: the #TnyFolder instance that is being refreshed 
     366@what: a status message 
     367@status: a number that is smaller than or equal to @oftotal indicating the amount that is done 
     368@oftotal: the total amount that is to be done 
     369@user_data: user data passed at the caller 
    341370 
    342371 
    …… 
    412441<!-- ##### USER_FUNCTION TnyGetFoldersCallback ##### --> 
    413442<para> 
    414  
    415 </para> 
    416  
    417 @self:  
    418 @list:  
    419 @err:  
    420 @user_data:  
     443A method that happens after tny_folder_store_get_folders_async is finished 
     444</para> 
     445 
     446@self: the #TnyFolderStore from which the child folders where requested 
     447@list: a #TnyList with #TnyFolder instances (the requested children of @self) 
     448@err: in case there was an error, this !GError instance is not NULL 
     449@user_data: user data passed at the caller 
    421450 
    422451