Changeset 3603

Show
Ignore:
Timestamp:
04/20/08 18:18:17
Author:
pvanhoof
Message:

Doc cleanup

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

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

    r3602 r3603  
    4343 
    4444</para> 
    45  
    46  
    47 <!-- ##### SIGNAL TnyAccountStore::connecting-started ##### --> 
    48 <para> 
    49  
    50 </para> 
    51  
    52 @: 
    53  
    54 @tnyaccountstore: the object which received the signal. 
    5545 
    5646<!-- ##### STRUCT TnyAccountStoreIface ##### --> 

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

    r3602 r3603  
    2323</para> 
    2424 
    25  
    26 <!-- ##### SIGNAL TnyAccount::changed ##### --> 
    27 <para> 
    28  
    29 </para> 
    30  
    31 @tnyaccount: the object which received the signal. 
    32  
    33 <!-- ##### SIGNAL TnyAccount::connection-status-changed ##### --> 
    34 <para> 
    35  
    36 </para> 
    37  
    38 @: 
    39  
    40 @Param2:  
    41 @Param2:  
    4225 
    4326<!-- ##### STRUCT TnyAccountIface ##### --> 

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

    r3602 r3603  
    3131</para> 
    3232 
    33  
    34 <!-- ##### SIGNAL TnyDevice::connection-changed ##### --> 
    35 <para> 
    36  
    37 </para> 
    38  
    39 @:  
    40 @: 
    41  
    42 @tnydevice: the object which received the signal. 
    43 @arg1:  
    4433 
    4534<!-- ##### STRUCT TnyDeviceIface ##### --> 

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

    r3602 r3603  
    3434</para> 
    3535 
    36  
    37 <!-- ##### SIGNAL TnySendQueue::error-happened ##### --> 
    38 <para> 
    39  
    40 </para> 
    41  
    42 @tnysendqueue: the object which received the signal. 
    43 @arg1:  
    44 @arg2:  
    45 @arg3:  
    46  
    47 <!-- ##### SIGNAL TnySendQueue::msg-sending ##### --> 
    48 <para> 
    49  
    50 </para> 
    51  
    52 @tnysendqueue: the object which received the signal. 
    53 @arg1:  
    54 @arg2:  
    55 @arg3:  
    56 @arg4:  
    57  
    58 <!-- ##### SIGNAL TnySendQueue::msg-sent ##### --> 
    59 <para> 
    60  
    61 </para> 
    62  
    63 @tnysendqueue: the object which received the signal. 
    64 @arg1:  
    65 @arg2:  
    66 @arg3:  
    67 @arg4:  
    68  
    69 <!-- ##### SIGNAL TnySendQueue::queue-start ##### --> 
    70 <para> 
    71  
    72 </para> 
    73  
    74 @: 
    75  
    76 @tnysendqueue: the object which received the signal. 
    77  
    78 <!-- ##### SIGNAL TnySendQueue::queue-stop ##### --> 
    79 <para> 
    80  
    81 </para> 
    82  
    83 @: 
    84  
    85 @tnysendqueue: the object which received the signal. 
    8636 
    8737<!-- ##### STRUCT TnySendQueueIface ##### --> 

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

    r3602 r3603  
    805805@user_data:  
    806806 
    807  
    808 <!-- ##### USER_FUNCTION TnyGetMsgCallback ##### --> 
    809 <para> 
    810 A method that gets called after tny_folder_get_msg_async is finished 
    811 getting the message or in case there was an error. 
    812 </para> 
    813  
    814 @folder: the #TnyFolder instance from which the message was requested 
    815 @cancelled:  
    816 @msg: the #TnyMsg instance that was requested 
    817 @err: in case there was an error, this !GError instance is not NULL 
    818 @user_data: user data passed at the caller 
    819  
    820  
    821 <!-- ##### USER_FUNCTION TnyTransferMsgsCallback ##### --> 
    822 <para> 
    823 A method that gets called after tny_folder_transfer_msgs_async is finished 
    824 transferring the messages. 
    825 </para> 
    826  
    827 @folder: the #TnyFolder instance from which the messages where transferred 
    828 @cancelled:  
    829 @err: in case there was an error, this !GError instance is not NULL 
    830 @user_data: user data passed at the caller 
    831  
    832  
    833 <!-- ##### USER_FUNCTION TnyStatusCallback ##### --> 
    834 <para> 
    835 A method that gets called whenever there's a status event 
    836 </para> 
    837  
    838 @self: The sender of the status 
    839 @status: a #TnyStatus object 
    840 @user_data: user data passed by the caller 
    841  
    842  
    843 <!-- ##### USER_FUNCTION TnyGetFoldersCallback ##### --> 
    844 <para> 
    845 A method that happens after tny_folder_store_get_folders_async is finished 
    846 </para> 
    847  
    848 @self: the #TnyFolderStore from which the child folders where requested 
    849 @cancelled:  
    850 @list: a #TnyList with #TnyFolder instances (the requested children of @self) 
    851 @err: in case there was an error, this !GError instance is not NULL 
    852 @user_data: user data passed at the caller 
    853  
    854  
    855807<!-- ##### USER_FUNCTION TnyCopyFolderCallback ##### --> 
    856808<para> 

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

    r3408 r3603  
    3030</para> 
    3131 
    32  
    33 <!-- ##### SIGNAL TnyStoreAccount::subscription-changed ##### --> 
    34 <para> 
    35  
    36 </para> 
    37  
    38 @tnystoreaccount: the object which received the signal. 
    39 @arg1:  
    4032 
    4133<!-- ##### STRUCT TnyStoreAccountIface ##### --> 

  • trunk/libtinymail/tny-account.h

    r3304 r3603  
    9393        void (*set_url_string) (TnyAccount *self, const gchar *url_string); 
    9494        void (*set_pass_func) (TnyAccount *self, TnyGetPassFunc get_pass_func); 
    95         void (*set_forget_pass_func) (TnyAccount *self, TnyForgetPassFunc get_forget_pass_func); 
     95        void (*set_forget_pass_func) (TnyAccount *self, TnyForgetPassFunc forget_pass_func); 
    9696        TnyGetPassFunc (*get_pass_func) (TnyAccount *self); 
    9797        TnyForgetPassFunc (*get_forget_pass_func) (TnyAccount *self); 
    …… 
    143143gchar* tny_account_get_url_string (TnyAccount *self); 
    144144TnyGetPassFunc tny_account_get_pass_func (TnyAccount *self); 
    145 void tny_account_set_forget_pass_func (TnyAccount *self, TnyForgetPassFunc forget_pass); 
     145void tny_account_set_forget_pass_func (TnyAccount *self, TnyForgetPassFunc forget_pass_func); 
    146146TnyForgetPassFunc tny_account_get_forget_pass_func (TnyAccount *self); 
    147147void tny_account_cancel (TnyAccount *self); 

  • trunk/libtinymail/tny-shared.h

    r3454 r3603  
    107107 
    108108 
     109/**  
     110 * TnyStatusCallback: 
     111 * @self: The sender of the status 
     112 * @status: a #TnyStatus object 
     113 * @user_data: user data passed by the caller 
     114 *  
     115 * A method that gets called whenever there's a status event 
     116 **/ 
    109117typedef void (*TnyStatusCallback) (GObject *self, TnyStatus *status, gpointer user_data); 
    110118