Changeset 1866

Show
Ignore:
Timestamp:
04/29/07 15:05:56
Author:
pvanhoof
Message:

Updated the documentation

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

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

    r1862 r1866  
    10421042} 
    10431043 
     1044/** 
     1045 * tny_camel_account_get_type: 
     1046 * 
     1047 * GType system helper function 
     1048 * 
     1049 * Return value: a GType 
     1050 **/ 
    10441051GType  
    10451052tny_camel_account_get_type (void) 

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

    r1862 r1866  
    32843284} 
    32853285 
     3286/** 
     3287 * tny_camel_folder_get_type: 
     3288 * 
     3289 * GType system helper function 
     3290 * 
     3291 * Return value: a GType 
     3292 **/ 
    32863293GType  
    32873294tny_camel_folder_get_type (void) 

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

    r1862 r1866  
    386386} 
    387387 
    388  
     388/** 
     389 * tny_camel_header_get_type: 
     390 * 
     391 * GType system helper function 
     392 * 
     393 * Return value: a GType 
     394 **/ 
    389395GType  
    390396tny_camel_header_get_type (void) 

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

    r1862 r1866  
    8787} 
    8888 
     89/** 
     90 * tny_camel_imap_folder_get_type: 
     91 * 
     92 * GType system helper function 
     93 * 
     94 * Return value: a GType 
     95 **/ 
    8996GType  
    9097tny_camel_imap_folder_get_type (void) 

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

    r1862 r1866  
    141141} 
    142142 
     143/** 
     144 * tny_camel_imap_store_account_get_type: 
     145 * 
     146 * GType system helper function 
     147 * 
     148 * Return value: a GType 
     149 **/ 
    143150GType  
    144151tny_camel_imap_store_account_get_type (void) 

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

    r1862 r1866  
    592592 * tny_camel_mime_part_get_part: 
    593593 * @self: The #TnyCamelMimePart instance 
     594 *  
     595 * Get the #CamelMimePart instance that is being proxied by @self. 
    594596 * 
    595597 * Return value: The #CamelMimePart instance 
    …… 
    934936} 
    935937 
     938/** 
     939 * tny_camel_mime_part_get_type: 
     940 * 
     941 * GType system helper function 
     942 * 
     943 * Return value: a GType 
     944 **/ 
    936945GType  
    937946tny_camel_mime_part_get_type (void) 

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

    r1862 r1866  
    410410 
    411411 
     412/** 
     413 * tny_camel_msg_header_get_type: 
     414 * 
     415 * GType system helper function 
     416 * 
     417 * Return value: a GType 
     418 **/ 
    412419GType  
    413420tny_camel_msg_header_get_type (void) 

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

    r1862 r1866  
    330330} 
    331331 
     332/** 
     333 * tny_camel_msg_get_type: 
     334 * 
     335 * GType system helper function 
     336 * 
     337 * Return value: a GType 
     338 **/ 
    332339GType  
    333340tny_camel_msg_get_type (void) 

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

    r1862 r1866  
    123123} 
    124124 
     125/** 
     126 * tny_camel_nntp_folder_get_type: 
     127 * 
     128 * GType system helper function 
     129 * 
     130 * Return value: a GType 
     131 **/ 
    125132GType  
    126133tny_camel_nntp_folder_get_type (void) 

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

    r1862 r1866  
    166166} 
    167167 
     168/** 
     169 * tny_camel_nntp_store_account_get_type: 
     170 * 
     171 * GType system helper function 
     172 * 
     173 * Return value: a GType 
     174 **/ 
    168175GType  
    169176tny_camel_nntp_store_account_get_type (void) 

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

    r1862 r1866  
    125125} 
    126126 
     127/** 
     128 * tny_camel_pop_folder_get_type: 
     129 * 
     130 * GType system helper function 
     131 * 
     132 * Return value: a GType 
     133 **/ 
    127134GType  
    128135tny_camel_pop_folder_get_type (void) 

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

    r1862 r1866  
    208208} 
    209209 
     210/** 
     211 * tny_camel_pop_store_account_get_type: 
     212 * 
     213 * GType system helper function 
     214 * 
     215 * Return value: a GType 
     216 **/ 
    210217GType  
    211218tny_camel_pop_store_account_get_type (void) 

  • trunk/libtinymail-camel/tny-camel-send-queue.c

    r1862 r1866  
    675675} 
    676676 
     677/** 
     678 * tny_camel_send_queue_get_type: 
     679 * 
     680 * GType system helper function 
     681 * 
     682 * Return value: a GType 
     683 **/ 
    677684GType  
    678685tny_camel_send_queue_get_type (void) 

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

    r1862 r1866  
    10521052} 
    10531053 
     1054/** 
     1055 * tny_camel_store_account_get_type: 
     1056 * 
     1057 * GType system helper function 
     1058 * 
     1059 * Return value: a GType 
     1060 **/ 
    10541061GType  
    10551062tny_camel_store_account_get_type (void) 

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

    r1862 r1866  
    163163 
    164164/** 
    165  * tny_camel_stream_camel_new: 
     165 * tny_camel_stream_new: 
    166166 * @stream: A #CamelStream stream to play proxy for 
    167167 * 
    …… 
    240240} 
    241241 
     242/** 
     243 * tny_camel_stream_get_type: 
     244 * 
     245 * GType system helper function 
     246 * 
     247 * Return value: a GType 
     248 **/ 
    242249GType  
    243250tny_camel_stream_get_type (void) 

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

    r1862 r1866  
    411411} 
    412412 
     413/** 
     414 * tny_camel_transport_account_get_type: 
     415 * 
     416 * GType system helper function 
     417 * 
     418 * Return value: a GType 
     419 **/ 
    413420GType  
    414421tny_camel_transport_account_get_type (void) 

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

    r1862 r1866  
    657657} 
    658658 
     659/** 
     660 * tny_session_camel_get_type: 
     661 * 
     662 * GType system helper function 
     663 * 
     664 * Return value: a GType 
     665 **/ 
    659666CamelType 
    660667tny_session_camel_get_type (void) 

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

    r1862 r1866  
    149149} 
    150150 
     151/** 
     152 * tny_stream_camel_get_type: 
     153 * 
     154 * CamelType system helper function 
     155 * 
     156 * Return value: a CamelType 
     157 **/ 
    151158CamelType 
    152159tny_stream_camel_get_type (void) 

  • trunk/libtinymail-gnome-desktop/tny-gnome-account-store.c

    r1862 r1866  
    489489} 
    490490 
    491  
     491/** 
     492 * tny_gnome_account_store_add_store_account: 
     493 * @self: a #TnyGnomeAccountStore instance 
     494 * @account: a #TnyStoreAccount instance to add 
     495 *  
     496 * Add @account to @self 
     497 **/ 
    492498void 
    493499tny_gnome_account_store_add_store_account (TnyGnomeAccountStore *self, TnyStoreAccount *account) 
    …… 
    502508} 
    503509 
     510/** 
     511 * tny_gnome_account_store_add_transport_account: 
     512 * @self: a #TnyGnomeAccountStore instance 
     513 * @account: a #TnyTransportAccount instance to add 
     514 *  
     515 * Add @account to @self 
     516 **/ 
    504517void 
    505518tny_gnome_account_store_add_transport_account (TnyGnomeAccountStore *self, TnyTransportAccount *account) 
    …… 
    588601 * tny_gnome_account_store_get_session: 
    589602 * @self: The #TnyGnomeAccountStore instance 
     603 * 
     604 * Get the #CamelSession being used 
    590605 * 
    591606 * Return value: A #TnySessionCamel instance 
    …… 
    628643} 
    629644 
    630  
     645/** 
     646 * tny_gnome_account_store_get_type: 
     647 * 
     648 * GType system helper function 
     649 * 
     650 * Return value: a GType 
     651 **/ 
    631652GType  
    632653tny_gnome_account_store_get_type (void) 

  • trunk/libtinymail-gnome-desktop/tny-gnome-platform-factory.c

    r1783 r1866  
    101101 * tny_gnome_platform_factory_get_instance: 
    102102 * 
     103 * Get the platform factory singleton instance implemented for GNOME desktops 
    103104 * 
    104105 * Return value: The #TnyPlatformFactory singleton instance implemented for GNOME desktops 

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

    r1855 r1866  
    426426 
    427427 
     428/** 
     429 * tny_account_store_get_type: 
     430 * 
     431 * GType system helper function 
     432 * 
     433 * Return value: a GType 
     434 **/ 
    428435GType 
    429436tny_account_store_get_type (void) 
    …… 
    454461} 
    455462 
     463/** 
     464 * tny_alert_type_get_type: 
     465 * 
     466 * GType system helper function 
     467 * 
     468 * Return value: a GType 
     469 **/ 
    456470GType 
    457471tny_alert_type_get_type (void) 
    …… 
    470484} 
    471485 
     486/** 
     487 * tny_get_accounts_request_type_get_type: 
     488 * 
     489 * GType system helper function 
     490 * 
     491 * Return value: a GType 
     492 **/ 
    472493GType 
    473494tny_get_accounts_request_type_get_type (void) 

  • trunk/libtinymail/tny-account.c

    r1862 r1866  
    813813} 
    814814 
     815/** 
     816 * tny_account_get_type: 
     817 * 
     818 * GType system helper function 
     819 * 
     820 * Return value: a GType 
     821 **/ 
    815822GType 
    816823tny_account_get_type (void) 
    …… 
    842849} 
    843850 
    844  
     851/** 
     852 * tny_account_type_get_type: 
     853 * 
     854 * GType system helper function 
     855 * 
     856 * Return value: a GType 
     857 **/ 
    845858GType 
    846859tny_account_type_get_type (void) 

  • trunk/libtinymail/tny-error.c

    r1511 r1866  
    2020#include <tny-error.h> 
    2121 
     22/** 
     23 * tny_error_domain_get_type: 
     24 * 
     25 * GType system helper function 
     26 * 
     27 * Return value: a GType 
     28 **/ 
    2229GType 
    2330tny_error_domain_get_type (void) 
    …… 
    3845 
    3946 
    40  
     47/** 
     48 * tny_error_get_type: 
     49 * 
     50 * GType system helper function 
     51 * 
     52 * Return value: a GType 
     53 **/ 
    4154GType 
    4255tny_error_get_type (void) 

  • trunk/libtinymail/tny-folder-store-query.c

    r1862 r1866  
    129129} 
    130130 
    131  
     131/** 
     132 * tny_folder_store_query_item_get_type: 
     133 * 
     134 * GType system helper function 
     135 * 
     136 * Return value: a GType 
     137 **/ 
    132138GType 
    133139tny_folder_store_query_item_get_type (void) 
    …… 
    308314} 
    309315 
    310  
     316/** 
     317 * tny_folder_store_query_option_get_type: 
     318 * 
     319 * GType system helper function 
     320 * 
     321 * Return value: a GType 
     322 **/ 
    311323GType 
    312324tny_folder_store_query_option_get_type (void) 

  • trunk/libtinymail/tny-folder.c

    r1856 r1866  
    11811181} 
    11821182 
    1183  
     1183/** 
     1184 * tny_folder_type_get_type: 
     1185 * 
     1186 * GType system helper function 
     1187 * 
     1188 * Return value: a GType 
     1189 **/ 
    11841190GType 
    11851191tny_folder_type_get_type (void) 

  • trunk/libtinymail/tny-header.c

    r1858 r1866  
    564564} 
    565565 
    566  
     566/** 
     567 * tny_header_flags_get_type: 
     568 * 
     569 * GType system helper function 
     570 * 
     571 * Return value: a GType 
     572 **/ 
    567573GType 
    568574tny_header_flags_get_type (void) 

  • trunk/libtinymail/tny-status.c

    r1862 r1866  
    2222#include <tny-status.h> 
    2323 
     24/** 
     25 * tny_status_domain_get_type: 
     26 * 
     27 * GType system helper function 
     28 * 
     29 * Return value: a GType 
     30 **/ 
    2431GType 
    2532tny_status_domain_get_type (void) 
    …… 
    3744 
    3845 
    39  
     46/** 
     47 * tny_status_code_get_type: 
     48 * 
     49 * GType system helper function 
     50 * 
     51 * Return value: a GType 
     52 **/ 
    4053GType 
    4154tny_status_code_get_type (void) 

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

    r1862 r1866  
    149149} 
    150150 
     151/** 
     152 * tny_store_account_get_type: 
     153 * 
     154 * GType system helper function 
     155 * 
     156 * Return value: a GType 
     157 **/ 
    151158GType 
    152159tny_store_account_get_type (void) 

  • trunk/libtinymailui-gtk/tny-gtk-account-list-model.c

    r1858 r1866  
    295295} 
    296296 
    297  
     297/** 
     298 * tny_gtk_account_list_model_column_get_type: 
     299 * 
     300 * GType system helper function 
     301 * 
     302 * Return value: a GType 
     303 **/ 
    298304GType  
    299305tny_gtk_account_list_model_column_get_type (void) 

  • trunk/libtinymailui-gtk/tny-gtk-attach-list-model.c

    r1858 r1866  
    378378} 
    379379 
    380  
     380/** 
     381 * tny_gtk_attach_list_model_column_get_type: 
     382 * 
     383 * GType system helper function 
     384 * 
     385 * Return value: a GType 
     386 **/ 
    381387GType  
    382388tny_gtk_attach_list_model_column_get_type (void) 

  • trunk/libtinymailui-gtk/tny-gtk-attachment-mime-part-view.c

    r1862 r1866  
    198198} 
    199199 
     200/** 
     201 * tny_gtk_attachment_mime_part_view_get_type: 
     202 * 
     203 * GType system helper function 
     204 * 
     205 * Return value: a GType 
     206 **/ 
    200207GType  
    201208tny_gtk_attachment_mime_part_view_get_type (void) 

  • trunk/libtinymailui-gtk/tny-gtk-folder-store-tree-model.c

    r1862 r1866  
    863863} 
    864864 
     865/** 
     866 * tny_gtk_folder_store_tree_model_get_type: 
     867 * 
     868 * GType system helper function 
     869 * 
     870 * Return value: a GType 
     871 **/ 
    865872GType 
    866873tny_gtk_folder_store_tree_model_get_type (void) 
    …… 
    917924 
    918925 
     926/** 
     927 * tny_gtk_folder_store_tree_model_column_get_type: 
     928 * 
     929 * GType system helper function 
     930 * 
     931 * Return value: a GType 
     932 **/ 
    919933GType 
    920934tny_gtk_folder_store_tree_model_column_get_type (void) 

  • trunk/libtinymailui-gtk/tny-gtk-header-list-model.c

    r1862 r1866  
    825825} 
    826826 
     827/** 
     828 * tny_gtk_header_list_model_get_type: 
     829 * 
     830 * GType system helper function 
     831 * 
     832 * Return value: a GType 
     833 **/ 
    827834GType 
    828835tny_gtk_header_list_model_get_type (void) 
    …… 
    873880} 
    874881 
     882/** 
     883 * tny_gtk_header_list_model_column_get_type: 
     884 * 
     885 * GType system helper function 
     886 * 
     887 * Return value: a GType 
     888 **/ 
    875889GType 
    876890tny_gtk_header_list_model_column_get_type (void) 

  • trunk/libtinymailui-gtk/tny-gtk-header-view.c

    r1862 r1866  
    264264} 
    265265 
     266/** 
     267 * tny_gtk_header_view_get_type: 
     268 * 
     269 * GType system helper function 
     270 * 
     271 * Return value: a GType 
     272 **/ 
    266273GType  
    267274tny_gtk_header_view_get_type (void) 

  • trunk/libtinymailui-gtk/tny-gtk-msg-view.c

    r1862 r1866  
    837837} 
    838838 
     839/** 
     840 * tny_gtk_msg_view_get_type: 
     841 * 
     842 * GType system helper function 
     843 * 
     844 * Return value: a GType 
     845 **/ 
    839846GType  
    840847tny_gtk_msg_view_get_type (void)