Changeset 2332

Show
Ignore:
Timestamp:
07/01/07 18:58:07
Author:
pvanhoof
Message:

Doc fixes

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

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

    r2121 r2332  
    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-account.sgml

    r2121 r2332  
    3737 
    3838@tnyaccount: the object which received the signal. 
     39@Param2:  
    3940 
    4041<!-- ##### STRUCT TnyAccountIface ##### --> 
    …… 
    4445 
    4546@parent:  
    46 @is_connected_func:  
     47@get_connection_status_func:  
    4748@set_id_func:  
    4849@set_name_func:  
    …… 
    6869@cancel_func:  
    6970@matches_url_string_func:  
     71@start_operation_func:  
     72@stop_operation_func:  
    7073@connection_status_changed:  
    7174 
    …… 
    7881 
    7982 
    80 <!-- ##### FUNCTION tny_account_is_connected ##### --> 
     83<!-- ##### FUNCTION tny_account_get_connection_status ##### --> 
    8184<para> 
    8285 
    …… 
    294297 
    295298 
     299<!-- ##### FUNCTION tny_account_start_operation ##### --> 
     300<para> 
     301 
     302</para> 
     303 
     304@self:  
     305@domain:  
     306@code:  
     307@status_callback:  
     308@status_user_data:  
     309 
     310 
     311<!-- ##### FUNCTION tny_account_stop_operation ##### --> 
     312<para> 
     313 
     314</para> 
     315 
     316@self:  
     317@canceled:  
     318 
     319 

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

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

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

    r2003 r2332  
    8080 
    8181@TNY_ERROR_UNSPEC: An unspecified error occured 
     82@TNY_FOLDER_ERROR_SYNC:  
    8283@TNY_FOLDER_ERROR_REMOVE_MSG: An error that occured while removing a message 
    8384@TNY_FOLDER_ERROR_ADD_MSG: An error that occured while adding a message 
    …… 
    9394@TNY_ACCOUNT_ERROR_TRY_CONNECT: An error that occured while trying to connect to an account 
    9495@TNY_ACCOUNT_STORE_ERROR_UNKNOWN_ALERT:  
     96@TNY_ACCOUNT_ERROR_GET_SUPPORTED_AUTH:  
     97@TNY_SEND_QUEUE_ERROR_ADD:  
     98@TNY_ACCOUNT_STORE_ERROR_CANCEL_ALERT:  
    9599 
    96100<!-- ##### ENUM TnyAccountType ##### --> 
    …… 
    101105@TNY_ACCOUNT_TYPE_STORE: A account that can store folders and messages 
    102106@TNY_ACCOUNT_TYPE_TRANSPORT: A account that can send and messages (transfer them) 
     107@TNY_ACCOUNT_TYPE_COMBINED:  
     108 
     109<!-- ##### ENUM TnyConnectionStatus ##### --> 
     110<para> 
     111 
     112</para> 
     113 
     114@TNY_CONNECTION_STATUS_DISCONNECTED:  
     115@TNY_CONNECTION_STATUS_DISCONNECTED_BROKEN:  
     116@TNY_CONNECTION_STATUS_CONNECTED_BROKEN:  
     117@TNY_CONNECTION_STATUS_CONNECTED:  
     118@TNY_CONNECTION_STATUS_RECONNECTING:  
     119@TNY_CONNECTION_STATUS_INIT:  
    103120 
    104121<!-- ##### ENUM TnyAccountStoreSignal ##### --> 
    …… 
    154171 
    155172@TNY_FOLDER_STORE_QUERY_OPTION_SUBSCRIBED: Only subscribed folders will match this query 
    156 @TNY_FOLDER_STORE_QUERY_OPTION_UNSUBSCRIBED: Only unsibscribed folders will match this query 
    157173@TNY_FOLDER_STORE_QUERY_OPTION_MATCH_ON_NAME: Only folders that will match the pattern on folder name will match this query 
    158174@TNY_FOLDER_STORE_QUERY_OPTION_MATCH_ON_ID: Only folders that wil match the pattern on folder id will match this query 
    …… 
    199215@TNY_FOLDER_TYPE_SENT: The folder type is a SENT folder 
    200216@TNY_FOLDER_TYPE_ROOT: The folder type is a #TnyAccount that contains this folder (used for the #TnyGtkAccountTreeModel) 
    201  
     217@TNY_FOLDER_TYPE_NOTES:  
     218@TNY_FOLDER_TYPE_DRAFTS:  
     219@TNY_FOLDER_TYPE_CONTACTS:  
     220@TNY_FOLDER_TYPE_CALENDAR:  
     221@TNY_FOLDER_TYPE_ARCHIVE:  
     222@TNY_FOLDER_TYPE_MERGE:  
     223@TNY_FOLDER_TYPE_NUM:  
     224 

  • trunk/docs/devel/reference/tmpl/tny-mime-part.sgml

    r1379 r2332  
    4040@get_description_func:  
    4141@get_content_location_func:  
     42@is_purged_func:  
    4243@set_content_location_func:  
    4344@set_description_func:  
    …… 
    4546@set_filename_func:  
    4647@set_content_type_func:  
     48@set_purged_func:  
    4749@is_attachment_func:  
    4850@get_parts_func:  
    …… 
    5052@add_part_func:  
    5153@get_header_pairs_func:  
     54@set_header_pair_func:  
    5255 
    5356<!-- ##### FUNCTION tny_mime_part_get_content_type ##### --> 
    …… 
    135138 
    136139 
     140<!-- ##### FUNCTION tny_mime_part_is_purged ##### --> 
     141<para> 
     142 
     143</para> 
     144 
     145@self:  
     146@Returns:  
     147 
     148 
    137149<!-- ##### FUNCTION tny_mime_part_set_content_location ##### --> 
    138150<para> 
    …… 
    180192 
    181193 
     194<!-- ##### FUNCTION tny_mime_part_set_purged ##### --> 
     195<para> 
     196 
     197</para> 
     198 
     199@self:  
     200 
     201 
    182202<!-- ##### FUNCTION tny_mime_part_is_attachment ##### --> 
    183203<para> 
    …… 
    235255 
    236256 
     257<!-- ##### FUNCTION tny_mime_part_set_header_pair ##### --> 
     258<para> 
     259 
     260</para> 
     261 
     262@self:  
     263@name:  
     264@value:  
     265 
     266 

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

    r1721 r2332  
    3434@get_folder_func:  
    3535@get_url_string_func:  
     36@uncache_attachments_func:  
     37@rewrite_cache_func:  
    3638 
    3739<!-- ##### FUNCTION tny_msg_get_header ##### --> 
    …… 
    6264 
    6365 
     66<!-- ##### FUNCTION tny_msg_uncache_attachments ##### --> 
     67<para> 
     68 
     69</para> 
     70 
     71@self:  
     72 
     73 
     74<!-- ##### FUNCTION tny_msg_rewrite_cache ##### --> 
     75<para> 
     76 
     77</para> 
     78 
     79@self:  
     80 
     81 

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

    r2121 r2332  
    4040</para> 
    4141 
     42@:  
     43@:  
     44@:  
     45@: 
     46 
    4247@tnysendqueue: the object which received the signal. 
    4348@arg1:  
    …… 
    5055</para> 
    5156 
     57@:  
     58@:  
     59@:  
     60@: 
     61 
    5262@tnysendqueue: the object which received the signal. 
    5363@arg1:  
    54 @arg2:  
    55 @arg3:  
    5664 
    5765<!-- ##### STRUCT TnySendQueueIface ##### --> 

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

    r2121 r2332  
    4747</para> 
    4848 
    49 @tnyaccountstore: the object which received the signal. 
    50 @arg1:  
     49@:  
     50@:  
    5151 
    5252<!-- ##### SIGNAL TnyAccountStore::account-inserted ##### --> 
    …… 
    5555</para> 
    5656 
    57 @tnyaccountstore: the object which received the signal. 
    58 @arg1:  
     57@:  
     58@:  
    5959 
    6060<!-- ##### SIGNAL TnyAccountStore::account-removed ##### --> 
    …… 
    6363</para> 
    6464 
    65 @tnyaccountstore: the object which received the signal. 
    66 @arg1:  
     65@:  
     66@:  
    6767 
    6868<!-- ##### SIGNAL TnyAccountStore::accounts-reloaded ##### --> 
    …… 
    7171</para> 
    7272 
    73 @tnyaccountstore: the object which received the signal. 
     73@:  
    7474 
    7575<!-- ##### SIGNAL TnyAccountStore::connecting-finished ##### --> 
    …… 
    7878</para> 
    7979 
    80 @tnyaccountstore: the object which received the signal. 
     80@:  
    8181 
    8282<!-- ##### SIGNAL TnyAccountStore::connecting-started ##### --> 
    …… 
    8585</para> 
    8686 
    87 @tnyaccountstore: the object which received the signal. 
     87@:  
    8888 
    8989<!-- ##### STRUCT TnyAccountStoreIface ##### --> 
    …… 
    160160@get_folder_func:  
    161161@get_url_string_func:  
     162@uncache_attachments_func:  
     163@rewrite_cache_func:  
    162164 
    163165<!-- ##### STRUCT TnyFolder ##### --> 
    …… 
    261263@get_description_func:  
    262264@get_content_location_func:  
     265@is_purged_func:  
    263266@set_content_location_func:  
    264267@set_description_func:  
    …… 
    266269@set_filename_func:  
    267270@set_content_type_func:  
     271@set_purged_func:  
    268272@is_attachment_func:  
    269273@get_parts_func:  
    …… 
    271275@add_part_func:  
    272276@get_header_pairs_func:  
     277@set_header_pair_func:  
    273278 
    274279<!-- ##### STRUCT TnyAccount ##### --> 
    …… 
    283288</para> 
    284289 
    285 @tnyaccount: the object which received the signal. 
     290@:  
     291@Param2:  
    286292 
    287293<!-- ##### STRUCT TnyAccountIface ##### --> 
    …… 
    291297 
    292298@parent:  
    293 @is_connected_func:  
     299@get_connection_status_func:  
    294300@set_id_func:  
    295301@set_name_func:  
    …… 
    315321@cancel_func:  
    316322@matches_url_string_func:  
     323@start_operation_func:  
     324@stop_operation_func:  
    317325@connection_status_changed:  
    318326 
    …… 
    328336</para> 
    329337 
    330 @tnydevice: the object which received the signal. 
    331 @arg1:  
     338@:  
     339@:  
    332340 
    333341<!-- ##### STRUCT TnyDeviceIface ##### --> 
    …… 
    592600</para> 
    593601 
    594 @:  
    595 @:  
    596 @:  
    597 @:  
     602@tnysendqueue: the object which received the signal. 
     603@arg1:  
     604@arg2:  
     605@arg3:  
    598606 
    599607<!-- ##### SIGNAL TnySendQueue::msg-sent ##### --> 
    …… 
    602610</para> 
    603611 
    604 @:  
    605 @:  
    606 @:  
    607 @:  
     612@tnysendqueue: the object which received the signal. 
     613@arg1:  
    608614 
    609615<!-- ##### STRUCT TnySendQueueIface ##### -->