diff options
author | Peng Huang <shawn.p.huang@gmail.com> | 2009-12-14 16:41:37 +0800 |
---|---|---|
committer | Peng Huang <shawn.p.huang@gmail.com> | 2009-12-14 16:41:37 +0800 |
commit | f20212a9c7444aa5835f542620352d04f44beaac (patch) | |
tree | a6de9d2b7a2f8188156d1aa7aacea5c9f542a3a2 /docs | |
parent | 7645a2f493a84fd01c4e3ca394a0b4cb0272ffd9 (diff) | |
parent | abac005cc73683ecf638b33fb30ebaec4e6d82d1 (diff) | |
download | ibus-f20212a9c7444aa5835f542620352d04f44beaac.tar.gz |
Merge remote branch 'definite/master'
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/ibus/Makefile.am | 16 | ||||
-rw-r--r-- | docs/reference/ibus/ibus-docs.sgml | 43 | ||||
-rw-r--r-- | docs/reference/ibus/ibus.types | 47 |
3 files changed, 57 insertions, 49 deletions
diff --git a/docs/reference/ibus/Makefile.am b/docs/reference/ibus/Makefile.am index 10e647aa..0f25e3eb 100644 --- a/docs/reference/ibus/Makefile.am +++ b/docs/reference/ibus/Makefile.am @@ -47,7 +47,7 @@ CFILE_GLOB=$(top_srcdir)/src/*.c # Header files to ignore when scanning. # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h -IGNORE_HFILES= +IGNORE_HFILES= ibusconfigprivate.h # Images to copy into HTML directory. # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png @@ -98,18 +98,14 @@ DISTCLEANFILES = $(DOC_MODULE)-sections.txt # Comment this out if you want your docs-status tested during 'make check' #TESTS = $(GTKDOC_CHECK) -# trim-sections.txt: $(DOC_MODULE)-sections.txt -# cp $(DOC_MODULE)-sections.txt $(DOC_MODULE)-sections.txt.old -# sed '/<TITLE>IBusAttrList<\/TITLE>/d' $(DOC_MODULE)-sections.txt.old > $(DOC_MODULE)-sections.txt -# cp $(DOC_MODULE)-sections.txt $(DOC_MODULE)-sections.txt.old -# sed '/<TITLE>IBusPropList<\/TITLE>/d' $(DOC_MODULE)-sections.txt.old > $(DOC_MODULE)-sections.txt -# cp $(DOC_MODULE)-sections.txt $(DOC_MODULE)-sections.txt.old -# sed '/<TITLE>IBusFactoryInfo<\/TITLE>/d' $(DOC_MODULE)-sections.txt.old > $(DOC_MODULE)-sections.txt - trim-build.stamp: scan-build.stamp sed "/<TITLE>IBusAttrList<\/TITLE>/d; \ /<TITLE>IBusPropList<\/TITLE>/d; \ - /<TITLE>IBusFactoryInfo<\/TITLE>/d" \ + /<TITLE>IBusFactoryInfo<\/TITLE>/d; \ + /IBusObjectFlags/d;\ + /IBUS_OBJECT_FLAGS/d;\ + /IBUS_OBJECT_SET_FLAGS/d;\ + /IBUS_OBJECT_UNSET_FLAGS/d" \ -i.bak $(srcdir)/$(DOC_MODULE)-sections.txt $(RM) $(srcdir)/$(DOC_MODULE)-sections.txt.bak touch trim-build.stamp diff --git a/docs/reference/ibus/ibus-docs.sgml b/docs/reference/ibus/ibus-docs.sgml index c001b447..0f0bb568 100644 --- a/docs/reference/ibus/ibus-docs.sgml +++ b/docs/reference/ibus/ibus-docs.sgml @@ -18,7 +18,7 @@ so you may find that modules are named as classes and objects in the sense of GObject, and may D-Bus wrapper API.</para> - <para>According to the puroposes of modules, we categorized them into 4 parts:</para> + <para>According to the puroposes of modules, we categorized them into following parts:</para> <variablelist> <varlistentry> <term>Panel</term> @@ -32,16 +32,21 @@ such as engine specification, and class abstracts.</para></listitem> </varlistentry> <varlistentry> - <term>Communication and Configuration</term> - <listitem><para>Here lists the service communication functions and - functions that handling configuration like save, load, and listening.</para></listitem> + <term>Configuration</term> + <listitem><para>This part lists functions for configuring IBus and engines. + Since most configuration files are in XML format, + XML handling functions are also listed here.</para></listitem> + </varlistentry> + <varlistentry> + <term>Communication</term> + <listitem><para>Here lists the service communication functions.</para></listitem> </varlistentry> <varlistentry> <term>Internal</term> - <listitem><para>Definition and functions for IBus internal use..</para></listitem> + <listitem><para>Definition and functions for IBus internal use.</para></listitem> </varlistentry> </variablelist> - <para>Normally input method developers need only to read the first 2 parts and IBusConfig from the 3rd part. + <para>Normally input method developers need only to read the first three parts. </para> </chapter> <chapter> @@ -53,6 +58,7 @@ <xi:include href="xml/ibusattribute.xml"/> <xi:include href="xml/ibushotkey.xml"/> <xi:include href="xml/ibuslookuptable.xml"/> + <xi:include href="xml/ibuspanelservice.xml"/> <xi:include href="xml/ibusproperty.xml"/> <xi:include href="xml/ibustext.xml"/> </chapter> @@ -70,37 +76,40 @@ <xi:include href="xml/ibuskeysyms.xml"/> </chapter> <chapter> - <title>Communication and Configuration</title> - <para>Here lists the service communication functions and - functions that handling configuration like save, load, and listening.</para> - <xi:include href="xml/ibusbus.xml"/> + <title>Configuration</title> + <para>This part lists functions for configuring IBus and engines. + Since most configuration files are in XML format, + XML handling functions are also listed here.</para> <xi:include href="xml/ibusconfig.xml"/> <xi:include href="xml/ibusconfigservice.xml"/> + <xi:include href="xml/ibusobservedpath.xml"/> + <xi:include href="xml/ibusversion.xml"/> + <xi:include href="xml/ibusxml.xml"/> + </chapter> + <chapter> + <title>Communication</title> + <para>Here lists the service communication functions.</para> + <xi:include href="xml/ibusbus.xml"/> <xi:include href="xml/ibusconnection.xml"/> - <xi:include href="xml/ibusmainloop.xml"/> <xi:include href="xml/ibusmessage.xml"/> - <xi:include href="xml/ibusobservedpath.xml"/> <xi:include href="xml/ibuspendingcall.xml"/> <xi:include href="xml/ibusproxy.xml"/> <xi:include href="xml/ibusserializable.xml"/> <xi:include href="xml/ibusservice.xml"/> - <xi:include href="xml/ibusxml.xml"/> </chapter> <chapter> <title>Internal</title> - <para> - </para> + <para>Definition and functions for IBus internal use.</para> <xi:include href="xml/ibusdebug.xml"/> <xi:include href="xml/ibusenumtypes.xml"/> <xi:include href="xml/ibuserror.xml"/> <xi:include href="xml/ibusinternal.xml"/> + <xi:include href="xml/ibusmainloop.xml"/> <xi:include href="xml/ibusmarshalers.xml"/> <xi:include href="xml/ibusobject.xml"/> <xi:include href="xml/ibusserver.xml"/> <xi:include href="xml/ibusshare.xml"/> <xi:include href="xml/ibustypes.xml"/> - <xi:include href="xml/ibusversion.xml"/> - <xi:include href="xml/keyname-table.xml"/> </chapter> </book> diff --git a/docs/reference/ibus/ibus.types b/docs/reference/ibus/ibus.types index f75742f3..bb6c5395 100644 --- a/docs/reference/ibus/ibus.types +++ b/docs/reference/ibus/ibus.types @@ -1,30 +1,33 @@ -ibus_attr_list_get_type +ibus_connection_get_type +ibus_hotkey_profile_get_type +ibus_object_get_type +ibus_config_get_type +ibus_bus_get_type +ibus_proxy_get_type +ibus_object_flags_get_type ibus_attr_type_get_type ibus_attr_underline_get_type -ibus_attribute_get_type -ibus_bus_get_type +ibus_prop_type_get_type +ibus_prop_state_get_type +ibus_modifier_type_get_type ibus_capabilite_get_type -ibus_component_get_type -ibus_config_get_type +ibus_orientation_get_type +ibus_service_get_type +ibus_factory_get_type +ibus_factory_info_get_type +ibus_text_get_type ibus_config_service_get_type -ibus_connection_get_type +ibus_server_get_type +ibus_attribute_get_type +ibus_attr_list_get_type ibus_engine_desc_get_type +ibus_lookup_table_get_type +ibus_serializable_get_type +ibus_keymap_get_type ibus_engine_get_type -ibus_factory_get_type -ibus_factory_info_get_type -ibus_hotkey_profile_get_type +ibus_component_get_type +ibus_panel_service_get_type +ibus_property_get_type +ibus_prop_list_get_type ibus_input_context_get_type -ibus_lookup_table_get_type -ibus_modifier_type_get_type -ibus_object_flags_get_type -ibus_object_get_type ibus_observed_path_get_type -ibus_prop_list_get_type -ibus_prop_state_get_type -ibus_prop_type_get_type -ibus_property_get_type -ibus_proxy_get_type -ibus_serializable_get_type -ibus_server_get_type -ibus_service_get_type -ibus_text_get_type |