Changeset 1858

Show
Ignore:
Timestamp:
04/28/07 14:04:02
Author:
pvanhoof
Message:

Doc updates

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/libtinymail-camel/tny-camel-imap-store-account.c

    r1692 r1858  
    9393 * tny_camel_imap_store_account_new: 
    9494 *  
     95 * Create a imap store account 
    9596 * 
    9697 * Return value: A new IMAP #TnyStoreAccount instance implemented for Camel 

  • trunk/libtinymail-camel/tny-camel-msg-remove-strategy.c

    r1567 r1858  
    9191 * tny_camel_msg_remove_strategy_new: 
    9292 * 
     93 * Create a default remove strategy for TnyCamelFolder instances. 
    9394 * 
    9495 * Return value: a new #TnyMsgRemoveStrategy instance implemented for a #TnyCamelFolder 

  • trunk/libtinymail-camel/tny-session-camel.c

    r1730 r1858  
    527527 * @device: a #TnyDevice instance 
    528528 * 
     529 * Set the device of @self. 
    529530 * 
    530531 **/ 
    …… 
    554555 * @account_store: A #TnyAccountStore account store instance 
    555556 * 
    556  * 
     557 * Set the account store of @self. 
    557558 **/ 
    558559void  
    …… 
    596597 * tny_session_camel_new: 
    597598 * @account_store: A TnyAccountStore instance 
     599 * 
     600 * A #CamelSession for tinymail 
    598601 * 
    599602 * Return value: The #TnySessionCamel singleton instance 

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

    r1855 r1858  
    527527 * tny_gnome_account_store_new: 
    528528 * 
     529 * Create a #TnyAccountStore for GNOME desktops that uses GConf for storing  
     530 * the account information and detecting changes to that configuration. 
    529531 * 
    530532 * Return value: A new #TnyAccountStore instance 

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

    r1844 r1858  
    182182 
    183183 
    184  
    185184/** 
    186185 * tny_gnome_device_new: 
    187186 * 
     187 * Create a #TnyDevice for GNOME desktops. If available, it uses NetworkManager 
     188 * to know about the network status and changes of your computer. 
     189 *  
    188190 * Return value: A new #TnyDevice instance 
    189191 **/ 

  • trunk/libtinymail/tny-account.h

    r1718 r1858  
    5353        void (*set_id_func) (TnyAccount *self, const gchar *id); 
    5454        void (*set_name_func) (TnyAccount *self, const gchar *name); 
    55         void (*set_mech_func) (TnyAccount *self, const gchar *name); 
     55        void (*set_mech_func) (TnyAccount *self, const gchar *mech); 
    5656        void (*set_proto_func) (TnyAccount *self, const gchar *proto); 
    5757        void (*set_user_func) (TnyAccount *self, const gchar *user); 
    …… 
    8282void tny_account_set_id (TnyAccount *self, const gchar *id); 
    8383void tny_account_set_name (TnyAccount *self, const gchar *name); 
    84 void tny_account_set_mech (TnyAccount *self, const gchar *name); 
     84void tny_account_set_mech (TnyAccount *self, const gchar *mech); 
    8585void tny_account_set_proto (TnyAccount *self, const gchar *proto); 
    8686void tny_account_set_user (TnyAccount *self, const gchar *user); 

  • trunk/libtinymail/tny-header.c

    r1762 r1858  
    2929 
    3030/** 
    31  * tny_header_set_bcc: 
     31 * tny_header_set_replyto: 
    3232 * @self: a #TnyHeader object 
    3333 * @to: the reply-to header 

  • trunk/libtinymail/tny-list.c

    r1856 r1858  
    2525 * tny_list_get_length: 
    2626 * @self: A #TnyList instance 
     27 * 
     28 * Get the amount of items in @self. 
    2729 * 
    2830 * Return value: the length of the list 

  • trunk/libtinymail/tny-msg-remove-strategy.c

    r1732 r1858  
    2525 
    2626/** 
    27  * tny_msg_remove_strategy_peform_remove: 
     27 * tny_msg_remove_strategy_perform_remove: 
    2828 * @self: A #TnyMsgRemoveStrategy instance 
    2929 * @folder: The #TnyFolder instance from which the message will be removed 

  • trunk/libtinymail/tny-noop-lockable.c

    r1399 r1858  
    7070 * tny_noop_lockable_new: 
    7171 * 
     72 * Create a lockable that does nothing 
     73 * 
    7274 * Return value: a #TnyLockable instance that does nothing 
    7375 **/ 

  • trunk/libtinymail/tny-pair.c

    r1379 r1858  
    5656 * tny_pair_get_name: 
    5757 * @self: a #TnyPair instance 
     58 *  
     59 * Get the name of the pair, the returned value must not be freed 
    5860 * 
    59  * Return value: the name of the pair, the result must not be freed 
     61 * Return value: the name of the pair 
    6062 **/ 
    6163const gchar*  
    …… 
    8890 * @self: a #TnyPair instance 
    8991 * 
    90  * Return value: the value of the pair, the result must not be freed 
     92 * Get the value of the pair, the returned value must not be freed 
     93 * 
     94 * Return value: the value of the pair 
    9195 **/ 
    9296const gchar*  

  • trunk/libtinymail/tny-simple-list.c

    r1010 r1858  
    194194 * tny_simple_list_new: 
    195195 *  
     196 * Create a general purpose #TnyList instance 
     197 * 
    196198 * Return value: A general purpose #TnyList instance 
    197199 **/ 

  • trunk/libtinymail/tny-status.c

    r1833 r1858  
    5252} 
    5353 
     54/** 
     55 * tny_status_set_fraction: 
     56 * @fraction: the fraction to set 
     57 *  
     58 * Set the fraction of @status. The of_total member of @status will be set to 100 
     59 * by this method. 
     60 * 
     61 **/ 
    5462void  
    5563tny_status_set_fraction (TnyStatus *status, gdouble fraction) 
    …… 
    5967} 
    6068 
     69/** 
     70 * tny_status_get_fraction: 
     71 *  
     72 * Get the fraction of @status 
     73 * 
     74 * Return value: the fraction of @status 
     75 **/ 
    6176gdouble  
    6277tny_status_get_fraction (TnyStatus *status) 

  • trunk/libtinymailui-gtk/tny-gtk-account-list-model.c

    r1802 r1858  
    4646 * tny_gtk_account_list_model_new: 
    4747 * 
    48  * 
    49  * Return value: a new #GtkTreeModel instance suitable for showing   
    50  * #TnyMimePart instances 
     48 * Create a new #GtkTreeModel instance suitable for showing a #TnyMimePart. 
     49 * 
     50 * Return value: a new #GtkTreeModel instance suitable for showing a #TnyMimePart 
    5151 **/ 
    5252GtkTreeModel* 

  • trunk/libtinymailui-gtk/tny-gtk-attach-list-model.c

    r1192 r1858  
    111111 * tny_gtk_attach_list_model_new: 
    112112 * 
    113  * 
    114  * Return value: a new #GtkTreeModel instance suitable for showing   
    115  * #TnyMimePart instances 
     113 * Get a new #GtkTreeModel instance suitable for showing #TnyMimePart. 
     114 * 
     115 * Return value: a new #GtkTreeModel instance suitable for showing a #TnyMimePart 
    116116 **/ 
    117117GtkTreeModel* 

  • trunk/libtinymailui-gtk/tny-gtk-mime-part-save-strategy.c

    r1136 r1858  
    121121                (GTK_FILE_CHOOSER (dialog), g_get_home_dir ()); 
    122122 
     123/* TNY TODO: detect this at runtime */ 
    123124#ifndef GNOME 
    124125        gtk_file_chooser_set_local_only (GTK_FILE_CHOOSER (dialog), TRUE); 
    …… 
    131132        { 
    132133                gchar *uri; 
     134 
     135/* TNY TODO: detect this at runtime */ 
    133136#ifdef GNOME 
    134137                uri = gtk_file_chooser_get_uri (GTK_FILE_CHOOSER (dialog)); 
    …… 
    166169 * tny_gtk_mime_part_save_strategy_new: 
    167170 * 
     171 * Create a new #TnyMimePartSaveStrategy instance implemented for Gtk+. It will 
     172 * use the GtkFileChooserDialog type and if available support for GnomeVFS. 
    168173 * 
    169174 * Return value: a new #TnyMimePartSaveStrategy instance implemented for Gtk+ 

  • trunk/libtinymailui-gtk/tny-gtk-msg-view.c

    r1426 r1858  
    9393 * @self: A #TnyGtkMsgView instance 
    9494 * 
     95 * Get whether or not to display text/html mime parts 
     96 *  
    9597 * Return value: whether or not to display text/html mime parts 
    9698 **/ 
    …… 
    106108 * @self: A #TnyGtkMsgView instance 
    107109 * 
     110 * Get whether or not to display message/rfc822 mime parts 
     111 * 
    108112 * Return value: whether or not to display message/rfc822 mime parts 
    109113 **/ 
    …… 
    119123 * @self: A #TnyGtkMsgView instance 
    120124 * 
     125 * Get whether or not to display attachments 
     126 * 
    121127 * Return value: whether or not to display attachments 
    122128 **/ 
    …… 
    132138 * @self: A #TnyGtkMsgView instance 
    133139 * 
     140 * Get whether or not to display text/plain mime parts 
     141 *  
    134142 * Return value: whether or not to display text/plain mime parts 
    135143 **/ 

  • trunk/libtinymailui-gtk/tny-gtk-msg-window.c

    r1477 r1858  
    208208/** 
    209209 * tny_gtk_msg_window_new: 
    210  * 
     210 * @msgview: a #TnyMsgView to decorate 
     211 * 
     212 * Create a GtkWindow that implements #TnyMsgView by decorating @msgview. 
    211213 * 
    212214 * Return value: a new #TnyMsgWindow instance implemented for Gtk+ 

  • trunk/libtinymailui-gtk/tny-gtk-password-dialog.c

    r1784 r1858  
    104104 * tny_gtk_password_dialog_new: 
    105105 *  
     106 * Create a dialog window that will ask the user for a password 
    106107 * 
    107108 * Return value: A new #GtkDialog password dialog instance implemented for Gtk+ 

  • trunk/libtinymailui-gtk/tny-gtk-text-mime-part-view.c

    r1192 r1858  
    131131/** 
    132132 * tny_gtk_text_mime_part_view_new: 
     133 * 
     134 * Create a new #TnyMimePartView for Gtk+ 
    133135 * 
    134136 * Return value: a new #TnyMimePartView instance implemented for Gtk+ 

  • trunk/libtinymailui-mozembed/tny-moz-embed-html-mime-part-view.c

    r1219 r1858  
    110110/** 
    111111 * tny_moz_embed_html_mime_part_view_new: 
     112 * 
     113 * Create a #TnyMimePartView that can display HTML mime parts 
    112114 * 
    113115 * Return value: a new #TnyMimePartView instance implemented for Gtk+ 

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

    r1278 r1858  
    2929/** 
    3030 * tny_moz_embed_msg_view_new: 
     31 * 
     32 * Create a new #TnyMsgView that can display HTML messages. 
    3133 * 
    3234 * Return value: a new #TnyMsgView instance implemented for Gtk+