GNOME.org
 

[grilo-plugins/docs: 2/4] Add gtk-doc documentation generation

commit bb4cb9e0257e695b23df080b2fa4c79b43c44371
Author: Murray Cumming <murrayc openismus com>
Date:   Thu Nov 8 10:25:44 2012 +0100

    Add gtk-doc documentation generation
    
    * configure.ac, Makefile.am, doc/Makefile.am:
      Add use of gtk-doc, disabled by default but enabled during
      dist.
    * doc/grilo-plugins/: Start with the *.types, and the
      main *-docs.xml page, with an overview.xml.
    * src/*/*.c: Add gtk-doc comments to the *Source types so that
      they appear in the documentation.
      These should later contain documentation about what full-text
      search and query syntax each plugin supports, as suggested
      in bug #685473
    
    * Makefile.am: Do not make docs an optional part of SUBDIRS,
    because we need to install the distribute html even when the
    generation of that html is disabled.

 .gitignore                                |    1 +
 Makefile.am                               |    4 +-
 configure.ac                              |   10 ++
 doc/Makefile.am                           |    1 +
 doc/grilo-plugins/.gitignore              |   15 +++
 doc/grilo-plugins/Makefile.am             |  162 +++++++++++++++++++++++++++++
 doc/grilo-plugins/grilo-plugins-docs.sgml |   61 +++++++++++
 doc/grilo-plugins/grilo-plugins.types     |   47 +++++++++
 doc/grilo-plugins/overview.xml            |   17 +++
 src/apple-trailers/grl-apple-trailers.c   |    7 ++
 src/bliptv/grl-bliptv.c                   |    7 ++
 src/bookmarks/grl-bookmarks.c             |    7 ++
 src/dmap/grl-dmap.c                       |    7 ++
 src/fake-metadata/grl-fake-metadata.c     |    7 ++
 src/filesystem/grl-filesystem.c           |    7 ++
 src/flickr/grl-flickr.c                   |    7 ++
 src/gravatar/grl-gravatar.c               |    7 ++
 src/jamendo/grl-jamendo.c                 |    7 ++
 src/lastfm-albumart/grl-lastfm-albumart.c |    7 ++
 src/local-metadata/grl-local-metadata.c   |    7 ++
 src/metadata-store/grl-metadata-store.c   |    8 ++
 src/optical-media/grl-optical-media.c     |    7 ++
 src/podcasts/grl-podcasts.c               |    7 ++
 src/shoutcast/grl-shoutcast.c             |    7 ++
 src/tmdb/grl-tmdb.c                       |    8 ++
 src/tracker/grl-tracker-source.c          |    7 ++
 src/upnp/grl-upnp.c                       |    8 ++
 src/vimeo/grl-vimeo.c                     |    7 ++
 src/youtube/grl-youtube.c                 |    8 ++
 29 files changed, 461 insertions(+), 1 deletions(-)
---
diff --git a/.gitignore b/.gitignore
index 411a546..6aaa2bd 100644
--- a/.gitignore
+++ b/.gitignore
@@ -18,6 +18,7 @@ config.status
 config.sub
 configure
 depcomp
+gtk-doc.make
 install-sh
 libtool
 ltmain.sh
diff --git a/Makefile.am b/Makefile.am
index 4b9e922..e2eda7d 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -7,7 +7,7 @@
 
 ACLOCAL_AMFLAGS = -I m4
 
-SUBDIRS = src
+SUBDIRS = src doc
 
 MAINTAINERCLEANFILES = \
         aclocal.m4 \
@@ -30,6 +30,8 @@ DISTCLEANFILES = $(MAINTAINERCLEANFILES)
 
 EXTRA_DIST = ./m4/grilo.m4
 
+DISTCHECK_CONFIGURE_FLAGS=--enable-gtk-doc
+
 distclean-local:
 	-rm -rf autom4te.cache
 
diff --git a/configure.ac b/configure.ac
index 9d67399..0bac445 100644
--- a/configure.ac
+++ b/configure.ac
@@ -978,6 +978,14 @@ AC_SUBST(DEPS_TMDB_CFLAGS)
 DEPS_TMDB_LIBS="$DEPS_LIBS $LIBSOUP_LIBS $GRLNET_LIBS $JSON_LIBS"
 AC_SUBST(DEPS_TMDB_LIBS)
 
+
+# ----------------------------------------------------------
+# GTK-DOC
+# ----------------------------------------------------------
+
+GTK_DOC_CHECK([1.10],[--flavour no-tmpl])
+
+
 # ----------------------------------------------------------
 # GETTEXT
 # ----------------------------------------------------------
@@ -1022,6 +1030,8 @@ AC_CONFIG_FILES([
   src/upnp/Makefile
   src/vimeo/Makefile
   src/youtube/Makefile
+  doc/Makefile
+  doc/grilo-plugins/Makefile
 ])
 
 AC_OUTPUT
diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644
index 0000000..db6a3e2
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1 @@
+SUBDIRS = grilo-plugins
diff --git a/doc/grilo-plugins/.gitignore b/doc/grilo-plugins/.gitignore
new file mode 100644
index 0000000..732f7f3
--- /dev/null
+++ b/doc/grilo-plugins/.gitignore
@@ -0,0 +1,15 @@
+*.bak
+*.stamp
+.libs
+html
+xml
+*-un*.txt
+*.args
+*.hierarchy
+*.interfaces
+*.prerequisites
+*.signals
+*-decl-list.txt
+*-decl.txt
+*-overrides.txt
+*-sections.txt
diff --git a/doc/grilo-plugins/Makefile.am b/doc/grilo-plugins/Makefile.am
new file mode 100644
index 0000000..f4d43e1
--- /dev/null
+++ b/doc/grilo-plugins/Makefile.am
@@ -0,0 +1,162 @@
+## 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-plugins
+
+# 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)/src
+
+# 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=
+CFILE_GLOB=
+
+# 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=config.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=overview.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. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+GTKDOC_CFLAGS=-I$(top_srcdir)/src \
+	$(DEPS_APPLE_TRAILERS_CFLAGS) \
+	$(DEPS_BLIPTV_CFLAGS) \
+	$(DEPS_BOOKMARKS_CFLAGS) \
+	$(DEPS_DMAP_CFLAGS) \
+	$(DEPS_FAKE_METADATA_CFLAGS) \
+	$(DEPS_FILESYSTEM_CFLAGS) \
+	$(DEPS_FLICKR_CFLAGS) \
+	$(DEPS_GRAVATAR_CFLAGS) \
+	$(DEPS_JAMENDO_CFLAGS) \
+	$(DEPS_LASTFM_ALBUMART_CFLAGS) \
+	$(DEPS_LOCAL_METADATA_CFLAGS) \
+	$(DEPS_OPTICAL_MEDIA_CFLAGS) \
+	$(DEPS_PODCASTS_CFLAGS) \
+	$(DEPS_SHOUTCAST_CFLAGS) \
+	$(DEPS_TMDB_CFLAGS) \
+	$(DEPS_TRACKER_CFLAGS) \
+	$(DEPS_UPNP_CFLAGS) \
+	$(DEPS_VIMEO_CFLAGS) \
+	$(DEPS_YOUTUBE_CFLAGS)
+
+GTKDOC_LIBS=\
+	$(top_builddir)/src/apple-trailers/libgrlappletrailers.la \
+	$(DEPS_APPLE_TRAILERS_LIBS) \
+	$(top_builddir)/src/bliptv/libgrlbliptv.la \
+	$(DEPS_BLIPTV_LIBS) \
+	$(top_builddir)/src/bookmarks/libgrlbookmarks.la \
+	$(DEPS_BOOKMARKS_LIBS) \
+	$(top_builddir)/src/dmap/libgrldmap.la \
+	$(DEPS_DMAP_LIBS) \
+	$(top_builddir)/src/fake-metadata/libgrlfakemetadata.la \
+	$(DEPS_FAKE_METADATA_LIBS) \
+	$(top_builddir)/src/filesystem/libgrlfilesystem.la \
+	$(DEPS_FILESYSTEM_LIBS) \
+	$(top_builddir)/src/flickr/libgrlflickr.la \
+	$(DEPS_FLICKR_LIBS) \
+	$(top_builddir)/src/gravatar/libgrlgravatar.la \
+	$(DEPS_GRAVATAR_LIBS) \
+	$(top_builddir)/src/jamendo/libgrljamendo.la \
+	$(DEPS_JAMENDO_LIBS) \
+	$(top_builddir)/src/lastfm-albumart/libgrllastfm-albumart.la \
+	$(DEPS_LASTFM_ALBUMART_LIBS) \
+	$(top_builddir)/src/metadata-store/libgrlmetadatastore.la \
+	$(DEPS_LOCAL_METADATA_LIBS) \
+	$(top_builddir)/src/local-metadata/libgrllocalmetadata.la \
+	$(DEPS_METADATA_STORE_LIBS) \
+	$(top_builddir)/src/optical-media/libgrloptical-media.la \
+	$(DEPS_OPTICAL_MEDIA_LIBS) \
+	$(top_builddir)/src/podcasts/libgrlpodcasts.la \
+	$(DEPS_PODCASTS_LIBS) \
+	$(top_builddir)/src/shoutcast/libgrlshoutcast.la \
+	$(DEPS_SHOUTCAST_LIBS) \
+	$(top_builddir)/src/tmdb/libgrltmdb.la \
+	$(DEPS_TMDB_LIBS) \
+	$(top_builddir)/src/tracker/libgrltracker.la \
+	$(DEPS_TRACKER_LIBS) \
+	$(top_builddir)/src/upnp/libgrlupnp.la \
+	$(DEPS_UPNP_LIBS) \
+	$(top_builddir)/src/vimeo/libgrlvimeo.la \
+	$(DEPS_VIMEO_LIBS) \
+	$(top_builddir)/src/youtube/libgrlyoutube.la \
+	$(DEPS_YOUTUBE_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/grilo-plugins/grilo-plugins-docs.sgml b/doc/grilo-plugins/grilo-plugins-docs.sgml
new file mode 100644
index 0000000..151fcd9
--- /dev/null
+++ b/doc/grilo-plugins/grilo-plugins-docs.sgml
@@ -0,0 +1,61 @@
+<?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 Plugins Reference Manual</title>
+    <releaseinfo>
+      The latest version of this software can be found on-line at
+      <ulink role="online-location" url="http://git.gnome.org/browse/grilo-plugins";>http://git.gnome.org/browse/grilo-plugins</ulink>.
+    </releaseinfo>
+  </bookinfo>
+
+  <preface>
+    <title>Overview</title>
+    <xi:include href="overview.xml"/>
+  </preface>
+
+  <reference>
+    <title>Object Index</title>
+    <xi:include href="xml/tree_index.sgml"/>
+  </reference>
+
+  <reference>
+    <title>API Reference</title>
+    <xi:include href="xml/grl-apple-trailers.xml"/>
+    <xi:include href="xml/grl-bliptv.xml"/>
+    <xi:include href="xml/grl-bookmarks.xml"/>
+    <xi:include href="xml/grl-dmap.xml"/>
+    <xi:include href="xml/grl-fake-metadata.xml"/>
+    <xi:include href="xml/grl-filesystem.xml"/>
+    <xi:include href="xml/grl-flickr.xml"/>
+    <xi:include href="xml/grl-gravatar.xml"/>
+    <xi:include href="xml/grl-jamendo.xml"/>
+    <xi:include href="xml/grl-lastfm-albumart.xml"/>
+    <xi:include href="xml/grl-local-metadata.xml"/>
+    <xi:include href="xml/grl-metadata-store.xml"/>
+    <xi:include href="xml/grl-optical-media.xml"/>
+    <xi:include href="xml/grl-podcasts.xml"/>
+    <xi:include href="xml/grl-shoutcast.xml"/>
+    <xi:include href="xml/grl-tmdb.xml"/>
+    <xi:include href="xml/grl-tracker.xml"/>
+    <xi:include href="xml/grl-upnp.xml"/>
+    <xi:include href="xml/grl-vimeo.xml"/>
+    <xi:include href="xml/grl-youtube.xml"/>
+  </reference>
+
+
+  <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/grilo-plugins/grilo-plugins.types b/doc/grilo-plugins/grilo-plugins.types
new file mode 100644
index 0000000..228cd5a
--- /dev/null
+++ b/doc/grilo-plugins/grilo-plugins.types
@@ -0,0 +1,47 @@
+% add a _get_type for every GObject whose properties and signals you want
+% documented
+% add the relevant includes to be able to call those _get_type functions
+
+% adding a get_type here will:
+% - change output file name from grilo-(whatever).html to (whatever).html
+% - document properties and signals
+
+#include <apple-trailers/grl-apple-trailers.h>
+#include <bliptv/grl-bliptv.h>
+#include <bookmarks/grl-bookmarks.h>
+#include <dmap/grl-dmap.h>
+#include <fake-metadata/grl-fake-metadata.h>
+#include <filesystem/grl-filesystem.h>
+#include <flickr/grl-flickr.h>
+#include <jamendo/grl-jamendo.h>
+#include <lastfm-albumart/grl-lastfm-albumart.h>
+#include <local-metadata/grl-local-metadata.h>
+#include <metadata-store/grl-metadata-store.h>
+#include <optical-media/grl-optical-media.h>
+#include <podcasts/grl-podcasts.h>
+#include <shoutcast/grl-shoutcast.h>
+#include <tmdb/grl-tmdb.h>
+#include <tracker/grl-tracker-source.h>
+#include <upnp/grl-upnp.h>
+#include <vimeo/grl-vimeo.h>
+#include <youtube/grl-youtube.h>
+
+grl_apple_trailers_source_get_type
+grl_bliptv_source_get_type
+grl_bookmarks_source_get_type
+grl_dmap_source_get_type
+grl_fake_metadata_source_get_type
+grl_filesystem_source_get_type
+grl_flickr_source_get_type
+grl_jamendo_source_get_type
+grl_lastfm_albumart_source_get_type
+grl_local_metadata_source_get_type
+grl_metadata_store_source_get_type
+grl_optical_media_source_get_type
+grl_podcasts_source_get_type
+grl_shoutcast_source_get_type
+grl_tmdb_source_get_type
+grl_tracker_source_get_type
+grl_upnp_source_get_type
+grl_vimeo_source_get_type
+grl_youtube_source_get_type
diff --git a/doc/grilo-plugins/overview.xml b/doc/grilo-plugins/overview.xml
new file mode 100644
index 0000000..e858910
--- /dev/null
+++ b/doc/grilo-plugins/overview.xml
@@ -0,0 +1,17 @@
+<?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>
+TODO
+</para>
+
+<para>
+Grilo is licensed under the GNU Lesser General Public License (LGPL).
+</para>
+
+</section>
diff --git a/src/apple-trailers/grl-apple-trailers.c b/src/apple-trailers/grl-apple-trailers.c
index 9da3f32..45986a4 100644
--- a/src/apple-trailers/grl-apple-trailers.c
+++ b/src/apple-trailers/grl-apple-trailers.c
@@ -23,6 +23,13 @@
  *
  */
 
