GNOME.org
 

[gupnp-dlna/wip/new-api: 44/46] Add documentation for GStreamer specific API of GUPnP-DLNA.

commit 7fc2b019f21dd9de8b1b2756e46ace9a6bb56257
Author: Krzesimir Nowak <krnowak openismus com>
Date:   Mon Jan 7 12:06:18 2013 +0100

    Add documentation for GStreamer specific API of GUPnP-DLNA.

 .gitignore                                         |   15 +++
 configure.ac                                       |    1 +
 doc/Makefile.am                                    |    9 ++-
 doc/gupnp-dlna-gst/Makefile.am                     |   91 ++++++++++++++++++++
 doc/gupnp-dlna-gst/gupnp-dlna-gst-docs.sgml        |   53 +++++++++++
 .../gstreamer/gupnp-dlna-gst-metadata-extractor.c  |   20 -----
 6 files changed, 168 insertions(+), 21 deletions(-)
---
diff --git a/.gitignore b/.gitignore
index f197af0..da6d5ed 100644
--- a/.gitignore
+++ b/.gitignore
@@ -42,6 +42,21 @@ doc/gupnp-dlna-metadata/gupnp-dlna-metadata.signals
 doc/gupnp-dlna-metadata/gupnp-dlna-metadata.types
 doc/gupnp-dlna-metadata/html/
 doc/gupnp-dlna-metadata/xml/
+doc/gupnp-dlna-gst/gupnp-dlna-gst-decl-list.txt
+doc/gupnp-dlna-gst/gupnp-dlna-gst-decl.txt
+doc/gupnp-dlna-gst/gupnp-dlna-gst-overrides.txt
+doc/gupnp-dlna-gst/gupnp-dlna-gst-sections.txt
+doc/gupnp-dlna-gst/gupnp-dlna-gst-undeclared.txt
+doc/gupnp-dlna-gst/gupnp-dlna-gst-undocumented.txt
+doc/gupnp-dlna-gst/gupnp-dlna-gst-unused.txt
+doc/gupnp-dlna-gst/gupnp-dlna-gst.args
+doc/gupnp-dlna-gst/gupnp-dlna-gst.hierarchy
+doc/gupnp-dlna-gst/gupnp-dlna-gst.interfaces
+doc/gupnp-dlna-gst/gupnp-dlna-gst.prerequisites
+doc/gupnp-dlna-gst/gupnp-dlna-gst.signals
+doc/gupnp-dlna-gst/gupnp-dlna-gst.types
+doc/gupnp-dlna-gst/html/
+doc/gupnp-dlna-gst/xml/
 m4/gtk-doc.m4
 m4/libtool.m4
 m4/ltoptions.m4
diff --git a/configure.ac b/configure.ac
index ef6a3d3..97c72ef 100644
--- a/configure.ac
+++ b/configure.ac
@@ -205,6 +205,7 @@ doc/Makefile
 doc/version.xml
 doc/gupnp-dlna/Makefile
 doc/gupnp-dlna-metadata/Makefile
