gmime r1460 - trunk/docs/reference

[fejj svn gnome org]

Author: fejj
Date: Fri Sep 19 01:58:17 2008
New Revision: 1460
URL: http://svn.gnome.org/viewvc/gmime?rev=1460&view=rev

Log:
updated docs

Modified:
   trunk/docs/reference/gmime-docs.sgml
   trunk/docs/reference/gmime-sections.txt
   trunk/docs/reference/gmime.hierarchy
   trunk/docs/reference/tree_index.sgml

Modified: trunk/docs/reference/gmime-docs.sgml
==============================================================================
--- trunk/docs/reference/gmime-docs.sgml	(original)
+++ trunk/docs/reference/gmime-docs.sgml	Fri Sep 19 01:58:17 2008
@@ -20,6 +20,9 @@
 <!ENTITY gmime-utils SYSTEM "xml/gmime-utils.xml">
 <!ENTITY gmime-encodings SYSTEM "xml/gmime-encodings.xml">
 <!ENTITY InternetAddress SYSTEM "xml/internet-address.xml">
+<!ENTITY InternetAddressGroup SYSTEM "xml/internet-address-group.xml">
+<!ENTITY InternetAddressMailbox SYSTEM "xml/internet-address-mailbox.xml">
+<!ENTITY InternetAddressList SYSTEM "xml/internet-address-list.xml">
 <!ENTITY GMimeParser SYSTEM "xml/gmime-parser.xml">
 <!ENTITY gmime-charset SYSTEM "xml/gmime-charset.xml">
 <!ENTITY gmime-iconv SYSTEM "xml/gmime-iconv.xml">
@@ -216,6 +219,9 @@
     <chapter id="InternetAddresses">
       <title>Internet Addresses</title>
       &InternetAddress;
+      &InternetAddressGroup;
+      &InternetAddressMailbox;
+      &InternetAddressList;
     </chapter>
 
     <chapter id="MimeParts">

Modified: trunk/docs/reference/gmime-sections.txt
==============================================================================
--- trunk/docs/reference/gmime-sections.txt	(original)
+++ trunk/docs/reference/gmime-sections.txt	Fri Sep 19 01:58:17 2008
@@ -961,19 +961,65 @@
 <SECTION>
 <FILE>internet-address</FILE>
 InternetAddress
-InternetAddressMailbox
-InternetAddressGroup
-InternetAddressList
 internet_address_get_name
 internet_address_set_name
 internet_address_to_string
-internet_address_mailbox_new
-internet_address_mailbox_get_addr
-internet_address_mailbox_set_addr
+
+<SUBSECTION Private>
+internet_address_get_type
+
+<SUBSECTION Standard>
+INTERNET_ADDRESS
+IS_INTERNET_ADDRESS
+INTERNET_ADDRESS_TYPE
+INTERNET_ADDRESS_CLASS
+IS_INTERNET_ADDRESS_CLASS
+INTERNET_ADDRESS_GET_CLASS
+InternetAddressClass
+</SECTION>
+
+<SECTION>
+<FILE>internet-address-group</FILE>
+InternetAddressGroup
 internet_address_group_new
 internet_address_group_get_members
 internet_address_group_set_members
 internet_address_group_add_member
+
+<SUBSECTION Private>
+internet_address_group_get_type
+
+<SUBSECTION Standard>
+INTERNET_ADDRESS_GROUP
+INTERNET_ADDRESS_IS_GROUP
+INTERNET_ADDRESS_TYPE_GROUP
+INTERNET_ADDRESS_GROUP_CLASS
+INTERNET_ADDRESS_IS_GROUP_CLASS
+InternetAddressGroupClass
+</SECTION>
+
+<SECTION>
+<FILE>internet-address-mailbox</FILE>
+InternetAddressMailbox
+internet_address_mailbox_new
+internet_address_mailbox_get_addr
+internet_address_mailbox_set_addr
+
+<SUBSECTION Private>
+internet_address_mailbox_get_type
+
+<SUBSECTION Standard>
+INTERNET_ADDRESS_MAILBOX
+INTERNET_ADDRESS_IS_MAILBOX
+INTERNET_ADDRESS_TYPE_MAILBOX
+INTERNET_ADDRESS_MAILBOX_CLASS
+INTERNET_ADDRESS_IS_MAILBOX_CLASS
+InternetAddressMailboxClass
+</SECTION>
+
+<SECTION>
+<FILE>internet-address-list</FILE>
+InternetAddressList
 internet_address_list_new
 internet_address_list_length
 internet_address_list_clear