+/**
+ * SECTION:grl-apple-trailers
+ * @short_description: A Grilo Plugin for Apple Trailers
+ *
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/src/bliptv/grl-bliptv.c b/src/bliptv/grl-bliptv.c
index d337dbb..060eed2 100644
--- a/src/bliptv/grl-bliptv.c
+++ b/src/bliptv/grl-bliptv.c
@@ -23,6 +23,13 @@
  *
  */
 
+/**
+ * SECTION:grl-bliptv
+ * @short_description: A Grilo Plugin for BlipTV
+ *
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/src/bookmarks/grl-bookmarks.c b/src/bookmarks/grl-bookmarks.c
index 3a1b1b7..93b1f6f 100644
--- a/src/bookmarks/grl-bookmarks.c
+++ b/src/bookmarks/grl-bookmarks.c
@@ -20,6 +20,13 @@
  *
  */
 
+/**
+ * SECTION:grl-bookmarks
+ * @short_description: A Grilo Plugin for bookmarks
+ *
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/src/dmap/grl-dmap.c b/src/dmap/grl-dmap.c
index c7d65ef..e2f96f0 100644
--- a/src/dmap/grl-dmap.c
+++ b/src/dmap/grl-dmap.c
@@ -21,6 +21,13 @@
  *
  */
 