+doc/gupnp-dlna-gst/Makefile
 vala/Makefile
 ])
 AC_CONFIG_FILES([tests/test-discoverer.sh],
diff --git a/doc/Makefile.am b/doc/Makefile.am
index eb91538..192859d 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,3 +1,10 @@
-SUBDIRS = gupnp-dlna gupnp-dlna-metadata .
+DIST_SUBDIRS = gupnp-dlna gupnp-dlna-metadata gupnp-dlna-gst .
+SUBDIRS = gupnp-dlna gupnp-dlna-metadata
+
+if GSTREAMER_METADATA_BACKEND_ENABLED
+SUBDIRS += gupnp-dlna-gst
+endif
+
+SUBDIRS += .
 
 EXTRA_DIST = version.xml.in
diff --git a/doc/gupnp-dlna-gst/Makefile.am b/doc/gupnp-dlna-gst/Makefile.am
new file mode 100644
index 0000000..3509b34
--- /dev/null
+++ b/doc/gupnp-dlna-gst/Makefile.am
@@ -0,0 +1,91 @@
+## 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=gupnp-dlna-gst
+
+# 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=$(srcdir)/../../libgupnp-dlna/metadata-backends/gstreamer
+
+# 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=--deprecated-guards="GUPNP_DISABLE_DEPRECATED"
+
+# 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-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/gst-plugins-base-libs-1.0 \
+	--extra-dir=../gupnp-dlna/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=$(top_srcdir)/libgupnp-dlna/metadata-backends/gstreamer/gupnp-dlna-gst-utils.h
+CFILE_GLOB=$(top_srcdir)/libgupnp-dlna/metadata-backends/gstreamer/gupnp-dlna-gst-utils.c
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES = \
+	gupnp-dlna-gst-information.h \
+	gupnp-dlna-gst-audio-information.h \
+	gupnp-dlna-gst-container-information.h \
+	gupnp-dlna-gst-image-information.h \
+	gupnp-dlna-gst-video-information.h \
+	gupnp-dlna-gst-info-utils.h \
+	gupnp-dlna-gst-metadata-extractor.h
+# 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=../version.xml
+
+# 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. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+INCLUDES=-I$(top_srcdir)
+GTKDOC_LIBS= \
+	$(top_builddir)/libgupnp-dlna/libgupnp-dlna-2.0.la \
+	$(top_builddir)/libgupnp-dlna/metadata-backends/gstreamer/libgupnp-dlna-gst-2.0.la
+
+# 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
+DISTCLEANFILES = version.xml
diff --git a/doc/gupnp-dlna-gst/gupnp-dlna-gst-docs.sgml b/doc/gupnp-dlna-gst/gupnp-dlna-gst-docs.sgml
new file mode 100644
index 0000000..605c39d
--- /dev/null
+++ b/doc/gupnp-dlna-gst/gupnp-dlna-gst-docs.sgml
@@ -0,0 +1,53 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
+<!ENTITY version SYSTEM "../version.xml">
+]>
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude";>
+  <bookinfo>
+    <title>GUPnP DLNA Gstreamer Reference Manual</title>
+
+    <releaseinfo>Version &version;</releaseinfo>
+
+    <copyright>
+      <year>2013</year>
+      <holder>Intel Corporation</holder>
+    </copyright>
+
+    <legalnotice>
+      <para>
+        Permission is granted to copy, distribute and/or modify this
+        document under the terms of the <citetitle>GNU Free
+        Documentation License</citetitle>, Version 1.1 or any later
+        version published by the Free Software Foundation with no
+        Invariant Sections, no Front-Cover Texts, and no Back-Cover
+        Texts. You may obtain a copy of the <citetitle>GNU Free
+        Documentation License</citetitle> from the Free Software
+        Foundation by visiting <ulink type="http"
+        url="http://www.fsf.org";>their Web site</ulink> or by writing
+        to:
+
+        <address>
+          The Free Software Foundation, Inc.,
+          <street>59 Temple Place</street> - Suite 330,
+          <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
+          <country>USA</country>
+        </address>
+      </para>
+    </legalnotice>
+  </bookinfo>
+
+  <chapter>
+    <title>GUPnP DLNA Gstreamer</title>
+
+    <para>
+      GUPnP DLNA GStreamer is a set of utility function targeted for GStreamer.
+    </para>
+
+    <xi:include href="xml/gupnp-dlna-gst-utils.xml"/>
+    <xi:include href="xml/api-index-full.xml"/>
+
+  </chapter>
+
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>
diff --git a/libgupnp-dlna/metadata-backends/gstreamer/gupnp-dlna-gst-metadata-extractor.c b/libgupnp-dlna/metadata-backends/gstreamer/gupnp-dlna-gst-metadata-extractor.c
index 7f9496b..e76ac85 100644
--- a/libgupnp-dlna/metadata-backends/gstreamer/gupnp-dlna-gst-metadata-extractor.c
+++ b/libgupnp-dlna/metadata-backends/gstreamer/gupnp-dlna-gst-metadata-extractor.c
@@ -26,26 +26,6 @@
 #include "gupnp-dlna-gst-information.h"
 #include "gupnp-dlna-gst-utils.h"
 
-/**
- * SECTION:gupnp-dlna-gst-metadata-extractor
- * @short_description: Utility API for extracting metadata for given
- * media.
- *
- * The GUPnPDLNAGstMetadataExtractor object provides a light-weight
- * wrapper over the #GstMetadataExtractor API. The latter provides a
- * simple interface to discover media metadata given a
- * URI. GUPnPDLNAGstMetadataExtractor extends this API to also provide
- * a DLNA profile name and mime type for the media.
- *
- * The API provided corresponds very closely to the API provided by
- * #GstMetadataExtractor - both synchronous and asynchronous discovery
- * of metadata are possible.
- *
- * The asynchronous mode requires a running #GMainLoop in the default
- * #GMainContext, where one connects to the various signals, appends
- * the URIs to be processed and then asks for the discovery to begin.
- */
-
 G_DEFINE_TYPE (GUPnPDLNAGstMetadataExtractor,
                gupnp_dlna_gst_metadata_extractor,
                GUPNP_TYPE_DLNA_METADATA_EXTRACTOR)
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]