Changeset 2663

Show
Ignore:
Timestamp:
09/02/07 13:26:11
Author:
pvanhoof
Message:

Documentation updates for v0.0.2

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

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

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

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

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

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

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

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

    r2574 r2663  
    112112@TNY_SEND_QUEUE_ERROR_ADD:  
    113113@TNY_ACCOUNT_STORE_ERROR_CANCEL_ALERT:  
     114@TNY_FOLDER_ERROR_REMOVE_MSGS:  
    114115 
    115116<!-- ##### ENUM TnyAccountType ##### --> 

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

    r2574 r2663  
    3131@parent:  
    3232@remove_msg_func:  
     33@remove_msgs_func:  
    3334@add_msg_func:  
     35@add_msg_async_func:  
    3436@sync_func:  
    3537@sync_async_func:  
    …… 
    140142 
    141143 
     144<!-- ##### FUNCTION tny_folder_remove_msgs ##### --> 
     145<para> 
     146 
     147</para> 
     148 
     149@self:  
     150@headers:  
     151@err:  
     152 
     153 
     154<!-- ##### FUNCTION tny_folder_remove_msg_async ##### --> 
     155<para> 
     156 
     157</para> 
     158 
     159@self:  
     160@header:  
     161@err:  
     162 
     163 
    142164<!-- ##### FUNCTION tny_folder_add_msg ##### --> 
    143165<para> 
    …… 
    148170@msg:  
    149171@err:  
     172 
     173 
     174<!-- ##### FUNCTION tny_folder_add_msg_async ##### --> 
     175<para> 
     176 
     177</para> 
     178 
     179@self:  
     180@msg:  
     181@callback:  
     182@status_callback:  
     183@user_data:  
    150184 
    151185 

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

    r2574 r2663  
    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

    r2574 r2663  
    4747</para> 
    4848 
    49 @tnyaccountstore: the object which received the signal. 
     49@:  
    5050 
    5151<!-- ##### STRUCT TnyAccountStoreIface ##### --> 
    …… 
    133133@parent:  
    134134@remove_msg_func:  
     135@remove_msgs_func:  
    135136@add_msg_func:  
     137@add_msg_async_func:  
    136138@sync_func:  
    137139@sync_async_func:  
    …… 
    248250</para> 
    249251 
    250 @:  
     252@tnyaccount: the object which received the signal. 
    251253 
    252254<!-- ##### SIGNAL TnyAccount::connection-status-changed ##### --> 
    …… 
    305307</para> 
    306308 
    307 @tnydevice: the object which received the signal. 
    308 @arg1:  
     309@:  
     310@:  
    309311 
    310312<!-- ##### STRUCT TnyDeviceIface ##### --> 
    …… 
    380382@write_to_stream_func:  
    381383 
    382 <!-- ##### USER_FUNCTION TnyGetPassFunc ##### --> 
    383 <para> 
    384 This method happens whenever the password must be requested from the user. You must return the password for #TnyAccount self. 
    385 </para> 
    386  
    387 @self: The #TnyAccount instance for which the password is needed 
    388 @prompt: A prompt that you can display to the user. This is a human-readable password question, possibly  
    389 containing an untranslated error message directly from the server. This should be ignored by most  
    390 implementations, so NULL is an acceptable value. 
    391 @cancel: A by-ref boolean for if the user wants to cancel the connection request 
    392 @Returns: Return the password for #TnyAccount self entered by the user. 
    393  
    394  
    395 <!-- ##### USER_FUNCTION TnyForgetPassFunc ##### --> 
    396 <para> 
    397 This method happens in case the password was wrong. Also take a look at tny_account_set_forget_pass_func 
    398 </para> 
    399  
    400 @self: the #TnyAccount instance of which the password was wrong 
    401  
    402  
    403 <!-- ##### USER_FUNCTION TnyRefreshFolderCallback ##### --> 
    404 <para> 
    405 A method that gets called after tny_folder_refresh_async is finished 
    406 refreshing the folder, in case there was an error or in case the  
    407 refreshing of the folder got cancelled. 
    408 </para> 
    409  
    410 @self: the #TnyFolder instance that got refreshed 
    411 @cancelled: whether or not the operation got cancelled 
    412 @err: in case there was an error, this !GError instance is not NULL 
    413 @user_data: user data passed at the caller 
    414  
    415  
    416 <!-- ##### USER_FUNCTION TnyGetHeadersCallback ##### --> 
    417 <para> 
    418  
    419 </para> 
    420  
    421 @self:  
    422 @cancelled:  
    423 @headers:  
    424 @err:  
    425 @user_data:  
    426  
    427  
    428 <!-- ##### USER_FUNCTION TnyGetMsgCallback ##### --> 
    429 <para> 
    430 A method that gets called after tny_folder_get_msg_async is finished 
    431 getting the message or in case there was an error. 
    432 </para> 
    433  
    434 @folder: the #TnyFolder instance from which the message was requested 
    435 @cancelled:  
    436 @msg: the #TnyMsg instance that was requested 
    437 @err: in case there was an error, this !GError instance is not NULL 
    438 @user_data: user data passed at the caller 
    439  
    440  
    441 <!-- ##### USER_FUNCTION TnySyncFolderCallback ##### --> 
    442 <para> 
    443  
    444 </para> 
    445  
    446 @folder:  
    447 @cancelled:  
    448 @err:  
    449 @user_data:  
    450  
    451  
    452 <!-- ##### USER_FUNCTION TnyTransferMsgsCallback ##### --> 
    453 <para> 
    454 A method that gets called after tny_folder_transfer_msgs_async is finished 
    455 transferring the messages. 
    456 </para> 
    457  
    458 @folder: the #TnyFolder instance from which the messages where transferred 
    459 @cancelled:  
    460 @err: in case there was an error, this !GError instance is not NULL 
    461 @user_data: user data passed at the caller 
    462  
    463  
    464 <!-- ##### USER_FUNCTION TnyStatusCallback ##### --> 
    465 <para> 
    466 A method that gets called whenever there's a status event 
    467 </para> 
    468  
    469 @self: The sender of the status 
    470 @status: a #TnyStatus object 
    471 @user_data: user data passed by the caller 
    472  
    473  
    474384<!-- ##### STRUCT TnySimpleList ##### --> 
    475385<para> 
    …… 
    543453@parent:  
    544454 
    545 <!-- ##### USER_FUNCTION TnyGetFoldersCallback ##### --> 
    546 <para> 
    547 A method that happens after tny_folder_store_get_folders_async is finished 
    548 </para> 
    549  
    550 @self: the #TnyFolderStore from which the child folders where requested 
    551 @cancelled:  
    552 @list: a #TnyList with #TnyFolder instances (the requested children of @self) 
    553 @err: in case there was an error, this !GError instance is not NULL 
    554 @user_data: user data passed at the caller 
    555  
    556  
    557 <!-- ##### USER_FUNCTION TnyCopyFolderCallback ##### --> 
    558 <para> 
    559  
    560 </para> 
    561  
    562 @self:  
    563 @cancelled:  
    564 @into:  
    565 @new_folder:  
    566 @err:  
    567 @user_data:  
    568  
    569  
    570455<!-- ##### STRUCT TnyMsgRemoveStrategy ##### --> 
    571456<para> 
    …… 
    593478</para> 
    594479 
    595 @:  
    596 @:  
    597 @:  
    598 @:  
     480@tnysendqueue: the object which received the signal. 
     481@arg1:  
     482@arg2:  
     483@arg3:  
    599484 
    600485<!-- ##### SIGNAL TnySendQueue::msg-sending ##### --> 
    …… 
    603488</para> 
    604489 
    605 @:  
    606 @:  
    607 @:  
    608 @:  
    609 @:  
     490@tnysendqueue: the object which received the signal. 
     491@arg1:  
     492@arg2:  
     493@arg3:  
     494@arg4:  
    610495 
    611496<!-- ##### SIGNAL TnySendQueue::msg-sent ##### --> 
    …… 
    614499</para> 
    615500 
    616 @:  
    617 @:  
    618 @:  
    619 @:  
    620 @:  
     501@tnysendqueue: the object which received the signal. 
     502@arg1:  
     503@arg2:  
     504@arg3:  
     505@arg4:  
    621506 
    622507<!-- ##### STRUCT TnySendQueueIface ##### --> 
    …… 
    803688@parent:  
    804689 
     690<!-- ##### USER_FUNCTION TnyGetPassFunc ##### --> 
     691<para> 
     692This method happens whenever the password must be requested from the user. You must return the password for #TnyAccount self. 
     693</para> 
     694 
     695@self: The #TnyAccount instance for which the password is needed 
     696@prompt: A prompt that you can display to the user. This is a human-readable password question, possibly  
     697containing an untranslated error message directly from the server. This should be ignored by most  
     698implementations, so NULL is an acceptable value. 
     699@cancel: A by-ref boolean for if the user wants to cancel the connection request 
     700@Returns: Return the password for #TnyAccount self entered by the user. 
     701 
     702 
     703<!-- ##### USER_FUNCTION TnyForgetPassFunc ##### --> 
     704<para> 
     705This method happens in case the password was wrong. Also take a look at tny_account_set_forget_pass_func 
     706</para> 
     707 
     708@self: the #TnyAccount instance of which the password was wrong 
     709 
     710 
     711<!-- ##### USER_FUNCTION TnyFolderCallback ##### --> 
     712<para> 
     713 
     714</para> 
     715 
     716@self:  
     717@cancelled:  
     718@err:  
     719@user_data:  
     720 
     721 
     722<!-- ##### USER_FUNCTION TnyGetHeadersCallback ##### --> 
     723<para> 
     724 
     725</para> 
     726 
     727@self:  
     728@cancelled:  
     729@headers:  
     730@err:  
     731@user_data:  
     732 
     733 
     734<!-- ##### USER_FUNCTION TnyGetMsgCallback ##### --> 
     735<para> 
     736A method that gets called after tny_folder_get_msg_async is finished 
     737getting the message or in case there was an error. 
     738</para> 
     739 
     740@folder: the #TnyFolder instance from which the message was requested 
     741@cancelled:  
     742@msg: the #TnyMsg instance that was requested 
     743@err: in case there was an error, this !GError instance is not NULL 
     744@user_data: user data passed at the caller 
     745 
     746 
     747<!-- ##### USER_FUNCTION TnyTransferMsgsCallback ##### --> 
     748<para> 
     749A method that gets called after tny_folder_transfer_msgs_async is finished 
     750transferring the messages. 
     751</para> 
     752 
     753@folder: the #TnyFolder instance from which the messages where transferred 
     754@cancelled:  
     755@err: in case there was an error, this !GError instance is not NULL 
     756@user_data: user data passed at the caller 
     757 
     758 
     759<!-- ##### USER_FUNCTION TnyStatusCallback ##### --> 
     760<para> 
     761A method that gets called whenever there's a status event 
     762</para> 
     763 
     764@self: The sender of the status 
     765@status: a #TnyStatus object 
     766@user_data: user data passed by the caller 
     767 
     768 
     769<!-- ##### USER_FUNCTION TnyGetFoldersCallback ##### --> 
     770<para> 
     771A method that happens after tny_folder_store_get_folders_async is finished 
     772</para> 
     773 
     774@self: the #TnyFolderStore from which the child folders where requested 
     775@cancelled:  
     776@list: a #TnyList with #TnyFolder instances (the requested children of @self) 
     777@err: in case there was an error, this !GError instance is not NULL 
     778@user_data: user data passed at the caller 
     779 
     780 
     781<!-- ##### USER_FUNCTION TnyCopyFolderCallback ##### --> 
     782<para> 
     783 
     784</para> 
     785 
     786@self:  
     787@cancelled:  
     788@into:  
     789@new_folder:  
     790@err:  
     791@user_data:  
     792 
     793 
     794<!-- ##### USER_FUNCTION TnySendQueueAddCallback ##### --> 
     795<para> 
     796 
     797</para> 
     798 
     799@self:  
     800@cancelled:  
     801@msg:  
     802@err:  
     803@user_data:  
     804 
     805