Changeset 1832

Show
Ignore:
Timestamp:
04/23/07 21:01:41
Author:
pvanhoof
Message:

Doc updates

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

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

    r1797 r1832  
    1111<!ENTITY libtinymail-TnyAccountStore SYSTEM "xml/tny-account-store.xml"> 
    1212<!ENTITY libtinymail-TnyHeader SYSTEM "xml/tny-header.xml"> 
     13<!ENTITY libtinymail-TnyStatus SYSTEM "xml/tny-status.xml"> 
    1314<!ENTITY libtinymail-TnyMsg SYSTEM "xml/tny-msg.xml"> 
    1415<!ENTITY libtinymail-TnyMimePart SYSTEM "xml/tny-mime-part.xml"> 
    …… 
    156157                &libtinymail-TnyEnums; 
    157158                &libtinymail-TnyShared; 
     159                &libtinymail-TnyStatus; 
    158160        </chapter> 
    159161 

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

    r1831 r1832  
    2323</para> 
    2424 
    25 @TNY_FOLDER_STATUS_CODE_REFRESH:  
    26 @TNY_FOLDER_STATUS_CODE_GET_MSG:  
     25@TNY_FOLDER_STATUS_CODE_REFRESH: a status that occurs while a folder is being refreshed  
     26@TNY_FOLDER_STATUS_CODE_GET_MSG: a status that occurs while a message is being downloaded 
    2727 
    2828<!-- ##### ENUM TnyStatusDomain ##### --> 
    …… 
    3131</para> 
    3232 
    33 @TNY_FOLDER_STATUS:  
     33@TNY_FOLDER_STATUS: a status domain code for folder 
    3434 
    3535<!-- ##### ENUM TnyFolderCaps ##### --> 
    …… 
    3838</para> 
    3939 
    40 @TNY_FOLDER_CAPS_WRITABLE:  
    41 @TNY_FOLDER_CAPS_PUSHEMAIL:  
     40@TNY_FOLDER_CAPS_WRITABLE: indicates that the folder is writable 
     41@TNY_FOLDER_CAPS_PUSHEMAIL: indicates that the folder supports Push E-mail 
    4242 
    4343<!-- ##### ENUM TnyFolderChangeChanged ##### --> 
    …… 
    4646</para> 
    4747 
    48 @TNY_FOLDER_CHANGE_CHANGED_ALL_COUNT:  
    49 @TNY_FOLDER_CHANGE_CHANGED_UNREAD_COUNT:  
    50 @TNY_FOLDER_CHANGE_CHANGED_ADDED_HEADERS:  
    51 @TNY_FOLDER_CHANGE_CHANGED_REMOVED_HEADERS:  
    52 @TNY_FOLDER_CHANGE_CHANGED_FOLDER_RENAME:  
     48@TNY_FOLDER_CHANGE_CHANGED_ALL_COUNT: indicates that the total count of the folder got changed 
     49@TNY_FOLDER_CHANGE_CHANGED_UNREAD_COUNT: indicates that the unread count of the folder got changed 
     50@TNY_FOLDER_CHANGE_CHANGED_ADDED_HEADERS: indicates that a summary item or header got added (that a message got added, this is a typical Push E-mail event) 
     51@TNY_FOLDER_CHANGE_CHANGED_REMOVED_HEADERS: indicates that a summary item or header got removed (that a message got removed, this is a typical Push E-mail event) 
     52@TNY_FOLDER_CHANGE_CHANGED_FOLDER_RENAME: indicates that the folder got renamed 
    5353 
    5454<!-- ##### ENUM TnyFolderStoreChangeChanged ##### --> 
    …… 
    5757</para> 
    5858 
    59 @TNY_FOLDER_STORE_CHANGE_CHANGED_CREATED_FOLDERS:  
    60 @TNY_FOLDER_STORE_CHANGE_CHANGED_REMOVED_FOLDERS:  
     59@TNY_FOLDER_STORE_CHANGE_CHANGED_CREATED_FOLDERS: indicates that a folder got created in the store 
     60@TNY_FOLDER_STORE_CHANGE_CHANGED_REMOVED_FOLDERS: indicates that a folder got removed from the store 
    6161 
    6262<!-- ##### ENUM TnyErrorDomain ##### --> 
    …… 
    6868@TNY_FOLDER_STORE_ERROR: An error domain for errors that occured with a folder store 
    6969@TNY_TRANSPORT_ACCOUNT_ERROR: An error domain for errors that occured with a transport account 
    70 @TNY_ACCOUNT_ERROR:  
     70@TNY_ACCOUNT_ERROR: An error domain for errors that occured with a account 
    7171 
    7272<!-- ##### ENUM TnyError ##### --> 
    …… 
    7575</para> 
    7676 
    77 @TNY_ERROR_UNSPEC:  
     77@TNY_ERROR_UNSPEC: An unspecified error occured 
    7878@TNY_FOLDER_ERROR_REMOVE_MSG: An error that occured while removing a message 
    7979@TNY_FOLDER_ERROR_ADD_MSG: An error that occured while adding a message 
    …… 
    8282@TNY_FOLDER_ERROR_TRANSFER_MSGS: An error that occured while transfering a message 
    8383@TNY_FOLDER_ERROR_SET_NAME: An error that occured while renaming a folder 
    84 @TNY_FOLDER_ERROR_COPY:  
     84@TNY_FOLDER_ERROR_COPY: An error that occured while copying a folder 
    8585@TNY_FOLDER_STORE_ERROR_REMOVE_FOLDER: An error that occured while removing a folder 
    8686@TNY_FOLDER_STORE_ERROR_GET_FOLDERS: An error that occured while getting folders 
    8787@TNY_FOLDER_STORE_ERROR_CREATE_FOLDER: An error that occured while creating a folder 
    8888@TNY_TRANSPORT_ACCOUNT_ERROR_SEND: An error that occured while sending a message 
    89 @TNY_ACCOUNT_ERROR_TRY_CONNECT:  
     89@TNY_ACCOUNT_ERROR_TRY_CONNECT: An error that occured while trying to connect to an account 
    9090 
    9191<!-- ##### ENUM TnyAccountType ##### --> 

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

    r1831 r1832  
    391391<!-- ##### USER_FUNCTION TnyStatusCallback ##### --> 
    392392<para> 
    393  
    394 </para> 
    395  
    396 @self:  
    397 @status:  
    398 @user_data:  
     393A method that gets called whenever there's a status event 
     394</para> 
     395 
     396@self: The sender of the status  
     397@status: a #TnyStatus object 
     398@user_data: user data passed by the caller 
    399399 
    400400 

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

    r1831 r1832  
    11<!-- ##### SECTION Title ##### --> 
    2 tny-status 
     2TnyStatus 
    33 
    44<!-- ##### SECTION Short_Description ##### --> 
    5  
     5An object containing status information 
    66 
    77<!-- ##### SECTION Long_Description ##### --> 
    88<para> 
    9  
     9An object containing status information 
    1010</para> 
    1111 
    1212<!-- ##### SECTION See_Also ##### --> 
    1313<para> 
    14  
     14#TnyFolder 
    1515</para> 
    1616