+/**
+ * SECTION:grl-dmap
+ * @short_description: A Grilo Plugin for DMap
+ *
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/src/fake-metadata/grl-fake-metadata.c b/src/fake-metadata/grl-fake-metadata.c
index c0d63d5..1f64709 100644
--- a/src/fake-metadata/grl-fake-metadata.c
+++ b/src/fake-metadata/grl-fake-metadata.c
@@ -20,6 +20,13 @@
  *
  */
 
+/**
+ * SECTION:grl-fake-metadata
+ * @short_description: A Grilo Plugin for fake metadata
+ *
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/src/filesystem/grl-filesystem.c b/src/filesystem/grl-filesystem.c
index 3ea5d4d..c22f8b2 100644
--- a/src/filesystem/grl-filesystem.c
+++ b/src/filesystem/grl-filesystem.c
@@ -21,6 +21,13 @@
  *
  */
 
+/**
+ * SECTION:grl-filesystem
+ * @short_description: A Grilo Plugin for the filesystem
+ *
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/src/flickr/grl-flickr.c b/src/flickr/grl-flickr.c
index baa23d8..72bde8a 100644
--- a/src/flickr/grl-flickr.c
+++ b/src/flickr/grl-flickr.c
@@ -24,6 +24,13 @@
  *
  */
 
