Changeset 408

Show
Ignore:
Timestamp:
05/28/06 19:41:51
Author:
pvanhoof
Message:

docs updated

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

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

    r406 r408  
    9898@Returns:  
    9999 
     100<!-- ##### FUNCTION tny_device_get_new ##### --> 
     101<para> 
     102 
     103</para> 
     104 
     105@Returns:  
     106 
    100107<!-- ##### FUNCTION tny_msg_folder_proxy_new ##### --> 
    101108<para> 

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

    r406 r408  
    2626 
    2727 
    28 <!-- ##### FUNCTION tny_device_get_new ##### --> 
    29 <para> 
    30  
    31 </para> 
    32  
    33 @Returns:  
    34  
    35  

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

    r407 r408  
    375375</para> 
    376376 
    377 @expr:  
     377@expr: the expression 
    378378 
    379379 
    …… 
    383383</para> 
    384384 
    385 @expr:  
    386  
    387  
     385@expr: the expression 
     386 
     387 

  • trunk/libtinymail-camel/tny-msg-header.c

    r385 r408  
    9595} 
    9696 
     97/** 
     98 * tny_msg_header_set_use_summary: 
     99 * @self: The #TnyMsgHeader instance 
     100 * @val: Whether or not to use summary capabilities 
     101 * 
     102 **/ 
    97103void  
    98104tny_msg_header_set_use_summary (TnyMsgHeader *self, gboolean val) 

  • trunk/libtinymail-camel/tny-msg-mime-part.c

    r385 r408  
    329329} 
    330330 
    331  
     331/** 
     332 * tny_msg_mime_part_set_part: 
     333 * @self: The #TnyMsgMimePart instance 
     334 * @part: The #CamelMimePart instance 
     335 * 
     336 * 
     337 **/ 
    332338void 
    333339tny_msg_mime_part_set_part (TnyMsgMimePart *self, CamelMimePart *part) 
    …… 
    350356} 
    351357 
     358/** 
     359 * tny_msg_mime_part_get_part: 
     360 * @self: The #TnyMsgMimePart instance 
     361 * 
     362 * Return value: The #CamelMimePart instance 
     363 **/ 
    352364CamelMimePart* 
    353365tny_msg_mime_part_get_part (TnyMsgMimePart *self) 

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

    r405 r408  
    561561 
    562562/** 
    563  * tny_account_store_get_instance: 
     563 * tny_account_store_new: 
    564564 * 
    565565 * 
    566  * Return value: The #TnyAccountStoreIface singleton instance 
     566 * Return value: A new #TnyAccountStoreIface instance 
    567567 **/ 
    568568TnyAccountStore* 
    …… 
    626626} 
    627627 
     628 
     629/** 
     630 * tny_account_store_get_session: 
     631 * @self: The #TnyAccountStore instance 
     632 * 
     633 * Return value: A #TnySessionCamel instance 
     634 **/ 
    628635TnySessionCamel* 
    629636tny_account_store_get_session (TnyAccountStore *self) 

  • trunk/libtinymail-gnome-desktop/tny-device.c

    r380 r408  
    8787 
    8888/** 
    89  * tny_device_get_instance: 
     89 * tny_device_new: 
    9090 * 
    91  * 
    92  * Return value: The #TnyDeviceIface singleton instance 
     91 * Return value: A new #TnyDeviceIface instance 
    9392 **/ 
    9493TnyDevice* 

  • trunk/libtinymail-gnome-desktop/tny-device.h

    r256 r408  
    5252GType tny_device_get_type (void); 
    5353 
    54 TnyDevice* tny_device_get_new (void); 
     54TnyDevice* tny_device_new (void); 
    5555 
    5656G_END_DECLS 

  • trunk/libtinymail-gnome-desktop/tny-password-dialog.c

    r380 r408  
    7070 
    7171/** 
    72  * tny_summary_window_new: 
     72 * tny_password_dialog_new: 
    7373 *  
    7474 * 

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

    r379 r408  
    209209} 
    210210 
     211 
    211212/** 
    212213 * tny_account_iface_set_pass_func: 
    …… 
    215216 *  
    216217 * Set the function that will be called when the password is needed. 
    217  * The function must resturn a newly allocated string with the password. 
    218218 * 
    219219 * You need to set this property before you can start using the account. 

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

    r398 r408  
    136136 * TnyAccountStoreIface::account_changed: 
    137137 * @self: the object on which the signal is emitted 
    138  * @account: the #TnyAccountIface of the account that changed 
     138 * @arg1: the #TnyAccountIface of the account that changed 
     139 * @user_data: user data set when the signal handler was connected 
    139140 * 
    140141 * Emitted when an account in the store changed 
    …… 
    152153 * TnyAccountStoreIface::account_inserted: 
    153154 * @self: the object on which the signal is emitted 
    154  * @account: the #TnyAccountIface of the account that got inserted 
     155 * @arg1: the #TnyAccountIface of the account that got inserted 
     156 * @user_data: user data set when the signal handler was connected. 
    155157 * 
    156158 * Emitted when an account is added to the store 
    …… 
    170172 * TnyAccountStoreIface::account_removed: 
    171173 * @self: the object on which the signal is emitted 
    172  * @account: the #TnyAccountIface of the account that got removed 
     174 * @arg1: the #TnyAccountIface of the account that got removed 
     175 * @user_data: user data set when the signal handler was connected. 
    173176 * 
    174177 * Emitted when an account is removed from the store 

  • trunk/libtinymail/tny-device-iface.c

    r398 r408  
    4444 * TnyDeviceIface::connection_changed: 
    4545 * @self: the object on which the signal is emitted 
    46  * @online: Whether or not the device is now online 
     46 * @arg1: Whether or not the device is now online 
     47 * @user_data: user data set when the signal handler was connected. 
    4748 * 
    4849 * Emitted when the connection status of a device changes. 

  • trunk/libtinymail/tny-msg-folder-iface.c

    r398 r408  
    287287 * TnyMsgFolderIface::folder_inserted: 
    288288 * @self: the object on which the signal is emitted 
     289 * @arg1: The folder that got inserted 
    289290 * @folder: the #TnyMsgFolderIface as the added folder 
    290291 * 

  • trunk/libtinymail/tny-msg-mime-part-iface.c

    r398 r408  
    202202 * @self: a #TnyMsgMimePartIface object 
    203203 * @stream: a #TnyMsgStreamIface stream 
     204 * @type: the type like text/plain 
    204205 *  
    205206 * Set the stream from which the message part will read its content 

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

    r379 r408  
    119119 
    120120/** 
    121  * tny_stream_iface_eos: 
     121 * tny_stream_iface_reset: 
    122122 * @self: a #TnyStreamIface object 
    123123 *  

  • trunk/libtinymailui-mozembed/tny-moz-embed-msg-view.c

    r380 r408  
    275275 
    276276/** 
    277  * tny_mozembed_msg_view_new: 
     277 * tny_moz_embed_msg_view_new: 
    278278 * @save_strategy: The save strategy to use 
    279279 * 

  • trunk/libtinymailui/tny-platform-factory-iface.c

    r379 r408  
    2222#include <tny-platform-factory-iface.h> 
    2323 
    24  
     24/** 
     25 * tny_platform_factory_iface_new_account_store: 
     26 * @self: a TnyPlatformFactoryIface object 
     27 * 
     28 * Return value: a #TnyAccountStoreIface instance 
     29 **/ 
    2530TnyAccountStoreIface* 
    2631tny_platform_factory_iface_new_account_store (TnyPlatformFactoryIface *self) 
    …… 
    2934} 
    3035 
     36/** 
     37 * tny_platform_factory_iface_new_device: 
     38 * @self: a TnyPlatformFactoryIface object 
     39 * 
     40 * Return value: a #TnyDeviceIface instance 
     41 **/ 
    3142TnyDeviceIface* 
    3243tny_platform_factory_iface_new_device (TnyPlatformFactoryIface *self) 
    …… 
    3546} 
    3647 
     48/** 
     49 * tny_platform_factory_iface_new_msg_view: 
     50 * @self: a TnyPlatformFactoryIface object 
     51 * 
     52 * Return value: a #TnyMsgViewIface instance 
     53 **/ 
    3754TnyMsgViewIface* 
    3855tny_platform_factory_iface_new_msg_view (TnyPlatformFactoryIface *self)