summaryrefslogtreecommitdiff
path: root/src/bookmarks
diff options
context:
space:
mode:
authorMurray Cumming <murrayc@openismus.com>2012-11-08 10:25:44 +0100
committerMurray Cumming <murrayc@murrayc.com>2012-11-09 10:21:14 +0100
commit851e7931a8079520d72990ab5133a92563f95275 (patch)
tree8ecf1082c74b308c2b721b38293cea97b3cd8237 /src/bookmarks
parentf78d298bf1975fcaa21c4fb48d2852c0b31bdbdf (diff)
downloadgrilo-plugins-851e7931a8079520d72990ab5133a92563f95275.tar.gz
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.
Diffstat (limited to 'src/bookmarks')
-rw-r--r--src/bookmarks/grl-bookmarks.c7
1 files changed, 7 insertions, 0 deletions
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