Changeset 2003

Show
Ignore:
Timestamp:
05/17/07 18:39:44
Author:
pvanhoof
Message:

Doc updates

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/docs/devel/reference/Makefile.am

    r2002 r2003  
    9494        -I$(top_srcdir)/libtinymail-gnomevfs                            \ 
    9595        -I$(top_srcdir)/tinymail                                        \ 
    96         -I$(top_srcdir)/tests/shared 
     96        -I$(top_srcdir)/tests/shared                                    \ 
     97        -I$(top_srcdir)/libtinymail-queues                              \ 
     98        -I$(top_srcdir)/libtinymail-asyncworker                         \ 
     99        $(LIBTINYMAIL_ASYNCWORKER_CFLAGS) 
    97100 
    98101GTKDOC_LIBS= $(LIBTINYMAIL_LIBS) $(LIBTINYMAILUI_LIBS)                                          \ 
    …… 
    100103        $(LIBTINYMAILUI_GTK_LIBS) $(LIBTINYMAILUI_MOZEMBED_LIBS)                                \ 
    101104        $(LIBTINYMAIL_GNOME_DESKTOP_LIBS) $(LIBTINYMAIL_TEST_LIBS)                              \ 
    102         $(TINYMAIL_LIBS)                                                                      \ 
     105        $(TINYMAIL_LIBS) $(LIBTINYMAIL_ASYNCWORKER_LIBS)                                      \ 
    103106        $(top_builddir)/libtinymail/libtinymail-$(API_VERSION).la                               \ 
    104107        $(top_builddir)/libtinymail-camel/libtinymail-camel-$(API_VERSION).la                   \ 
    …… 
    108111        $(top_builddir)/libtinymail-gnome-desktop/libtinymail-gnome-desktop-$(API_VERSION).la   \ 
    109112        $(top_builddir)/libtinymail-gnomevfs/libtinymail-gnomevfs-$(API_VERSION).la             \ 
     113        $(top_builddir)/libtinymail-queues/libtinymail-queues-$(API_VERSION).la                 \ 
     114        $(top_builddir)/libtinymail-asyncworker/libtinymail-asyncworker-$(API_VERSION).la       \ 
    110115        $(top_builddir)/tests/shared/libtestsshared.a 
    111116 

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

    r1872 r2003  
    9494<!ENTITY libtinymail-gnome-desktop-TnyGnomeDevice SYSTEM "xml/tny-gnome-device.xml"> 
    9595 
     96<!ENTITY libtinymail-asyncworker-TnyAsyncWorkerQueueTask SYSTEM "xml/tny-async-worker-queue-task.xml"> 
     97<!ENTITY libtinymail-asyncworker-TnyAsyncWorkerQueue SYSTEM "xml/tny-async-worker-queue.xml"> 
     98 
     99<!ENTITY libtinymail-queues-TnyQueue SYSTEM "xml/tny-queue.xml"> 
     100<!ENTITY libtinymail-queues-TnyQueueTask SYSTEM "xml/tny-queue-task.xml"> 
     101<!ENTITY libtinymail-queues-TnyGenericSendQueue SYSTEM "xml/tny-generic-send-queue.xml"> 
     102<!ENTITY libtinymail-queues-TnyGetMsgQueue SYSTEM "xml/tny-get-msg-queue.xml"> 
    96103 
    97104<!ENTITY index-Object-Tree SYSTEM "xml/tree_index.sgml"> 
    …… 
    212219        </chapter> 
    213220 
     221        <chapter id="libtinymail-queues"> 
     222                <title>A queue library</title> 
     223                &libtinymail-queues-TnyQueue; 
     224                &libtinymail-queues-TnyQueueTask; 
     225                &libtinymail-queues-TnyGenericSendQueue; 
     226                &libtinymail-queues-TnyGetMsgQueue; 
     227        </chapter> 
     228 
     229        <chapter id="libtinymail-asyncworker"> 
     230                <title>A library that implements TnyQueue</title> 
     231                &libtinymail-asyncworker-TnyAsyncWorkerQueueTask; 
     232                &libtinymail-asyncworker-TnyAsyncWorkerQueue; 
     233        </chapter> 
     234 
    214235        <chapter id="libtinymail-camel"> 
    215236                <title>libtinymail-camel - implementation of the main library</title> 

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

    r1931 r2003  
    4343</para> 
    4444 
    45 @:  
    46 @: 
    47  
    4845@tnyaccountstore: the object which received the signal. 
    4946@arg1:  
    …… 
    5350 
    5451</para> 
    55  
    56 @:  
    57 @: 
    5852 
    5953@tnyaccountstore: the object which received the signal. 
    …… 
    6559</para> 
    6660 
    67 @:  
    68 @: 
    69  
    7061@tnyaccountstore: the object which received the signal. 
    7162@arg1:  
    …… 
    7566 
    7667</para> 
    77  
    78 @: 
    7968 
    8069@tnyaccountstore: the object which received the signal. 

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

    r1638 r2003  
    9191 
    9292 
     93<!-- ##### USER_FUNCTION TnyCamelGetSupportedSecureAuthCallback ##### --> 
     94<para> 
     95 
     96</para> 
     97 
     98@self:  
     99@cancelled:  
     100@auth_types:  
     101@err:  
     102@user_data:  
     103 
     104 
     105<!-- ##### FUNCTION tny_camel_account_get_supported_secure_authentication ##### --> 
     106<para> 
     107 
     108</para> 
     109 
     110@self:  
     111@callback:  
     112@status_callback:  
     113@user_data:  
     114 
     115 

  • trunk/docs/devel/reference/tmpl/tny-common-priv.sgml

    r1931 r2003  
    1010</para> 
    1111 
    12  
    1312<!-- ##### SECTION See_Also ##### --> 
    1413<para> 
    1514 
    1615</para> 
    17  
    1816 
    1917<!-- ##### SECTION Stability_Level ##### --> 

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

    r1931 r2003  
    2929 
    3030</para> 
    31  
    32 @:  
    33 @: 
    3431 
    3532@tnydevice: the object which received the signal. 

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

    r1931 r2003  
    3434@TNY_FOLDER_STATUS: a status domain code for folder 
    3535@TNY_GET_MSG_QUEUE_STATUS:  
     36@TNY_GET_SUPPORTED_SECURE_AUTH_STATUS:  
    3637 
    3738<!-- ##### ENUM TnyFolderCaps ##### --> 

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

    r1931 r2003  
    4444@get_id_func:  
    4545@get_account_func:  
    46 @set_name_func:  
    4746@get_folder_type_func:  
    4847@get_all_count_func:  
    …… 
    5453@transfer_msgs_async_func:  
    5554@copy_func:  
     55@copy_async_func:  
    5656@poke_status_func:  
    5757@add_observer_func:  
    …… 
    215215 
    216216 
    217 <!-- ##### FUNCTION tny_folder_set_name ##### --> 
    218 <para> 
    219  
    220 </para> 
    221  
    222 @self:  
    223 @name:  
    224 @err:  
    225  
    226  
    227217<!-- ##### FUNCTION tny_folder_get_folder_type ##### --> 
    228218<para> 
    …… 
    320310 
    321311 
     312<!-- ##### FUNCTION tny_folder_copy_async ##### --> 
     313<para> 
     314 
     315</para> 
     316 
     317@self:  
     318@into:  
     319@new_name:  
     320@del:  
     321@callback:  
     322@status_callback:  
     323@user_data:  
     324 
     325 
    322326<!-- ##### FUNCTION tny_folder_poke_status ##### --> 
    323327<para> 

  • trunk/docs/devel/reference/tmpl/tny-gtk-header-list-iterator-priv.sgml

    r886 r2003  
    2727@current:  
    2828 
     29<!-- ##### MACRO TNY_GTK_HEADER_LIST_MODEL_GET_PRIVATE ##### --> 
     30<para> 
     31 
     32</para> 
     33 
     34@o:  
     35 
     36 
     37<!-- ##### STRUCT TnyGtkHeaderListModelPriv ##### --> 
     38<para> 
     39 
     40</para> 
     41 
     42@iterator_lock:  
     43@folder:  
     44@stamp:  
     45@registered:  
     46@updating_views:  
     47@ra_lock:  
     48@to_lock:  
     49@cur_len:  
     50@add_timeout:  
     51@timeout_span:  
     52@items:  
     53@del_timeouts:  
     54@iterator:  
     55 

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

    r1931 r2003  
    4040</para> 
    4141 
     42@:  
     43@:  
     44@:  
     45@: 
     46 
    4247@tnysendqueue: the object which received the signal. 
    4348@arg1:  
    …… 
    4954 
    5055</para> 
     56 
     57@:  
     58@:  
     59@:  
     60@: 
    5161 
    5262@tnysendqueue: the object which received the signal. 

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

    r1947 r2003  
    1616 
    1717<!-- ##### SECTION Stability_Level ##### --> 
     18 
     19 
     20<!-- ##### MACRO tny_debug ##### --> 
     21<para> 
     22 
     23</para> 
     24 
    1825 
    1926 
    …… 
    4047</para> 
    4148 
    42 @tnyaccountstore: the object which received the signal. 
    43 @arg1:  
     49@:  
     50@:  
    4451 
    4552<!-- ##### SIGNAL TnyAccountStore::account-inserted ##### --> 
    …… 
    4855</para> 
    4956 
    50 @tnyaccountstore: the object which received the signal. 
    51 @arg1:  
     57@:  
     58@:  
    5259 
    5360<!-- ##### SIGNAL TnyAccountStore::account-removed ##### --> 
    …… 
    5663</para> 
    5764 
    58 @tnyaccountstore: the object which received the signal. 
    59 @arg1:  
     65@:  
     66@:  
    6067 
    6168<!-- ##### SIGNAL TnyAccountStore::accounts-reloaded ##### --> 
    …… 
    6471</para> 
    6572 
    66 @tnyaccountstore: the object which received the signal. 
     73@:  
    6774 
    6875<!-- ##### STRUCT TnyAccountStoreIface ##### --> 
    …… 
    164171@get_id_func:  
    165172@get_account_func:  
    166 @set_name_func:  
    167173@get_folder_type_func:  
    168174@get_all_count_func:  
    …… 
    174180@transfer_msgs_async_func:  
    175181@copy_func:  
     182@copy_async_func:  
    176183@poke_status_func:  
    177184@add_observer_func:  
    …… 
    297304</para> 
    298305 
    299 @tnydevice: the object which received the signal. 
    300 @arg1:  
     306@:  
     307@:  
    301308 
    302309<!-- ##### STRUCT TnyDeviceIface ##### --> 
    …… 
    522529 
    523530 
     531<!-- ##### USER_FUNCTION TnyCopyFolderCallback ##### --> 
     532<para> 
     533 
     534</para> 
     535 
     536@self:  
     537@into:  
     538@cancelled:  
     539@new_folder:  
     540@err:  
     541@user_data:  
     542 
     543 
    524544<!-- ##### STRUCT TnyMsgRemoveStrategy ##### --> 
    525545<para> 
    …… 
    547567</para> 
    548568 
    549 @:  
    550 @:  
    551 @:  
    552 @:  
     569@tnysendqueue: the object which received the signal. 
     570@arg1:  
     571@arg2:  
     572@arg3:  
    553573 
    554574<!-- ##### SIGNAL TnySendQueue::msg-sent ##### --> 
    …… 
    557577</para> 
    558578 
    559 @:  
    560 @:  
    561 @:  
    562 @:  
     579@tnysendqueue: the object which received the signal. 
     580@arg1:  
     581@arg2:  
     582@arg3:  
    563583 
    564584<!-- ##### STRUCT TnySendQueueIface ##### -->