Changeset 108

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

Added API documentation

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/libtinymail-camel/tny-account-priv.h

    r52 r108  
    22#define TNY_ACCOUNT_PRIV_H 
    33 
    4 /* libtinymail - The Tiny Mail base library 
     4/* libtinymail-camel - The Tiny Mail base library for Camel 
    55 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    66 * 

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

    r75 r108  
    1 /* libtinymail - The Tiny Mail base library 
     1/* libtinymail-camel - The Tiny Mail base library for Camel 
    22 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    33 * 
    …… 
    293293 
    294294 
     295/** 
     296 * tny_account_new: 
     297 *  
     298 * 
     299 * Return value: A new #TnyAccountIface instance implemented for Camel 
     300 **/ 
    295301TnyAccount* 
    296302tny_account_new (void) 

  • trunk/libtinymail-camel/tny-account.h

    r21 r108  
    22#define TNY_ACCOUNT_H 
    33 
    4 /* libtinymail - The Tiny Mail base library 
     4/* libtinymail-camel - The Tiny Mail base library for Camel 
    55 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    66 * 

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

    r65 r108  
    1 /* libtinymail - The Tiny Mail base library 
     1/* libtinymail-camel - The Tiny Mail base library for Camel 
    22 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    33 * 
    …… 
    2222static CamelStreamClass *parent_class = NULL; 
    2323 
     24/** 
     25 * tny_camel_stream_write_to_stream: 
     26 * @self: a #TnyCamelStream object 
     27 * @output: a #TnyStreamIface object to write to 
     28 *  
     29 * Write self to output (copy it) in an efficient way 
     30 * 
     31 * Return value: the number of bytes written to the output stream, or -1 on  
     32 * error along with setting errno. 
     33 **/ 
    2434ssize_t  
    2535tny_camel_stream_write_to_stream (TnyCamelStream *self, TnyStreamIface *output) 
    …… 
    159169} 
    160170 
     171/** 
     172 * tny_camel_stream_set_stream: 
     173 * @self: A #TnyCamelStream object 
     174 * @stream: A #TnyStreamIface object 
     175 * 
     176 * Set the stream to play proxy for 
     177 * 
     178 * Return value: 
     179 **/ 
    161180void 
    162181tny_camel_stream_set_stream (TnyCamelStream *self, TnyStreamIface *stream) 
    …… 
    174193 
    175194 
    176  
     195/** 
     196 * tny_camel_stream_new: 
     197 * @stream: A #TnyStreamIface stream to play proxy for 
     198 * 
     199 * Return value: A new #CamelStream instance implemented as a proxy 
     200 * for a #TnyStreamIface 
     201 **/ 
    177202TnyCamelStream * 
    178203tny_camel_stream_new (TnyStreamIface *stream) 

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

    r65 r108  
    22#define TNY_CAMEL_STREAM_H 
    33 
    4 /* libtinymail - The Tiny Mail base library 
     4/* libtinymail-camel - The Tiny Mail base library for Camel 
    55 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    66 * 

  • trunk/libtinymail-camel/tny-msg-folder-priv.h

    r84 r108  
    22#define TNY_MSG_FOLDER_PRIV_H 
    33 
    4 /* libtinymail - The Tiny Mail base library 
     4/* libtinymail-camel - The Tiny Mail base library for Camel 
    55 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    66 * 

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

    r89 r108  
    1 /* libtinymail - The Tiny Mail base library 
     1/* libtinymail-camel - The Tiny Mail base library for Camel 
    22 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    33 * 
    …… 
    334334} 
    335335 
     336/** 
     337 * tny_msg_folder_set_folder: 
     338 * @self: A #TnyMsgFolder object 
     339 * @camel_folder: The #CamelFolder instance to play proxy for 
     340 * 
     341 * Return value: 
     342 **/ 
    336343void 
    337344tny_msg_folder_set_folder (TnyMsgFolder *self, CamelFolder *camel_folder) 
    …… 
    349356} 
    350357 
     358/** 
     359 * tny_msg_folder_get_folder: 
     360 * @self: A #TnyMsgFolder object 
     361 * 
     362 * Return value: The CamelFolder instance to play proxy for 
     363 **/ 
    351364CamelFolder* 
    352365tny_msg_folder_get_folder (TnyMsgFolder *self) 
    …… 
    357370} 
    358371 
    359  
     372/** 
     373 * tny_msg_folder_new_with_folder: 
     374 * @camel_folder: CamelFolder instance to play proxy for  
     375 * 
     376 * The #TnyMsgFolder implementation is actually a proxy for #CamelFolder 
     377 * 
     378 * Return value: A new #TnyMsgFolderIface instance implemented for Camel 
     379 **/ 
    360380TnyMsgFolder* 
    361 tny_msg_folder_new_with_folder (CamelFolder *camel_folder) 
     381tny_msg_folder_new_with_folder (CamelFolder *camel_folder) 
    362382{ 
    363383        TnyMsgFolder *self = g_object_new (TNY_MSG_FOLDER_TYPE, NULL); 
    …… 
    370390 
    371391 
    372  
     392/** 
     393 * tny_msg_folder_new: 
     394 *  
     395 * The #TnyMsgFolder implementation is actually a proxy for #CamelFolder. 
     396 * You need to set the #CamelFolder after using this constructor using 
     397 * tny_msg_folder_set_folder 
     398 * 
     399 * Return value: A new #TnyMsgFolderIface instance implemented for Camel 
     400 **/ 
    373401TnyMsgFolder* 
    374402tny_msg_folder_new (void) 

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

    r1 r108  
    22#define TNY_MSG_FOLDER_H 
    33 
    4 /* libtinymail - The Tiny Mail base library 
     4/* libtinymail-camel - The Tiny Mail base library for Camel 
    55 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    66 * 

  • trunk/libtinymail-camel/tny-msg-header-priv.h

    r87 r108  
    22#define TNY_MSG_HEADER_PRIV_H 
    33 
    4 /* libtinymail - The Tiny Mail base library 
     4/* libtinymail-camel - The Tiny Mail base library for Camel 
    55 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    66 * 

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

    r93 r108  
    1 /* libtinymail - The Tiny Mail base library 
     1/* libtinymail-camel - The Tiny Mail base library for Camel 
    22 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    33 * 
    …… 
    1616 * Free Software Foundation, Inc., 59 Temple Place - Suite 330, 
    1717 * Boston, MA 02111-1307, USA. 
    18  */ 
    19  
    20  
    21 /* The story of TnyMsgHeader, By Philip Van Hoof * 
    22  * 
    23  * TnyMsgHeader is a proxy for real subject CamelMessageInfo. The type doesn't 
    24  * use a priv pointer, but in stead is an opaque structure. This is done for  
    25  * decreasing the amount of allocations (a priv pointer is an unnecessary  
    26  * allocation). Allocations are slow. 
    27  * 
    28  * The tree model is responsible for calling the uncache method whenever the 
    29  * corresponding row becomes invisble. 
    30  * 
    31  * All kinds of dirty non-gobject-standard tricks have been applied to make this 
    32  * type as fast as possible. Including modifying the TNY_MSG_ACCOUNT() macro and 
    33  * removing the gobject type-check. 
    34  * 
    35  * It's possible this type sooner or later gets reimplemented without using 
    36  * gobject at all. As at this moment, the full size of the GObject type is added 
    37  * for no real reason. 
    3818 */ 
    3919 
    …… 
    269249        return; 
    270250} 
     251 
     252/** 
     253 * tny_msg_header_new: 
     254 * 
     255 * The story of TnyMsgHeader, 
     256 * 
     257 * TnyMsgHeader is a proxy for real subject CamelMessageInfo. The type doesn't 
     258 * use a priv pointer, but in stead is an opaque structure. This is done for  
     259 * decreasing the amount of allocations (a priv pointer is an unnecessary  
     260 * allocation). Allocations are slow. 
     261 * 
     262 * A list model (like a tree model) is responsible for calling the uncache 
     263 * method whenever the corresponding row becomes invisble. 
     264 * 
     265 * All kinds of dirty non-gobject-standard tricks have been applied to make this 
     266 * type as fast as possible. Including modifying the TNY_MSG_ACCOUNT() macro and 
     267 * removing the gobject type-check. 
     268 * 
     269 * It's possible this type sooner or later gets reimplemented without using 
     270 * gobject at all. As at this moment, the full size of the GObject type is added 
     271 * for no real reason. 
     272 * 
     273 * Return value: A new #TnyMsgHeader instance implemented for Camel 
     274 **/ 
     275 
    271276 
    272277TnyMsgHeader* 

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

    r88 r108  
    22#define TNY_MSG_HEADER_H 
    33 
    4 /* libtinymail - The Tiny Mail base library 
     4/* libtinymail-camel - The Tiny Mail base library for Camel 
    55 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    66 * 

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

    r76 r108  
    1 /* libtinymail - The Tiny Mail base library 
     1/* libtinymail-camel - The Tiny Mail base library for Camel 
    22 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    33 * 
    …… 
    211211} 
    212212 
    213  
     213/** 
     214 * tny_msg_mime_part_new: 
     215 *  
     216 * The #TnyMsgMimePart implementation is actually a proxy for #CamelMimePart. 
     217 * 
     218 * Return value: A new #TnyMsgMimePartIface instance implemented for Camel 
     219 **/ 
    214220TnyMsgMimePart* 
    215221tny_msg_mime_part_new (CamelMimePart *part) 

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

    r60 r108  
    22#define TNY_MSG_MIME_PART_H 
    33 
    4 /* libtinymail - The Tiny Mail base library 
     4/* libtinymail-camel - The Tiny Mail base library for Camel 
    55 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    66 * 

  • trunk/libtinymail-camel/tny-msg-priv.h

    r60 r108  
    22#define TNY_MSG_PRIV_H 
    33 
    4 /* libtinymail - The Tiny Mail base library 
     4/* libtinymail-camel - The Tiny Mail base library for Camel 
    55 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    66 * 

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

    r107 r108  
    1 /* libtinymail - The Tiny Mail base library 
     1/* libtinymail-camel - The Tiny Mail base library for Camel 
    22 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    33 * 
    …… 
    199199} 
    200200 
    201  
     201/** 
     202 * tny_msg_new: 
     203 *  
     204 * The #TnyMsg implementation is actually a proxy for #CamelMimeMessage (and 
     205 * a few other Camel types) 
     206 * 
     207 * Return value: A new #TnyMsgIface instance implemented for Camel 
     208 **/ 
    202209TnyMsg* 
    203210tny_msg_new (void) 

  • trunk/libtinymail-camel/tny-msg.h

    r60 r108  
    22#define TNY_MSG_H 
    33 
    4 /* libtinymail - The Tiny Mail base library 
     4/* libtinymail-camel - The Tiny Mail base library for Camel 
    55 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    66 * 

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

    r60 r108  
    1 /* libtinymail - The Tiny Mail base library 
     1/* libtinymail-camel - The Tiny Mail base library for Camel 
    22 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    33 * 
    …… 
    5858} PrivForgetPassFunc; 
    5959 
    60  
     60/** 
     61 * tny_session_camel_set_forget_pass_func: 
     62 * @self: a #TnySessionCamel object 
     63 * @account: the #TnyAccountIface account instance 
     64 * @forget_pass_func: The function that will forget the password for the account 
     65 * 
     66 * For each account you can set a password handler. This makes it possible to 
     67 * use your own password-store implementation for storing passwords. You set 
     68 * the handler that tells that store to forget the password, using this method. 
     69 * 
     70 * It's recommended to also memset (buffer, 0, len) the memory where the 
     71 * password was stored. You can do it in the forget_pass_func handler. 
     72 * 
     73 * Return value:  
     74 **/ 
    6175void 
    6276tny_session_camel_set_forget_pass_func (TnySessionCamel *self, TnyAccountIface *account, ForgetPassFunc get_forget_pass_func) 
    …… 
    109123} 
    110124 
     125/** 
     126 * tny_session_camel_set_pass_func: 
     127 * @self: a #TnySessionCamel object 
     128 * @account: the #TnyAccountIface account instance 
     129 * @get_pass_func: The function that will return the password for the account 
     130 * 
     131 * For each account you can set a password handler. This makes it possible to 
     132 * use your own password-store implementation for storing passwords. You set 
     133 * that password handler method using this method. 
     134 * 
     135 * Return value:  
     136 **/ 
    111137void 
    112138tny_session_camel_set_pass_func (TnySessionCamel *self, TnyAccountIface *account, GetPassFunc get_pass_func) 
    …… 
    378404static TnySessionCamel* the_singleton; 
    379405 
     406/** 
     407 * tny_session_camel_get_instance: 
     408 * 
     409 * 
     410 * Return value: The #TnySessionCamel singleton instance 
     411 **/ 
    380412TnySessionCamel* 
    381413tny_session_camel_get_instance (void) 

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

    r52 r108  
    22#define TNY_SESSION_CAMEL_H 
    33 
    4 /* libtinymail - The Tiny Mail base library 
     4/* libtinymail-camel - The Tiny Mail base library for Camel 
    55 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    66 * 

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

    r52 r108  
    1 /* libtinymail - The Tiny Mail base library 
     1/* libtinymail-camel - The Tiny Mail base library for Camel 
    22 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    33 * 
    …… 
    131131} 
    132132 
     133/** 
     134 * tny_stream_camel_set_stream: 
     135 * @self: A #TnyStreamCamel object 
     136 * @stream: A #CamelStream object 
     137 * 
     138 * Set the stream to play proxy for 
     139 * 
     140 * Return value: 
     141 **/ 
    133142void 
    134143tny_stream_camel_set_stream (TnyStreamCamel *self, CamelStream *stream) 
    …… 
    144153} 
    145154 
    146  
     155/** 
     156 * tny_stream_camel_new: 
     157 * @stream: A #CamelStream stream to play proxy for 
     158 * 
     159 * Return value: A new #TnyStreamCamel instance implemented as a proxy 
     160 * for a #CamelStream 
     161 **/ 
    147162TnyStreamCamel* 
    148163tny_stream_camel_new (CamelStream *stream) 

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

    r52 r108  
    22#define TNY_STREAM_CAMEL_H 
    33 
    4 /* libtinymail - The Tiny Mail base library 
     4/* libtinymail-camel - The Tiny Mail base library for Camel 
    55 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    66 * 

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

    r100 r108  
    1 /* libtinymail - The Tiny Mail base library 
     1/* libtinymail-gnomevfs - The Tiny Mail base library for GnomeVFS 
    22 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    33 * 
    …… 
    320320*/ 
    321321 
     322/** 
     323 * tny_vfs_stream_set_handle: 
     324 * @self: A #TnyVfsStream instance 
     325 * @handle: The #GnomeVFSHandle to write to or read from 
     326 * 
     327 * Set the #GnomeVFSHandle to play adaptor for 
     328 * 
     329 * Return value:  
     330 **/ 
    322331void 
    323332tny_vfs_stream_set_handle (TnyVfsStream *self, GnomeVFSHandle *handle) 
    …… 
    333342} 
    334343 
    335  
     344/** 
     345 * tny_vfs_stream_new: 
     346 * @handle: The #GnomeVFSHandle to write to or read from 
     347 * 
     348 * Create an adaptor instance between #TnyStreamIface and #GnomeVFSHandle 
     349 * 
     350 * Return value: a new #TnyStreamIface instance 
     351 **/ 
    336352TnyVfsStream* 
    337353tny_vfs_stream_new (GnomeVFSHandle *handle) 

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

    r97 r108  
    22#define TNY_VFS_STREAM_H 
    33 
    4 /* libtinymail - The Tiny Mail base library 
     4/* libtinymail-gnomevfs - The Tiny Mail base library for GnomeVFS 
    55 * Copyright (C) 2006-2007 Philip Van Hoof <pvanhoof@gnome.org> 
    66 * 

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

    r46 r108  
    2222/** 
    2323 * tny_account_iface_get_id: 
    24  * @self: a TnyAccountIface object 
     24 * @self: a #TnyAccountIface object 
    2525 *  
    2626 * Get an unique id for the account. 
    …… 
    3636/** 
    3737 * tny_account_iface_set_id: 
    38  * @self: a TnyAccountIface object 
     38 * @self: a #TnyAccountIface object 
    3939 *  
    4040 * Set the accounts unique id. 
    …… 
    5151/** 
    5252 * tny_account_iface_set_forget_pass_func: 
    53  * @self: a TnyAccountIface object 
     53 * @self: a #TnyAccountIface object 
    5454 *  
    5555 * Set the password that will be called when the password is no longer needed. 
    …… 
    7070/** 
    7171 * tny_account_iface_get_forget_pass_func: 
    72  * @self: a TnyAccountIface object 
     72 * @self: a #TnyAccountIface object 
    7373 *  
    7474 * 
    …… 
    8484/** 
    8585 * tny_account_iface_get_folders: 
    86  * @self: a TnyAccountIface object 
     86 * @self: a #TnyAccountIface object 
    8787 *  
    8888 * Get the folders of an account 
    …… 
    9898/** 
    9999 * tny_account_iface_set_proto: 
    100  * @self: a TnyAccountIface object 
     100 * @self: a #TnyAccountIface object 
    101101 * @proto: the protocol (ex. "imap") 
    102102 *  
    …… 
    114114/** 
    115115 * tny_account_iface_set_user: 
    116  * @self: a TnyAccountIface object 
     116 * @self: a #TnyAccountIface object 
    117117 * @user: the username 
    118118 *  
    …… 
    130130/** 
    131131 * tny_account_iface_set_hostname: 
    132  * @self: a TnyAccountIface object 
     132 * @self: a #TnyAccountIface object 
    133133 * @host: the hostname 
    134134 *  
    …… 
    146146/** 
    147147 * tny_account_iface_set_pass_func: 
    148  * @self: a TnyAccountIface object 
     148 * @self: a #TnyAccountIface object 
    149149 * @get_pass_func: a pointer to the function 
    150150 *  
    …… 
    163163/** 
    164164 * tny_account_iface_get_proto: 
    165  * @self: a TnyAccountIface object 
     165 * @self: a #TnyAccountIface object 
    166166 *  
    167167 * Get the protocol of an account 
    …… 
    177177/** 
    178178 * tny_account_iface_get_user: 
    179  * @self: a TnyAccountIface object 
     179 * @self: a #TnyAccountIface object 
    180180 *  
    181181 * Get the user or login of an account 
    …… 
    191191/** 
    192192 * tny_account_iface_get_hostname: 
    193  * @self: a TnyAccountIface object 
     193 * @self: a #TnyAccountIface object 
    194194 *  
    195195 * Get the hostname of an account 
    …… 
    205205/** 
    206206 * tny_account_iface_get_pass_func: 
    207  * @self: a TnyAccountIface object 
     207 * @self: a #TnyAccountIface object 
    208208 *  
    209209 * 

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

    r46 r108  
    1818 */ 
    1919 
     20#include <tny-account-iface.h> 
     21 
    2022#ifndef TNY_ACCOUNT_STORE_IFACE_C 
    2123#define TNY_ACCOUNT_STORE_IFACE_C 
    …… 
    3234/** 
    3335 * tny_account_store_iface_get_accounts: 
    34  * @self: a TnyAccountStoreIface object 
     36 * @self: a #TnyAccountStoreIface object 
    3537 *  
    3638 * Get a read-only list of accounts in the store 
    …… 
    4648/** 
    4749 * tny_account_store_iface_add_account: 
    48  * @self: a TnyAccountStoreIface object 
     50 * @self: a #TnyAccountStoreIface object 
    4951 * @account: the account to add 
    5052 *  
    …… 
    7173                tny_account_store_iface_signals = g_new0 (guint, TNY_ACCOUNT_STORE_IFACE_LAST_SIGNAL); 
    7274 
     75/** 
     76 * TnyAccountStoreIface::account_changed: 
     77 * @self: the object on which the signal is emitted 
     78 * @account: the #TnyAccountIface of the account that changed 
     79 * 
     80 * The "account_changed" signal is emitted when an account in the store changed 
     81 **/ 
    7382                tny_account_store_iface_signals[ACCOUNT_CHANGED] = 
    7483                   g_signal_new ("account_changed", 
    …… 
    7887                        NULL, NULL, 
    7988                        g_cclosure_marshal_VOID__POINTER, 
    80                         G_TYPE_NONE, 1, TNY_ACCOUNT_STORE_IFACE_TYPE); 
     89                        G_TYPE_NONE, 1, TNY_ACCOUNT_IFACE_TYPE); 
     90 
     91/** 
     92 * TnyAccountStoreIface::account_inserted: 
     93 * @self: the object on which the signal is emitted 
     94 * @account: the #TnyAccountIface of the account that got inserted 
     95 * 
     96 * The "account_inserted" signal is emitted when an account is added to the 
     97 * store 
     98 **/ 
     99 
    81100 
    82101                tny_account_store_iface_signals[ACCOUNT_INSERTED] = 
    …… 
    87106                        NULL, NULL, 
    88107                        g_cclosure_marshal_VOID__POINTER, 
    89                         G_TYPE_NONE, 1, TNY_ACCOUNT_STORE_IFACE_TYPE); 
     108                        G_TYPE_NONE, 1, TNY_ACCOUNT_IFACE_TYPE); 
    90109 
     110/** 
     111 * TnyAccountStoreIface::account_removed: 
     112 * @self: the object on which the signal is emitted 
     113 * @account: the #TnyAccountIface of the account that got removed 
     114 * 
     115 * The "account_removed" signal is emitted when an account is removed from the 
     116 * store 
     117 **/ 
    91118                tny_account_store_iface_signals[ACCOUNT_REMOVED] = 
    92119                   g_signal_new ("account_removed", 
    …… 
    96123                        NULL, NULL, 
    97124                        g_cclosure_marshal_VOID__POINTER, 
    98                         G_TYPE_NONE, 1, TNY_ACCOUNT_STORE_IFACE_TYPE); 
     125                        G_TYPE_NONE, 1, TNY_ACCOUNT_IFACE_TYPE); 
    99126 
     127/** 
     128 * TnyAccountStoreIface::accounts_reloaded: 
     129 * @self: the object on which the signal is emitted 
     130 * 
     131 * The "accounts_reloaded" signal is emitted when the store reloaded the  
     132 * accounts 
     133 **/ 
    100134                tny_account_store_iface_signals[ACCOUNTS_RELOADED] = 
    101135                   g_signal_new ("accounts_reloaded", 

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

    r84 r108  
    237237                tny_msg_folder_iface_signals = g_new0 (guint, TNY_MSG_FOLDER_IFACE_LAST_SIGNAL); 
    238238 
     239/** 
     240 * TnyMsgFolderIface::folder_inserted: 
     241 * @self: the object on which the signal is emitted 
     242 * @folder: the #TnyMsgFolderIface as the added folder 
     243 * 
     244 * The "folder_inserted" signal is emitted when a folder got added to  
     245 * the folder 
     246 **/ 
    239247                tny_msg_folder_iface_signals[FOLDER_INSERTED] = 
    240248                   g_signal_new ("folder_inserted", 
    …… 
    246254                        G_TYPE_NONE, 1, TNY_MSG_FOLDER_IFACE_TYPE); 
    247255 
     256/** 
     257 * TnyMsgFolderIface::folders_reloaded: 
     258 * @self: the object on which the signal is emitted 
     259 * 
     260 * The "folders_reloaded" signal is emitted when the folder got 
     261 * reloaded. 
     262 **/ 
    248263                tny_msg_folder_iface_signals[FOLDERS_RELOADED] = 
    249264                   g_signal_new ("folders_reloaded", 

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

    r76 r108  
    2424/** 
    2525 * tny_msg_header_iface_get_cc: 
    26  * @self: a TnyMsgHeaderIface object 
     26 * @self: a #TnyMsgHeaderIface object 
    2727 *  
    2828 *  
    …… 
    3939/** 
    4040 * tny_msg_header_iface_get_date_received: 
    41  * @self: a TnyMsgHeaderIface object 
     41 * @self: a #TnyMsgHeaderIface object 
    4242 *  
    4343 *  
    …… 
    5353/** 
    5454 * tny_msg_header_iface_get_date_sent: 
    55  * @self: a TnyMsgHeaderIface object 
     55 * @self: a #TnyMsgHeaderIface object 
    5656 *  
    5757 *  
    …… 
    6868/** 
    6969 * tny_msg_header_iface_get_id: 
    70  * @self: a TnyMsgHeaderIface object 
     70 * @self: a #TnyMsgHeaderIface object 
    7171 *  
    7272 * Get an unique id of the message of which self is a message header. 
    …… 
    8282/** 
    8383 * tny_msg_header_iface_get_message_id: 
    84  * @self: a TnyMsgHeaderIface object 
     84 * @self: a #TnyMsgHeaderIface object 
    8585 *  
    8686 * Get an unique id of the message of which self is a message header. 
    …… 
    9696/** 
    9797 * tny_msg_header_iface_get_from: 
    98  * @self: a TnyMsgHeaderIface object 
     98 * @self: a #TnyMsgHeaderIface object 
    9999 *  
    100100 * Get the from header 
    …… 
    110110/** 
    111111 * tny_msg_header_iface_get_subject: 
    112  * @self: a TnyMsgHeaderIface object 
     112 * @self: a #TnyMsgHeaderIface object 
    113113 *  
    114114 * Get the subject header 
    …… 
    125125/** 
    126126 * tny_msg_header_iface_get_to: 
    127  * @self: a TnyMsgHeaderIface object 
     127 * @self: a #TnyMsgHeaderIface object 
    128128 *  
    129129 * Get the to header 
    …… 
    139139/** 
    140140 * tny_msg_header_iface_get_folder: 
    141  * @self: a TnyMsgHeaderIface object 
     141 * @self: a #TnyMsgHeaderIface object 
    142142 *  
    143143 * Get a reference to the parent folder where this message header is located 
    …… 
    154154/** 
    155155 * tny_msg_header_iface_set_folder: 
    156  * @self: a TnyMsgHeaderIface object 
     156 * @self: a #TnyMsgHeaderIface object 
    157157 *  
    158158 * Set the reference to the parent folder where this message header is located 
    …… 
    169169/** 
    170170 * tny_msg_header_iface_set_message_id: 
    171  * @self: a TnyMsgHeaderIface object 
     171 * @self: a #TnyMsgHeaderIface object 
    172172 * @id: an unique follow-up uid 
    173173 *  
    …… 
    185185/** 
    186186 * tny_msg_header_iface_uncache: 
    187  * @self: a TnyMsgHeaderIface object 
     187 * @self: a #TnyMsgHeaderIface object 
    188188 *  
    189189 * If it's possible to uncache this instance, uncache it 
    …… 
    201201/** 
    202202 * tny_msg_header_iface_has_cache: 
    203  * @self: a TnyMsgHeaderIface object 
     203 * @self: a #TnyMsgHeaderIface object 
    204204 *  
    205205 * If it's possible to uncache this instance, return whether or not it has a cache 

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

    r60 r108  
    2323/** 
    2424 * tny_msg_iface_get_folder: 
    25  * @self: a TnyMsgIface object 
     25 * @self: a #TnyMsgIface object 
    2626 *  
    2727 * Get the parent folder of this message 
    …… 
    3737/** 
    3838 * tny_msg_iface_set_folder: 
    39  * @self: a TnyMsgIface object 
     39 * @self: a #TnyMsgIface object 
    4040 * @folder: The parent folder 
    4141 *  
    4242 * Set the parent folder of this message 
    43  * * TODO: Make this private * 
     43 * 
     44 * * TODO: Make this private, or make it possible to move messages this way * 
    4445 * 
    4546 * Return value: Set parent folder of this message 
    …… 
    5556/** 
    5657 * tny_msg_iface_get_parts: 
    57  * @self: a TnyMsgIface object 
     58 * @self: a #TnyMsgIface object 
    5859 *  
    5960 * Get a read-only list of mime-parts of this message 
    6061 * 
    61  * Return value: A read-only GList with TnyMsgMimePartIface instances 
     62 * Return value: A read-only GList with #TnyMsgMimePartIface instances 
    6263 **/ 
    6364const GList* 
    …… 
    7172/** 
    7273 * tny_msg_iface_get_header: 
    73  * @self: a TnyMsgIface object 
     74 * @self: a #TnyMsgIface object 
    7475 *  
    7576 * Get the header of the message 
    …… 
    8687/** 
    8788 * tny_msg_iface_add_part: 
    88  * @self: a TnyMsgIface object 
     89 * @self: a #TnyMsgIface object 
    8990 * @part: the mime-part to add 
    9091 *  
    …… 
    101102/** 
    102103 * tny_msg_iface_del_part: 
    103  * @self: a TnyMsgIface object 
     104 * @self: a #TnyMsgIface object 
    104105 * @id: the mime-part id to delete 
    105106 *  
    …… 
    118119/** 
    119120 * tny_msg_iface_set_header: 
    120  * @self: a TnyMsgIface object 
     121 * @self: a #TnyMsgIface object 
    121122 * @header: the header to set 
    122123 *  

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

    r76 r108  
    2121 
    2222 
     23/** 
     24