[grilo] doc: grilo-libs documentation
- From: Victor Manuel Jaquez Leal <vjaquez src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [grilo] doc: grilo-libs documentation
- Date: Fri, 17 Dec 2010 14:44:17 +0000 (UTC)
commit 0f0cd9f36226e8f9f5f2ca3db8c4b0a6c81c64b1
Author: VÃctor Manuel Jáquez Leal <vjaquez igalia com>
Date: Wed Dec 15 12:18:20 2010 +0100
doc: grilo-libs documentation
Signed-off-by: VÃctor Manuel Jáquez Leal <vjaquez igalia com>
https://bugzilla.gnome.org/show_bug.cgi?id=636414
configure.ac | 1 +
doc/Makefile.am | 2 +-
doc/libs/Makefile.am | 105 ++++++++++++++++++++++++++++++++++++++
doc/libs/grilo-libs-docs.sgml | 51 ++++++++++++++++++
doc/libs/grilo-libs-sections.txt | 26 +++++++++
5 files changed, 184 insertions(+), 1 deletions(-)
---
diff --git a/configure.ac b/configure.ac
index 520fbcc..3c6de1d 100644
--- a/configure.ac
+++ b/configure.ac
@@ -248,6 +248,7 @@ AC_CONFIG_FILES([
bindings/vala/grilo-net-uninstalled.namespace
doc/Makefile
doc/grilo/Makefile
+ doc/libs/Makefile
])
AC_OUTPUT
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 6874180..5ff0020 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -5,4 +5,4 @@
#
# Copyright (C) 2010 Igalia S.L. All rights reserved.
-SUBDIRS = grilo
+SUBDIRS = grilo libs
diff --git a/doc/libs/Makefile.am b/doc/libs/Makefile.am
new file mode 100644
index 0000000..a07179f
--- /dev/null
+++ b/doc/libs/Makefile.am
@@ -0,0 +1,105 @@
+## Process this file with automake to produce Makefile.in
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# This is a blank Makefile.am for using gtk-doc.
+# Copy this to your project's API docs directory and modify the variables to
+# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
+# of using the various options.
+
+# The name of the module, e.g. 'glib'.
+DOC_MODULE=grilo-libs
+
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+#DOC_MODULE_VERSION=2
+
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# The directory containing the source code. Relative to $(srcdir).
+# gtk-doc will search all .c & .h files beneath here for inline comments
+# documenting the functions and macros.
+# e.g. DOC_SOURCE_DIR=../../../gtk
+DOC_SOURCE_DIR=$(top_srcdir)/libs
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS=
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCAN_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-mktmpl
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+MKTMPL_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkhtml
+MKHTML_OPTIONS=
+
+# Extra options to supply to gtkdoc-fixref. Not normally needed.
+# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
+FIXXREF_OPTIONS=--extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html
+
+# 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=$(DOC_SOURCE_DIR)/*/*.h
+CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.c
+
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+EXTRA_HFILES=
+
+# Header files to ignore when scanning. Use base file name, no paths
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES=
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+HTML_IMAGES=
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
+content_files=
+
+# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# These files must be listed here *and* in content_files
+# e.g. expand_content_files=running.sgml
+expand_content_files=
+
+# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
+# Only needed if you are using gtkdoc-scangobj to dynamically query widget
+# signals and properties.
+# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_srcdir)/libs $(DEPS_CFLAGS)
+GTKDOC_LIBS=\
+ $(top_builddir)/src/lib GRL_NAME@.la \
+ $(top_builddir)/libs/net/libgrlnet- GRL_MAJORMINOR@.la \
+ $(DEPS_LIBS)
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+# e.g. EXTRA_DIST += version.xml.in
+EXTRA_DIST +=
+
+# Files not to distribute
+# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
+# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
+#DISTCLEANFILES +=
+
+# Comment this out if you want your docs-status tested during 'make check'
+if ENABLE_GTK_DOC
+#TESTS_ENVIRONMENT = cd $(srcsrc) &&
+#TESTS = $(GTKDOC_CHECK)
+endif
+
+-include $(top_srcdir)/git.mk
diff --git a/doc/libs/grilo-libs-docs.sgml b/doc/libs/grilo-libs-docs.sgml
new file mode 100644
index 0000000..8b15c16
--- /dev/null
+++ b/doc/libs/grilo-libs-docs.sgml
@@ -0,0 +1,51 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
+<book id="index">
+ <bookinfo>
+ <title>Grilo Library Reference Manual</title>
+ <releaseinfo>
+ for Grilo Library.
+ The latest version of this documentation can be found on-line at
+ <ulink role="online-location" url="http://git.gnome.org/browse/grilo">http://git.gnome.org/browse/grilo</ulink>
+ and
+ <ulink role="online-location" url="http://git.gnome.org/browse/grilo-plugins">http://git.gnome.org/browse/grilo</ulink>
+ </releaseinfo>
+ </bookinfo>
+ <part id="grilo-libs">
+ <title>Grilo Libraries</title>
+
+ <para>
+ To ease the creation of plugins, a library system was created. The most common
+ functions for a plugin can be found in a library.
+ </para>
+ <para>
+ Grilo provides some standard libraries you can use to create plugins.
+ </para>
+
+ <chapter id="grilo-net">
+ <title>Grilo Net Classes</title>
+ <xi:include href="xml/grl-net-wc.xml"/>
+ </chapter>
+
+ <chapter id="object-tree">
+ <title>Object Hierarchy</title>
+ <xi:include href="xml/tree_index.sgml"/>
+ </chapter>
+ </part>
+
+ <index id="api-index-full">
+ <title>API Index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </index>
+
+ <index id="deprecated-api-index" role="deprecated">
+ <title>Index of deprecated API</title>
+ <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+ </index>
+
+ <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>
diff --git a/doc/libs/grilo-libs-sections.txt b/doc/libs/grilo-libs-sections.txt
new file mode 100644
index 0000000..03ca2ff
--- /dev/null
+++ b/doc/libs/grilo-libs-sections.txt
@@ -0,0 +1,26 @@
+<SECTION>
+<FILE>grl-net-wc</FILE>
+<TITLE>GrlNetWc</TITLE>
+GrlNetWcError
+GrlNetWc
+GrlNetWcClass
+grl_net_wc_new
+grl_net_wc_request_async
+grl_net_wc_request_finish
+grl_net_wc_set_log_level
+grl_net_wc_set_throttling
+grl_net_wc_flush_delayed_requests
+<SUBSECTION Standard>
+GRL_NET_WC
+GRL_IS_NET_WC
+GRL_TYPE_NET_WC
+grl_net_wc_get_type
+GRL_NET_WC_CLASS
+GRL_IS_NET_WC_CLASS
+GRL_NET_WC_GET_CLASS
+</SECTION>
+<SUBSECTION Private>
+GRL_NET_WC_ERROR
+GrlNetWcPrivate
+grl_net_wc_error_quark
+</SECTION>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]