+/**
+ * SECTION:grl-flickr
+ * @short_description: A Grilo Plugin for Flickr
+ *
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/src/gravatar/grl-gravatar.c b/src/gravatar/grl-gravatar.c
index 259a2ac..500f40b 100644
--- a/src/gravatar/grl-gravatar.c
+++ b/src/gravatar/grl-gravatar.c
@@ -23,6 +23,13 @@
  *
  */
 
+/**
+ * SECTION:grl-gravatar
+ * @short_description: A Grilo Plugin for Gravatar
+ *
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/src/jamendo/grl-jamendo.c b/src/jamendo/grl-jamendo.c
index 4021013..a5f8679 100644
--- a/src/jamendo/grl-jamendo.c
+++ b/src/jamendo/grl-jamendo.c
@@ -22,6 +22,13 @@
  *
  */
 
+/**
+ * SECTION:grl-jamendo
+ * @short_description: A Grilo Plugin for Jamendo
+ *
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/src/lastfm-albumart/grl-lastfm-albumart.c b/src/lastfm-albumart/grl-lastfm-albumart.c
index 23ef72f..14ec6fd 100644
--- a/src/lastfm-albumart/grl-lastfm-albumart.c
+++ b/src/lastfm-albumart/grl-lastfm-albumart.c
@@ -22,6 +22,13 @@
  *
  */
 
