diff options
author | Jens Georg <mail@jensge.org> | 2016-04-16 01:22:53 +0200 |
---|---|---|
committer | Jens Georg <mail@jensge.org> | 2016-04-16 18:09:53 +0200 |
commit | 5528e5c59e259b53b1d10b68a9e8df8a17ba3173 (patch) | |
tree | 596be72755c2fcc9c04ab9aedf3de01d8ab7b29c | |
parent | 750578e68743f504e3cf4541f511eba35cb9cea5 (diff) | |
download | rygel-5528e5c59e259b53b1d10b68a9e8df8a17ba3173.tar.gz |
doc: Add librygel-db to apidocs
Signed-off-by: Jens Georg <mail@jensge.org>
-rw-r--r-- | configure.ac | 1 | ||||
-rw-r--r-- | doc/reference/Makefile.am | 2 | ||||
-rw-r--r-- | doc/reference/librygel-db/Makefile.am | 26 | ||||
-rw-r--r-- | doc/reference/librygel-db/gtkdoc/librygel-db-docs.xml | 48 | ||||
-rw-r--r-- | doc/reference/librygel-db/gtkdoc/overview.xml | 62 | ||||
-rw-r--r-- | src/librygel-db/database-cursor.vala | 2 | ||||
-rw-r--r-- | src/librygel-db/database.vala | 10 |
7 files changed, 144 insertions, 7 deletions
diff --git a/configure.ac b/configure.ac index 6f8bc215..0cae3911 100644 --- a/configure.ac +++ b/configure.ac @@ -525,6 +525,7 @@ data/icons/scalable/Makefile doc/Makefile doc/reference/Makefile doc/reference/librygel-core/Makefile +doc/reference/librygel-db/Makefile doc/reference/librygel-renderer/Makefile doc/reference/librygel-server/Makefile doc/reference/librygel-renderer-gst/Makefile diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am index 66fbb692..0acd3572 100644 --- a/doc/reference/Makefile.am +++ b/doc/reference/Makefile.am @@ -1,4 +1,4 @@ -SUBDIRS = librygel-core librygel-renderer librygel-server +SUBDIRS = librygel-core librygel-renderer librygel-server librygel-db if HAVE_GSTREAMER SUBDIRS += librygel-renderer-gst diff --git a/doc/reference/librygel-db/Makefile.am b/doc/reference/librygel-db/Makefile.am new file mode 100644 index 00000000..d4af81f4 --- /dev/null +++ b/doc/reference/librygel-db/Makefile.am @@ -0,0 +1,26 @@ +RYGEL_DOCBUILD_MODULE = rygel-db +if ENABLE_VALADOC + +include $(top_srcdir)/common.am +include $(top_srcdir)/src/librygel-db/filelist.am + +# Note that LIBRYGEL_DB_NONVAPI_SOURCE_FILES all (should) use the internal keyword +# so they are not shown as part of the public API. +VALA_SOURCE_FILES = $(LIBRYGEL_DB_VAPI_SOURCE_FILES) \ + $(LIBRYGEL_DB_NONVAPI_SOURCE_FILES) + +VALA_SOURCE_FILES_WITH_PATHS = $(addprefix $(top_srcdir)/src/librygel-db/, $(VALA_SOURCE_FILES)) + +RYGEL_DOCBUILD_VALADOC_FLAGS = \ + $(LIBRYGEL_DB_DEPS_VALAFLAGS) \ + $(RYGEL_COMMON_LIBRYGEL_CORE_VALAFLAGS) \ + $(RYGEL_COMMON_BUILD_CONFIG_VALAFLAGS) + + +RYGEL_DOCBUILD_EXTRA_GTKDOC_OPTIONS = +endif + +include $(top_srcdir)/doc/reference/doc-build.am + + + diff --git a/doc/reference/librygel-db/gtkdoc/librygel-db-docs.xml b/doc/reference/librygel-db/gtkdoc/librygel-db-docs.xml new file mode 100644 index 00000000..53301064 --- /dev/null +++ b/doc/reference/librygel-db/gtkdoc/librygel-db-docs.xml @@ -0,0 +1,48 @@ +<?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>librygel-db Reference Manual</title> + <releaseinfo> + for librygel-db 2.0. + The latest version of this documentation can be found on-line at + <ulink role="online-location" url="http://developer.gnome.org/librygel-db/index.html">http://developer.gnome.org/librygel-db/</ulink>. + </releaseinfo> + </bookinfo> + + <!-- This is hand written: --> + <preface id="overview"> + <title>Overview</title> + <xi:include href="overview.xml"/> + </preface> + + <!-- These are generated: --> + <chapter id="api-main-list-c"> + <title>librygel-db API Reference</title> + <xi:include href="xml/sql-function.xml"/> + <xi:include href="xml/database-cursor.xml"/> + <xi:include href="xml/database.xml"/> + <xi:include href="xml/sql-operator.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> + + <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/reference/librygel-db/gtkdoc/overview.xml b/doc/reference/librygel-db/gtkdoc/overview.xml new file mode 100644 index 00000000..0a826355 --- /dev/null +++ b/doc/reference/librygel-db/gtkdoc/overview.xml @@ -0,0 +1,62 @@ +<?xml version="1.0"?> +<!DOCTYPE refentry 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'"> +]> + +<section id="overview"> + +<para> +librygel-db is part of the <ulink url="http://rygel-project.org/">Rygel</ulink> project. +</para> + +<para> +librygel-db is a small wrapper around SQLite3 used in several plugin implementations. +</para> + +<para> +librygel-db is licensed under the GNU Lesser General Public License (LGPL). +</para> + +<sect1> +<title>Basic Usage</title> +<para> +Include the header: +</para> +<para> +<programlisting> +#include <rygel-db.h> +</programlisting> +</para> + +<para> +If your source file is program.c, you can compile it with: +</para> +<para> +<command> +gcc program.cc -o program `pkg-config --cflags --libs rygel-db-2.6` +</command> +</para> + +<para> +Alternatively, if using autoconf, use the following in configure.ac: +</para> +<para> +<programlisting> +PKG_CHECK_MODULES([DEPS], [rygel-db-2.6]) +</programlisting> +</para> + +<para> +Then use the generated DEPS_CFLAGS and DEPS_LIBS variables in the project Makefile.am files. For example: +</para> +<para> +<programlisting> +program_CPPFLAGS = $(DEPS_CFLAGS) +program_LDADD = $(DEPS_LIBS) +</programlisting> +</para> + +</sect1> + +</section> diff --git a/src/librygel-db/database-cursor.vala b/src/librygel-db/database-cursor.vala index 8b717c13..682f7cfc 100644 --- a/src/librygel-db/database-cursor.vala +++ b/src/librygel-db/database-cursor.vala @@ -63,7 +63,7 @@ public class Rygel.Database.Cursor : Object { * which _bind function to use. * * Supported types are: int, long, int64, uint64, string and pointer. - * @note the only pointer supported is the null pointer as provided by + * Note: The only pointer supported is the null pointer as provided by * Database.@null. This is a special value to bind a column to NULL * @param arguments array of values to bind to the SQL statement or null if * none diff --git a/src/librygel-db/database.vala b/src/librygel-db/database.vala index 77b05762..0be02570 100644 --- a/src/librygel-db/database.vala +++ b/src/librygel-db/database.vala @@ -144,9 +144,9 @@ public class Rygel.Database.Database : Object, Initable { /** * Connect to a SQLite database file * - * @param name: Name of the database which is used to create the file-name - * @param flavor: Specifies the flavor of the database - * @param flags: How to open the database + * @param name Name of the database which is used to create the file-name + * @param flavor Specifies the flavor of the database + * @param flags How to open the database */ public Database (string name, Flavor flavor = Flavor.CACHE, @@ -222,7 +222,7 @@ public class Rygel.Database.Database : Object, Initable { * Use for all queries that return a result set. * * @param sql The SQL query to run. - * @param args Values to bind in the SQL query or null. + * @param arguments Values to bind in the SQL query or null. * @throws DatabaseError if the underlying SQLite operation fails. */ public Cursor exec_cursor (string sql, @@ -237,7 +237,7 @@ public class Rygel.Database.Database : Object, Initable { * Use for all queries that don't return anything. * * @param sql The SQL query to run. - * @param args Values to bind in the SQL query or null. + * @param arguments Values to bind in the SQL query or null. * @throws DatabaseError if the underlying SQLite operation fails. */ public void exec (string sql, |