API-DOC and Fix iBus Google issue 320.

3 files changed, 74 insertions, 38 deletions

diff --git a/docs/reference/ibus/.gitignore b/docs/reference/ibus/.gitignore
index c3abea20..6cdfa55e 100644
--- a/docs/reference/ibus/.gitignore
+++ b/docs/reference/ibus/.gitignore
@@ -1,7 +1,6 @@
 ibus-decl-list.txt
 ibus-decl.txt
 ibus-overrides.txt
-ibus-sections.txt
 ibus-undeclared.txt
 ibus-undocumented.txt
 ibus-unused.txt
diff --git a/docs/reference/ibus/Makefile.am b/docs/reference/ibus/Makefile.am
index c1991f1e..310bdef9 100644
--- a/docs/reference/ibus/Makefile.am
+++ b/docs/reference/ibus/Makefile.am
@@ -25,7 +25,8 @@ SCANGOBJ_OPTIONS=
 
 # Extra options to supply to gtkdoc-scan.
 # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
-SCAN_OPTIONS=--rebuild-sections
+# SCAN_OPTIONS=--rebuild-sections
+SCAN_OPTIONS=
 
 # Extra options to supply to gtkdoc-mkdb.
 # e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
@@ -42,7 +43,7 @@ FIXXREF_OPTIONS=
 # Used for dependencies. The docs will be rebuilt if any of these change.
 # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
 # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
-HFILE_GLOB=
+HFILE_GLOB=$(top_srcdir)/src/*.h
 CFILE_GLOB=
 
 # Header files to ignore when scanning.
@@ -97,4 +98,10 @@ EXTRA_DIST +=
 
 # Comment this out if you want your docs-status tested during 'make check'
 #TESTS = $(GTKDOC_CHECK)
-# CLEANFILES += ibus*
+
+clean-local:
+	rm -rf tmpl
+
+CLEANFILES+= *.stamp
+
+
diff --git a/docs/reference/ibus/ibus-docs.sgml b/docs/reference/ibus/ibus-docs.sgml
index 35d0bea2..043890cf 100644
--- a/docs/reference/ibus/ibus-docs.sgml
+++ b/docs/reference/ibus/ibus-docs.sgml
@@ -3,46 +3,76 @@
                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   <bookinfo>
-    <title>IBus Reference Manual</title>
+    <title>iBus Reference Manual</title>
     <releaseinfo>
-      for ibus 1.1.0
+      iBus 1.1.0 reference manual.
       The latest version of this documentation can be found on-line at
       <ulink role="online-location" url="http://code.google.com/p/ibus">http://code.google.com/p/ibus</ulink>.
     </releaseinfo>
   </bookinfo>
 
   <chapter>
-    <title>API Reference</title>
-    <xi:include href="xml/ibusfactory.xml"/>
-    <xi:include href="xml/ibusattribute.xml"/>
-    <xi:include href="xml/ibusinputcontext.xml"/>
-    <xi:include href="xml/ibusobservedpath.xml"/>
-    <xi:include href="xml/ibusengine.xml"/>
-    <xi:include href="xml/ibusservice.xml"/>
-    <xi:include href="xml/ibuslookuptable.xml"/>
-    <xi:include href="xml/ibusproxy.xml"/>
-    <xi:include href="xml/ibusserver.xml"/>
-    <xi:include href="xml/ibuscomponent.xml"/>
-    <xi:include href="xml/ibusconnection.xml"/>
-    <xi:include href="xml/ibusproperty.xml"/>
-    <xi:include href="xml/ibustext.xml"/>
-    <xi:include href="xml/ibusserializable.xml"/>
-    <xi:include href="xml/ibushotkey.xml"/>
-    <xi:include href="xml/ibusbus.xml"/>
-    <xi:include href="xml/ibusenginedesc.xml"/>
-    <xi:include href="xml/ibusobject.xml"/>
-    <xi:include href="xml/ibusconfig.xml"/>
-    <xi:include href="xml/ibusmessage.xml"/>
-    <xi:include href="xml/ibusdebug.xml"/>
-    <xi:include href="xml/ibusmarshalers.xml"/>
-    <xi:include href="xml/keyname-table.xml"/>
-    <xi:include href="xml/ibustypes.xml"/>
-    <xi:include href="xml/ibuserror.xml"/>
-    <xi:include href="xml/ibuspendingcall.xml"/>
-    <xi:include href="xml/ibuskeysyms.xml"/>
-    <xi:include href="xml/ibusenumtypes.xml"/>
-    <xi:include href="xml/ibusxml.xml"/>
-    <xi:include href="xml/ibusshare.xml"/>
-    <xi:include href="xml/ibusinternal.xml"/>
+      <title>API Overviews</title>
+      <para>The iBus API consists 3 parts:
+	  <emphasis>User interfaces</emphasis> for objects and services which
+	  are relateed to iBus UI such as language bar;
+          <emphasis>Input method engine</emphasis> for input method main logic and input/output handling;
+	  <emphasis>Configure</emphasis> for services for save, load and listening configures.
+      </para>
+  </chapter>
+  <chapter>
+      <title>User Interfaces</title>
+      <para>These APIs directly related to User interfaces, such as
+	  pre-edit buffer, auxiliary text, language bar, button,
+	  radio boxes, and so on.
+      </para>
+      <xi:include href="xml/ibusattribute.xml"/>
+      <xi:include href="xml/ibuslookuptable.xml"/>
+      <xi:include href="xml/ibusproperty.xml"/>
+      <xi:include href="xml/ibustext.xml"/>
+  </chapter>
+  <chapter>
+      <title>Input method engine</title>
+      <para>
+      </para>
+      <xi:include href="xml/ibusbus.xml"/>
+      <xi:include href="xml/ibuscomponent.xml"/>
+      <xi:include href="xml/ibusconnection.xml"/>
+      <xi:include href="xml/ibusengine.xml"/>
+      <xi:include href="xml/ibusenginedesc.xml"/>
+      <xi:include href="xml/ibusfactory.xml"/>
+      <xi:include href="xml/ibushotkey.xml"/>
+      <xi:include href="xml/ibuskeysyms.xml"/>
+  </chapter>
+  <chapter>
+      <title>Configure</title>
+      <para>
+      </para>
+      <xi:include href="xml/ibusconfig.xml"/>
+      <xi:include href="xml/ibusconfigservice.xml"/>
+      <xi:include href="xml/ibusxml.xml"/>
+  </chapter>
+  <chapter>
+      <title>Others</title>
+      <para>
+      </para>
+      <xi:include href="xml/ibusdebug.xml"/>
+      <xi:include href="xml/ibusenumtypes.xml"/>
+      <xi:include href="xml/ibuserror.xml"/>
+      <xi:include href="xml/ibusinputcontext.xml"/>
+      <xi:include href="xml/ibusinternal.xml"/>
+      <xi:include href="xml/ibusmarshalers.xml"/>
+      <xi:include href="xml/ibusmessage.xml"/>
+      <xi:include href="xml/ibusobject.xml"/>
+      <xi:include href="xml/ibusobservedpath.xml"/>
+      <xi:include href="xml/ibuspendingcall.xml"/>
+      <xi:include href="xml/ibusproxy.xml"/>
+      <xi:include href="xml/ibusserver.xml"/>
+      <xi:include href="xml/ibusservice.xml"/>
+      <xi:include href="xml/ibusserializable.xml"/>
+      <xi:include href="xml/ibusshare.xml"/>
+      <xi:include href="xml/ibustypes.xml"/>
+      <xi:include href="xml/keyname-table.xml"/>
   </chapter>
 </book>
+