+/**
+ * SECTION:grl-lastfm-albumart
+ * @short_description: A Grilo Plugin for LastFM album art
+ *
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/src/local-metadata/grl-local-metadata.c b/src/local-metadata/grl-local-metadata.c
index 7faf879..1b3fa16 100644
--- a/src/local-metadata/grl-local-metadata.c
+++ b/src/local-metadata/grl-local-metadata.c
@@ -20,6 +20,13 @@
  *
  */
 
+/**
+ * SECTION:grl-local-metadata
+ * @short_description: A Grilo Plugin for local metadata.
+ *
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/src/metadata-store/grl-metadata-store.c b/src/metadata-store/grl-metadata-store.c
index 179d335..55f39fe 100644
--- a/src/metadata-store/grl-metadata-store.c
+++ b/src/metadata-store/grl-metadata-store.c
@@ -20,6 +20,14 @@
  *
  */
 
+
+/**
+ * SECTION:grl-metadata-store
+ * @short_description: A Grilo Plugin for metadata store
+ *
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/src/optical-media/grl-optical-media.c b/src/optical-media/grl-optical-media.c
index 0b7c47a..e6b275e 100644
--- a/src/optical-media/grl-optical-media.c
+++ b/src/optical-media/grl-optical-media.c
@@ -20,6 +20,13 @@
  *
  */
 
