Changeset 1399

Show
Ignore:
Timestamp:
01/13/07 04:45:01
Author:
pvanhoof
Message:

Updated API documentation

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/ChangeLog

    r1398 r1399  
    66        * Async authentication in TnySessionCamel 
    77        * Async alerts in TnySessionCamel 
     8        * Updated API documentation 
    89 
    910        * This was a major API change 

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

    r1379 r1399  
    2424<!ENTITY libtinymail-TnySendQueue SYSTEM "xml/tny-send-queue.xml"> 
    2525<!ENTITY libtinymail-TnyPair SYSTEM "xml/tny-pair.xml"> 
     26<!ENTITY libtinymail-TnyLockable SYSTEM "xml/tny-lockable.xml"> 
     27<!ENTITY libtinymail-TnyNoopLockable SYSTEM "xml/tny-noop-lockable.xml"> 
    2628<!ENTITY libtinymail-TnyShared SYSTEM "xml/tny-shared.xml"> 
    2729 
    …… 
    6365<!ENTITY libtinymailui-gtk-TnyGtkMimePartSaveStrategy SYSTEM "xml/tny-gtk-mime-part-save-strategy.xml"> 
    6466<!ENTITY libtinymailui-gtk-TnyGtkTextMimePartView SYSTEM "xml/tny-gtk-text-mime-part-view.xml"> 
     67<!ENTITY libtinymailui-gtk-TnyGtkLockable SYSTEM "xml/tny-gtk-lockable.xml"> 
    6568 
    6669<!ENTITY libtinymailui-TnyMimePartSaver SYSTEM "xml/tny-mime-part-saver.xml"> 
    …… 
    134137                &libtinymail-TnySimpleList; 
    135138                &libtinymail-TnyPair; 
     139                &libtinymail-TnyLockable; 
     140                &libtinymail-TnyNoopLockable; 
    136141                &libtinymail-TnyEnums; 
    137142                &libtinymail-TnyShared; 
    …… 
    165170                &libtinymailui-gtk-TnyGtkTextMimePartView; 
    166171                &libtinymailui-gtk-TnyGtkAttachmentMimePartView; 
     172                &libtinymailui-gtk-TnyGtkLockable; 
    167173                &libtinymailui-gtk-TnyGtkEnums; 
    168174        </chapter> 

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

    r886 r1399  
    4343@name:  
    4444@options:  
     45@cache_location:  
    4546@account_type:  
    4647 

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

    r1379 r1399  
    1010</para> 
    1111 
    12  
    1312<!-- ##### SECTION See_Also ##### --> 
    1413<para> 
    1514 
    1615</para> 
    17  
    1816 
    1917<!-- ##### SECTION Stability_Level ##### --> 
    …… 
    2725@inbox:  
    2826@lock:  
     27@delete_originals:  
    2928 
    3029<!-- ##### MACRO TNY_CAMEL_POP_STORE_ACCOUNT_GET_PRIVATE ##### --> 

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

    r910 r1399  
    3232 
    3333 
     34<!-- ##### FUNCTION tny_camel_pop_store_account_get_delete_originals ##### --> 
     35<para> 
     36 
     37</para> 
     38 
     39@self:  
     40@Returns:  
     41 
     42 
     43<!-- ##### FUNCTION tny_camel_pop_store_account_set_delete_originals ##### --> 
     44<para> 
     45 
     46</para> 
     47 
     48@self:  
     49@delete_originals:  
     50 
     51 

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

    r886 r1399  
    3737@connchanged_signal:  
    3838@current_accounts:  
     39@camel_dir:  
     40@in_auth_function:  
     41@ui_lock:  
    3942 
    4043<!-- ##### STRUCT TnySessionCamelClass ##### --> 
    …… 
    4447 
    4548@parent_class:  
    46 @set_pass_func_func:  
    47 @set_forget_pass_func_func:  
    48 @set_account_store_func:  
    4949 
    5050<!-- ##### FUNCTION tny_session_camel_new ##### --> 

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

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

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

    r1379 r1399  
    4040</para> 
    4141 
    42 @:  
    43 @:  
    44 @:  
    45 @: 
    46  
    4742@tnysendqueue: the object which received the signal. 
    4843@arg1:  
    …… 
    5449 
    5550</para> 
    56  
    57 @:  
    58 @:  
    59 @:  
    60 @: 
    6151 
    6252@tnysendqueue: the object which received the signal. 

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

    r949 r1399  
    4949@connchanged_signal:  
    5050@current_accounts:  
     51@camel_dir:  
     52@in_auth_function:  
     53@ui_lock:  
    5154 
    5255<!-- ##### FUNCTION tny_session_camel_set_pass_func ##### --> 
    …… 
    8891 
    8992 
     93<!-- ##### FUNCTION tny_session_camel_set_ui_locker ##### --> 
     94<para> 
     95 
     96</para> 
     97 
     98@self:  
     99@ui_lock:  
     100 
     101 

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

    r1379 r1399  
    478478</para> 
    479479 
    480 @tnysendqueue: the object which received the signal. 
    481 @arg1:  
    482 @arg2:  
    483 @arg3:  
     480@:  
     481@:  
     482@:  
     483@:  
    484484 
    485485<!-- ##### SIGNAL TnySendQueue::msg-sent ##### --> 
    …… 
    488488</para> 
    489489 
    490 @tnysendqueue: the object which received the signal. 
    491 @arg1:  
    492 @arg2:  
    493 @arg3:  
     490@:  
     491@:  
     492@:  
     493@:  
    494494 
    495495<!-- ##### STRUCT TnySendQueueIface ##### --> 
    …… 
    532532@parent:  
    533533 
     534<!-- ##### STRUCT TnyLockable ##### --> 
     535<para> 
     536 
     537</para> 
     538 
     539 
     540<!-- ##### STRUCT TnyLockableIface ##### --> 
     541<para> 
     542 
     543</para> 
     544 
     545@parent:  
     546@lock_func:  
     547@unlock_func:  
     548 
     549<!-- ##### STRUCT TnyNoopLockable ##### --> 
     550<para> 
     551 
     552</para> 
     553 
     554 
     555<!-- ##### STRUCT TnyNoopLockableClass ##### --> 
     556<para> 
     557 
     558</para> 
     559 
     560@parent:  
     561 

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

    r1398 r1399  
    6767} 
    6868 
     69/** 
     70 * tny_noop_lockable_new: 
     71 * 
     72 * Return value: a #TnyLockable instance that does nothing 
     73 **/ 
    6974TnyLockable* 
    7075tny_noop_lockable_new (void) 

  • trunk/libtinymailui-gtk/tny-gtk-lockable.c

    r1398 r1399  
    6767} 
    6868 
     69/** 
     70 * tny_gtk_lockable_new: 
     71 * 
     72 * Create a #TnyLockable instance that uses gdk_threads_enter and gdk_threads_leave 
     73 * as lock and unlock implementations. 
     74 * 
     75 * Return value: a new #TnyLockable instance implemented for Gtk+ 
     76 **/ 
    6977TnyLockable* 
    7078tny_gtk_lockable_new (void)