diff options
author | Ryan Lortie <desrt@desrt.ca> | 2010-06-10 23:03:47 -0400 |
---|---|---|
committer | Ryan Lortie <desrt@desrt.ca> | 2010-06-10 23:03:47 -0400 |
commit | b9f4d55aa7e67a581257bcd703923595cbbb303b (patch) | |
tree | 5ecdb2c56f06544c102589f16701124a22fe7fdb /docs | |
parent | 70281f0ccc8111b9047594f62172d04f5864a1f6 (diff) | |
download | dconf-b9f4d55aa7e67a581257bcd703923595cbbb303b.tar.gz |
Setup initial gtk-doc
Diffstat (limited to 'docs')
-rw-r--r-- | docs/.gitignore | 17 | ||||
-rw-r--r-- | docs/Makefile.am | 14 | ||||
-rw-r--r-- | docs/dconf-docs.xml | 29 | ||||
-rw-r--r-- | docs/dconf-sections.txt | 44 | ||||
-rw-r--r-- | docs/dconf.types | 1 | ||||
l--------- | docs/sources/client | 1 | ||||
l--------- | docs/sources/common | 1 |
7 files changed, 107 insertions, 0 deletions
diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..c5b7af4 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,17 @@ +*-decl-list.txt +*-decl.txt +*-overrides.txt +*-unused.txt +*-undocumented.txt +*-undeclared.txt +*.args +*.hierarchy +*.interfaces +*.prerequisites +*.signals +*.stamp +html +xml +*.bak +version.xml +gtk-doc.make diff --git a/docs/Makefile.am b/docs/Makefile.am new file mode 100644 index 0000000..b054d89 --- /dev/null +++ b/docs/Makefile.am @@ -0,0 +1,14 @@ +include gtk-doc.make + +DOC_MODULE = dconf + +DOC_MAIN_SGML_FILE = dconf-docs.xml + +DOC_SOURCE_DIR = sources + +MKDB_OPTIONS = --output-format=xml + +INCLUDES = $(gio_CFLAGS) +GTKDOC_LIBS = $(gio_LIBS) ../client/libdconf.la + + diff --git a/docs/dconf-docs.xml b/docs/dconf-docs.xml new file mode 100644 index 0000000..4a8745c --- /dev/null +++ b/docs/dconf-docs.xml @@ -0,0 +1,29 @@ +<?xml version='1.0'?> + +<book id='index' xmlns:xi='http://www.w3.org/2001/XInclude'> + <bookinfo> + <title>dconf Reference Manual</title> + <releaseinfo> + The latest version of this documentation can be found on-line at + <ulink role='online-location' url='http://library.gnome.org/devel/dconf/unstable/'>http://library.gnome.org/devel/dconf/unstable/</ulink>. + </releaseinfo> + </bookinfo> + + <chapter> + <title>DConf Client API</title> + <xi:include href='xml/paths.xml'/> + <xi:include href='xml/dconf-client.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> +</book> diff --git a/docs/dconf-sections.txt b/docs/dconf-sections.txt new file mode 100644 index 0000000..d26085a --- /dev/null +++ b/docs/dconf-sections.txt @@ -0,0 +1,44 @@ +<SECTION> +<FILE>dconf-client</FILE> +DConfClientClass +DConfClient +DConfWatchFunc +dconf_client_new +dconf_client_new_async +dconf_client_new_finish +dconf_client_read +dconf_client_read_default +dconf_client_read_no_default +dconf_client_list +dconf_client_is_writable +dconf_client_write +dconf_client_write_async +dconf_client_write_finish +dconf_client_set_locked +dconf_client_set_locked_async +dconf_client_set_locked_finish +dconf_client_write_many +dconf_client_write_many_async +dconf_client_write_many_finish +dconf_client_watch +dconf_client_watch_async +dconf_client_watch_finish +dconf_client_unwatch +dconf_client_unwatch_async +dconf_client_unwatch_finish +<SUBSECTION Standard> +DCONF_CLIENT +DCONF_IS_CLIENT +DCONF_TYPE_CLIENT +dconf_client_get_type +</SECTION> + +<SECTION> +<FILE>paths</FILE> +dconf_is_dir +dconf_is_key +dconf_is_path +dconf_is_rel +dconf_is_rel_dir +dconf_is_rel_key +</SECTION> diff --git a/docs/dconf.types b/docs/dconf.types new file mode 100644 index 0000000..36554ba --- /dev/null +++ b/docs/dconf.types @@ -0,0 +1 @@ +dconf_client_get_type diff --git a/docs/sources/client b/docs/sources/client new file mode 120000 index 0000000..96cd109 --- /dev/null +++ b/docs/sources/client @@ -0,0 +1 @@ +../../client
\ No newline at end of file diff --git a/docs/sources/common b/docs/sources/common new file mode 120000 index 0000000..dc879ab --- /dev/null +++ b/docs/sources/common @@ -0,0 +1 @@ +../../common
\ No newline at end of file |