Changeset 109

Show
Ignore:
Timestamp:
02/22/06 01:59:41
Author:
pvanhoof
Message:

Added gtk-doc API

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/configure.ac

    r101 r109  
    2323AC_HEADER_STDC 
    2424AC_PROG_LIBTOOL 
     25 
     26GTK_DOC_CHECK([1.0]) 
    2527 
    2628PKG_CHECK_MODULES(LIBTINYMAIL, glib-2.0 >= 2.8 gobject-2.0) 
    …… 
    5658AC_OUTPUT([ 
    5759Makefile 
     60doc/Makefile 
     61doc/devel/Makefile 
     62doc/devel/reference/Makefile 
    5863libtinymail/Makefile 
    5964libtinymail/libtinymail.pc 

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

    r108 r109  
    176176 * Set the stream to play proxy for 
    177177 * 
    178  * Return value: 
    179178 **/ 
    180179void 

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

    r108 r109  
    339339 * @camel_folder: The #CamelFolder instance to play proxy for 
    340340 * 
    341  * Return value: 
    342341 **/ 
    343342void 

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

    r108 r109  
    6262 * @self: a #TnySessionCamel object 
    6363 * @account: the #TnyAccountIface account instance 
    64  * @forget_pass_func: The function that will forget the password for the account 
     64 * @get_forget_pass_func: The function that will forget the password for the account 
    6565 * 
    6666 * For each account you can set a password handler. This makes it possible to 
    …… 
    7171 * password was stored. You can do it in the forget_pass_func handler. 
    7272 * 
    73  * Return value:  
    7473 **/ 
    7574void 
    …… 
    133132 * that password handler method using this method. 
    134133 * 
    135  * Return value:  
    136134 **/ 
    137135void 

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

    r108 r109  
    138138 * Set the stream to play proxy for 
    139139 * 
    140  * Return value: 
    141140 **/ 
    142141void 

  • trunk/libtinymail-gnomevfs/tny-vfs-stream.c

    r108 r109  
    327327 * Set the #GnomeVFSHandle to play adaptor for 
    328328 * 
    329  * Return value:  
    330329 **/ 
    331330void 

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

    r108 r109  
    4040 * Set the accounts unique id. 
    4141 *  
    42  * Return value:  
    4342 **/ 
    4443void  
    …… 
    5958 * It's recommended to also memset (str, 0, strlen (str)) the memory. 
    6059 *  
    61  * Return value: 
    6260 **/ 
    6361void 
    …… 
    103101 * Set the protocol of an account 
    104102 *  
    105  * Return value:  
    106103 **/ 
    107104void 
    …… 
    119116 * Set the user or login of an account 
    120117 *  
    121  * Return value:  
    122118 **/ 
    123119void 
    …… 
    135131 * Set the hostname of an account 
    136132 *  
    137  * Return value:  
    138133 **/ 
    139134void 
    …… 
    152147 * The function must resturn a newly allocated string with the password. 
    153148 *  
    154  * Return value:  
    155149 **/ 
    156150void 

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

    r108 r109  
    5353 * Add an account to the store 
    5454 *  
    55  * Return value:  
    5655 **/ 
    5756void 

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

    r108 r109  
    6464 * Set the parent of this folder 
    6565 *  
    66  * Return value:  
    6766 **/ 
    6867void 
    …… 
    9594 * Add a folder as child folder to the folder 
    9695 *  
    97  * Return value:  
    9896 **/ 
    9997void 
    …… 
    170168 * Set the unique id for this folder (unique per account) 
    171169 *  
    172  * Return value:  
    173170 **/ 
    174171void 
    …… 
    186183 * Set the displayable name of this folder 
    187184 *  
    188  * Return value:  
    189185 **/ 
    190186void 
    …… 
    201197 * If it's possible to uncache this instance, uncache it 
    202198 *  
    203  * Return value:  
    204199 **/ 
    205200void 

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

    r108 r109  
    158158 * Set the reference to the parent folder where this message header is located 
    159159 *  
    160  * Return value:  
    161160 **/ 
    162161void 
    …… 
    173172 *  
    174173 * 
    175  * Return value:  
    176174 **/ 
    177175void 
    …… 
    189187 * If it's possible to uncache this instance, uncache it 
    190188 *  
    191  * Return value:  
    192189 **/ 
    193190void 

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

    r108 r109  
    4444 * * TODO: Make this private, or make it possible to move messages this way * 
    4545 * 
    46  * Return value: Set parent folder of this message 
    4746 **/ 
    4847void 
    …… 
    107106 * Delete a mime-part from a message 
    108107 * 
    109  * Return value:  
    110108 **/ 
    111109void 
    …… 
    124122 * Set the header of a message 
    125123 * 
    126  * Return value:  
    127124 **/ 
    128125void 

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

    r108 r109  
    2828 * Set the index of a message part 
    2929 * 
    30  * Return value:  
    3130 **/ 
    3231void 
    …… 
    112111 * stream efficiently. 
    113112 * 
    114  * Return value:  
    115113 **/ 
    116114void 

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

    r108 r109  
    6666 * Add an account to the list model 
    6767 * 
    68  * Return value:  
    6968 **/ 
    7069void 

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

    r108 r109  
    5252 * Add a mime-part to the list model 
    5353 * 
    54  * Return value:  
    5554 **/ 
    5655void 

  • trunk/libtinymailui-gtk/tny-msg-header-list-model.c

    r108 r109  
    336336 * Set the folder where the #TnyMsgHeaderIface instances are located 
    337337 *  
    338  * Return value: 
    339338 **/ 
    340339void 

  • trunk/libtinymailui-gtk/tny-text-buffer-stream.c

    r108 r109  
    150150 * Set the #GtkTextBuffer to play adaptor for 
    151151 * 
    152  * Return value:  
    153152 **/ 
    154153void 

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

    r108 r109  
    2727 * Set message to view 
    2828 *  
    29  * Return value:  
    3029 **/ 
    3130void 

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

    r108 r109  
    2727 * Set message to view in the window 
    2828 *  
    29  * Return value:  
    3029 **/ 
    3130void 

  • trunk/libtinymailui/tny-summary-window-iface.c

    r108 r109  
    2323 * tny_summary_window_iface_set_account_store: 
    2424 * @self: A #TnySummaryWindowIface instance 
    25  * @account: A #TnyAccountStoreIface instace 
     25 * @account_store: A #TnyAccountStoreIface instace 
    2626 * 
    2727 * Set the account store (summary window is an observer of it) 
    2828 *  
    29  * Return value:  
    3029 **/ 
    3130void 

  • trunk/tinymail/tny-password-dialog.c

    r108 r109  
    3939 * @self: A #TnyPasswordDialog object 
    4040 * @prompt: The prompt to set 
    41  * 
    42  * Return value:  
     41 *  
    4342 **/ 
    4443void