[gssdp] Some gtk-doc updates
- From: Jens Georg <jensgeorg src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gssdp] Some gtk-doc updates
- Date: Tue, 3 Sep 2013 11:44:29 +0000 (UTC)
commit 41ac801375c00c5a0dce59e4f891f71a8959a5a1
Author: Jens Georg <jensg openismus com>
Date: Tue Sep 3 12:02:34 2013 +0200
Some gtk-doc updates
configure.ac | 2 +-
doc/Makefile.am | 4 ++--
libgssdp/gssdp-resource-browser.c | 15 +++++++++++++++
3 files changed, 18 insertions(+), 3 deletions(-)
---
diff --git a/configure.ac b/configure.ac
index e5bec47..a236099 100644
--- a/configure.ac
+++ b/configure.ac
@@ -131,7 +131,7 @@ esac
AC_MSG_RESULT([$target_android])
AM_CONDITIONAL(TARGET_ANDROID, [test $target_android = yes])
-GTK_DOC_CHECK([1.0])
+GTK_DOC_CHECK([1.14], [--flavour no-tmpl])
AC_CONFIG_FILES([
Makefile
diff --git a/doc/Makefile.am b/doc/Makefile.am
index ee9484a..4cd21d6 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -29,7 +29,7 @@ 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
+MKDB_OPTIONS=--xml-mode --output-format=xml
# Extra options to supply to gtkdoc-mktmpl
# e.g. MKTMPL_OPTIONS=--only-section-tmpl
@@ -70,7 +70,7 @@ expand_content_files=
# signals and properties.
# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
-AM_CPPFLAGS=-I$(top_srcdir) $(LIBGSSDP_CFLAGS)
+GTKDOC_CFLAGS=-I$(top_srcdir) $(LIBGSSDP_CFLAGS)
GTKDOC_LIBS=$(top_builddir)/libgssdp/libgssdp-1.0.la $(LIBGSSDP_LIBS)
# This includes the standard gtk-doc make rules, copied by gtkdocize.
diff --git a/libgssdp/gssdp-resource-browser.c b/libgssdp/gssdp-resource-browser.c
index 061181f..00e9a17 100644
--- a/libgssdp/gssdp-resource-browser.c
+++ b/libgssdp/gssdp-resource-browser.c
@@ -385,6 +385,21 @@ gssdp_resource_browser_class_init (GSSDPResourceBrowserClass *klass)
/**
* gssdp_resource_browser_new:
* @client: The #GSSDPClient to associate with
+ * @target: A SSDP search target
+ *
+ * @target is a generic string the resource browser listens for on the SSDP
+ * bus. There are several possible targets such as
+ * <itemizedlist>
+ * <listitem><para>"ssdp:all" for everything</para></listitem>
+ * <listitem><para>
+ * "upnp:rootdevice" for UPnP device entry points, not caring about the
+ * device type</para></listitem>
+ * <listitem><para>The UUID of a specific device</para></listitem>
+ * <listitem><para>Device types such as
+ * "urn:schemas-upnp-org:device:MediaServer:1"</para></listitem>
+ * <listitem><para>Service types such as
+ * "urn:schemas-upnp-org:service:ContentDirectory:1"</para></listitem>
+ * </itemizedlist>
*
* Return value: A new #GSSDPResourceBrowser object.
**/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]