@@ -992,37 +1038,15 @@
 internet_address_list_writer
 
 <SUBSECTION Private>
-internet_address_get_type
 internet_address_list_get_type
-internet_address_group_get_type
-internet_address_mailbox_get_type
 
 <SUBSECTION Standard>
-INTERNET_ADDRESS
-INTERNET_ADDRESS_CLASS
-INTERNET_ADDRESS_GET_CLASS
-INTERNET_ADDRESS_GROUP
-INTERNET_ADDRESS_GROUP_CLASS
-INTERNET_ADDRESS_IS_GROUP
-INTERNET_ADDRESS_IS_GROUP_CLASS
-INTERNET_ADDRESS_IS_MAILBOX
-INTERNET_ADDRESS_IS_MAILBOX_CLASS
 INTERNET_ADDRESS_LIST
-INTERNET_ADDRESS_LIST_CLASS
-INTERNET_ADDRESS_LIST_TYPE
-INTERNET_ADDRESS_MAILBOX
-INTERNET_ADDRESS_MAILBOX_CLASS
-INTERNET_ADDRESS_TYPE
-INTERNET_ADDRESS_TYPE_GROUP
-INTERNET_ADDRESS_TYPE_MAILBOX
-IS_INTERNET_ADDRESS
-IS_INTERNET_ADDRESS_CLASS
 IS_INTERNET_ADDRESS_LIST
+INTERNET_ADDRESS_LIST_TYPE
+INTERNET_ADDRESS_LIST_CLASS
 IS_INTERNET_ADDRESS_LIST_CLASS
-InternetAddressClass
-InternetAddressGroupClass
 InternetAddressListClass
-InternetAddressMailboxClass
 </SECTION>
 
 <SECTION>

Modified: trunk/docs/reference/gmime.hierarchy
==============================================================================
--- trunk/docs/reference/gmime.hierarchy	(original)
+++ trunk/docs/reference/gmime.hierarchy	Fri Sep 19 01:58:17 2008
@@ -1,14 +1,18 @@
 GObject
-  GMimeContentDisposition
-  GMimeContentType
   GMimeObject
+    GMimeMessage
     GMimePart
       GMimeMessagePartial
     GMimeMultipart
       GMimeMultipartEncrypted
       GMimeMultipartSigned
     GMimeMessagePart
-    GMimeMessage
+  GMimeContentType
+  GMimeContentDisposition
+  InternetAddress
+    InternetAddressGroup
+    InternetAddressMailbox
+  InternetAddressList
   GMimeCipherContext
     GMimeGpgContext
   GMimeDataWrapper
@@ -37,9 +41,5 @@
     GMimeStreamMem
     GMimeStreamMmap
     GMimeStreamNull
-  InternetAddress
-    InternetAddressGroup
-    InternetAddressMailbox
-  InternetAddressList
 GInterface
   GTypePlugin

Modified: trunk/docs/reference/tree_index.sgml
==============================================================================
--- trunk/docs/reference/tree_index.sgml	(original)
+++ trunk/docs/reference/tree_index.sgml	Fri Sep 19 01:58:17 2008
@@ -1,9 +1,9 @@
 <screen>
-    <link linkend="GMimeContentType">GMimeContentType</link>
-    <link linkend="GMimeDisposition">GMimeDisposition</link>
     <link linkend="GMimeHeader">GMimeHeader</link>
     <link linkend="GMimeParam">GMimeParam</link>
     <link linkend="GObject">GObject</link>
+        <link linkend="GMimeContentDisposition">GMimeContentDisposition</link>
+        <link linkend="GMimeContentType">GMimeContentType</link>
         <link linkend="GMimeDataWrapper">GMimeDataWrapper</link>
         <link linkend="GMimeObject">GMimeObject</link>
             <link linkend="GMimeMessage">GMimeMessage</link>
@@ -38,5 +38,8 @@
             <link linkend="GMimeGpgContext">GMimeGpgContext</link>
         <link linkend="GMimeSession">GMimeSession</link>
             <link linkend="GMimeSessionSimple">GMimeSessionSimple</link>
-    <link linkend="InternetAddress">InternetAddress</link>
+        <link linkend="InternetAddress">InternetAddress</link>
+            <link linkend="InternetAddressGroup">InternetAddressGroup</link>
+            <link linkend="InternetAddressMailbox">InternetAddressMailbox</link>
+        <link linkend="InternetAddressList">InternetAddressList</link>
 </screen>