+/**
+ * SECTION:grl-optical-media
+ * @short_description: A Grilo Plugin for Optical Media
+ *
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/src/podcasts/grl-podcasts.c b/src/podcasts/grl-podcasts.c
index 191ae8e..6e5ea4b 100644
--- a/src/podcasts/grl-podcasts.c
+++ b/src/podcasts/grl-podcasts.c
@@ -20,6 +20,13 @@
  *
  */
 
+/**
+ * SECTION:grl-podcasts
+ * @short_description: A Grilo Plugin for podcasts
+ *
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/src/shoutcast/grl-shoutcast.c b/src/shoutcast/grl-shoutcast.c
index f8c9cfb..c8b8afa 100644
--- a/src/shoutcast/grl-shoutcast.c
+++ b/src/shoutcast/grl-shoutcast.c
@@ -22,6 +22,13 @@
  *
  */
 
+/**
+ * SECTION:grl-shoutcast
+ * @short_description: A Grilo Plugin for Shoutcast
+ *
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/src/tmdb/grl-tmdb.c b/src/tmdb/grl-tmdb.c
index fac1320..d8e5108 100644
--- a/src/tmdb/grl-tmdb.c
+++ b/src/tmdb/grl-tmdb.c
@@ -20,6 +20,14 @@
  *
  */
 
+
+/**
+ * SECTION:grl-tmdb
+ * @short_description: A Grilo Plugin for TMDb
+ *
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/src/tracker/grl-tracker-source.c b/src/tracker/grl-tracker-source.c
index 295fe1a..295951f 100644
--- a/src/tracker/grl-tracker-source.c
+++ b/src/tracker/grl-tracker-source.c
@@ -23,6 +23,13 @@
  *
  */
 
+/**
+ * SECTION:grl-tracker
+ * @short_description: A Grilo Plugin for Tracker
+ *
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/src/upnp/grl-upnp.c b/src/upnp/grl-upnp.c
index 042f532..78339d1 100644
--- a/src/upnp/grl-upnp.c
+++ b/src/upnp/grl-upnp.c
@@ -23,6 +23,14 @@
  *
  */
 
+/**
+ * SECTION:grl-upnp
+ * @short_description: A Grilo Plugin for UPnP
+ *
+ *
+ */
+
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/src/vimeo/grl-vimeo.c b/src/vimeo/grl-vimeo.c
index ef72b07..c16dd04 100644
--- a/src/vimeo/grl-vimeo.c
+++ b/src/vimeo/grl-vimeo.c
@@ -24,6 +24,13 @@
  *
  */
 
+/**
+ * SECTION:grl-vimeo
+ * @short_description: A Grilo Plugin for Vimeo
+ *
+ *
+ */
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
diff --git a/src/youtube/grl-youtube.c b/src/youtube/grl-youtube.c
index 240faf2..65bbdd3 100644
--- a/src/youtube/grl-youtube.c
+++ b/src/youtube/grl-youtube.c
@@ -21,6 +21,14 @@
  *
  */
 
+/**
+ * SECTION:grl-youtube
+ * @short_description: A Grilo Plugin for YouTube
+ *
+ *
+ */
+
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]