s3rius/squeekboard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add doc.

Browse Source
This commit is contained in:
Daiki Ueno
2011-02-23 05:14:14 +09:00
parent 2c067482de
commit caf105cbd9
6 changed files with 245 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/reference/eek/eek-docs.sgml
View File

@ -8,15 +8,15 @@
<bookinfo>
<title>libeek Reference Manual</title>
<releaseinfo>
for libeek 0.0.5.
for libeek 0.90.0.
</releaseinfo>
<copyright>
<year>2010</year>
<year>2010-2011</year>
<holder>Daiki Ueno</holder>
</copyright>
<copyright>
<year>2010</year>
<year>2010-2011</year>
<holder>Red Hat, Inc.</holder>
</copyright>

2
docs/reference/eekboard/Makefile.am
View File

@ -97,7 +97,7 @@ HTML_IMAGES=
# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
GTKDOC_CFLAGS = $(GIO2_CFLAGS)
GTKDOC_LIBS = $(top_builddir)/eekboard/libeekboard.la
GTKDOC_LIBS = $(top_builddir)/eekboard/libeekboard.la $(GIO2_LIBS)
# This includes the standard gtk-doc make rules, copied by gtkdocize.
include $(top_srcdir)/gtk-doc.make

55
docs/reference/eekboard/eekboard-docs.sgml
View File

@ -8,25 +8,44 @@
<bookinfo>
<title>eekboard Reference Manual</title>
<releaseinfo>
for eekboard [VERSION].
The latest version of this documentation can be found on-line at
<ulink role="online-location" url="http://[SERVER]/eekboard/index.html">http://[SERVER]/eekboard/</ulink>.
for eekboard 0.90.0.
</releaseinfo>
<copyright>
<year>2011</year>
<holder>Daiki Ueno</holder>
</copyright>
<copyright>
<year>2011</year>
<holder>Red Hat, Inc.</holder>
</copyright>
<legalnotice>
<para>
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License,
Version 1.3 or any later version published by the Free Software
Foundation; with no Invariant Sections, no Front-Cover Texts and
no Back-Cover Texts. A copy of the license is included in the
section entitled "GNU Free Documentation License".
</para>
</legalnotice>
</bookinfo>
<chapter>
<title>[Insert title here]</title>
<xi:include href="xml/eekboard-proxy.xml"/>
</chapter>
<chapter id="object-tree">
<title>Object Hierarchy</title>
<xi:include href="xml/tree_index.sgml"/>
</chapter>
<index id="api-index-full">
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
<part id="apireference">
<title>API Manual</title>
<chapter>
<title>D-Bus proxy to eekboard-server</title>
<xi:include href="xml/eekboard-server.xml"/>
<xi:include href="xml/eekboard-context.xml"/>
</chapter>
<chapter id="object-tree">
<title>Object Hierarchy</title>
<xi:include href="xml/tree_index.sgml"/>
</chapter>
<index id="api-index-full">
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
</part>
</book>

59
docs/reference/eekboard/eekboard-sections.txt
View File

@ -1,20 +1,47 @@
<SECTION>
<FILE>eekboard-proxy</FILE>
EekboardProxy
EekboardProxyClass
eekboard_proxy_new
eekboard_proxy_set_keyboard
eekboard_proxy_set_group
eekboard_proxy_show
eekboard_proxy_hide
eekboard_proxy_press_key
eekboard_proxy_release_key
<FILE>eekboard-server</FILE>
<TITLE>EekboardServer</TITLE>
EekboardServer
EekboardServerClass
EekboardServerPrivate
eekboard_server_new
eekboard_server_create_context
eekboard_server_push_context
eekboard_server_pop_context
eekboard_server_destroy_context
<SUBSECTION Standard>
EEKBOARD_PROXY
EEKBOARD_IS_PROXY
EEKBOARD_TYPE_PROXY
EEKBOARD_PROXY_CLASS
EEKBOARD_IS_PROXY_CLASS
EEKBOARD_PROXY_GET_CLASS
EEKBOARD_SERVER
EEKBOARD_IS_SERVER
EEKBOARD_TYPE_SERVER
eekboard_server_get_type
EEKBOARD_SERVER_CLASS
EEKBOARD_IS_SERVER_CLASS
EEKBOARD_SERVER_GET_CLASS
</SECTION>
<SECTION>
<FILE>eekboard-context</FILE>
<TITLE>EekboardContext</TITLE>
EekboardContext
EekboardContextClass
EekboardContextPrivate
eekboard_context_new
eekboard_context_set_keyboard
eekboard_context_show_keyboard
eekboard_context_hide_keyboard
eekboard_context_set_group
eekboard_context_press_key
eekboard_context_release_key
eekboard_context_is_keyboard_visible
eekboard_context_set_enabled
eekboard_context_is_enabled
<SUBSECTION Standard>
EEKBOARD_CONTEXT
EEKBOARD_IS_CONTEXT
EEKBOARD_TYPE_CONTEXT
eekboard_context_get_type
EEKBOARD_CONTEXT_CLASS
EEKBOARD_IS_CONTEXT_CLASS
EEKBOARD_CONTEXT_GET_CLASS
</SECTION>