GNOME.org
 

[gupnp] Fix gtk-doc warnings

commit 76dd0e00e140f8303be2866268bf1cbe32cec7d4
Author: Jens Georg <mail jensge org>
Date:   Thu May 30 15:15:14 2013 +0200

    Fix gtk-doc warnings

 doc/Makefile.am                |    1 +
 doc/client-tutorial.xml        |    2 +-
 doc/gupnp-sections.txt         |   54 ++++++++++++++++++++++++++++++++++++++++
 libgupnp/gupnp-context.c       |    4 +-
 libgupnp/gupnp-error.h         |    1 +
 libgupnp/gupnp-service-proxy.c |    8 +++---
 libgupnp/gupnp-service.c       |    6 ++--
 libgupnp/gupnp-xml-doc.h       |    6 ++++
 8 files changed, 72 insertions(+), 10 deletions(-)
---
diff --git a/doc/Makefile.am b/doc/Makefile.am
index af34552..476a6c1 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -52,6 +52,7 @@ IGNORE_HFILES=gena-protocol.h                         \
              http-headers.h                            \
              gupnp-marshal.h                           \
              gupnp-context-private.h                   \
+             gupnp-linux-context-manager.h             \
              gupnp-network-manager.h                   \
              gupnp-unix-context-manager.h              \
              gupnp-device-info-private.h               \
diff --git a/doc/client-tutorial.xml b/doc/client-tutorial.xml
index c480e07..0373d68 100644
--- a/doc/client-tutorial.xml
+++ b/doc/client-tutorial.xml
@@ -139,7 +139,7 @@ service_proxy_available_cb (GUPnPControlPoint *cp,
     <para>
       It is possible to get change notifications for the service state variables 
       that have attribute <literal>sendEvents="yes"</literal>. We'll demonstrate
-      this by modifying <function>service_proxy_available_cb()</function> and using 
+      this by modifying <function>service_proxy_available_cb</function> and using
       gupnp_service_proxy_add_notify() to setup a notification callback:
     </para>
     <programlisting>static void
diff --git a/doc/gupnp-sections.txt b/doc/gupnp-sections.txt
index d53fd97..abcebbc 100644
--- a/doc/gupnp-sections.txt
+++ b/doc/gupnp-sections.txt
@@ -389,3 +389,57 @@ gupnp_eventing_error_quark
 gupnp_control_error_quark
 gupnp_xml_error_quark
 </SECTION>
+
+<SECTION>
+<FILE>gupnp-connman-manager</FILE>
+<SUBSECTION Private>
+GUPNP_CONNMAN_MANAGER
+GUPNP_CONNMAN_MANAGER_CLASS
+GUPNP_CONNMAN_MANAGER_GET_CLASS
+GUPNP_IS_CONNMAN_MANAGER
+GUPNP_IS_CONNMAN_MANAGER_CLASS
+GUPNP_TYPE_CONNMAN_MANAGER
+GUPnPConnmanManager
+GUPnPConnmanManagerClass
+GUPnPConnmanManagerPrivate
+</SECTION>
+
+<SECTION>
+<FILE>gupnp-simple-context-manager</FILE>
+<SUBSECTION Private>
+GUPNP_IS_SIMPLE_CONTEXT_MANAGER
+GUPNP_IS_SIMPLE_CONTEXT_MANAGER_CLASS
+GUPNP_SIMPLE_CONTEXT_MANAGER
+GUPNP_SIMPLE_CONTEXT_MANAGER_CLASS
+GUPNP_SIMPLE_CONTEXT_MANAGER_GET_CLASS
+GUPNP_TYPE_SIMPLE_CONTEXT_MANAGER
+GUPnPSimpleContextManager
+GUPnPSimpleContextManagerClass
+GUPnPSimpleContextManagerPrivate
+</SECTION>
+
+<SECTION>
+<FILE>gupnp-windows-context-manager</FILE>
+<SUBSECTION Private>
+GUPNP_IS_WINDOWS_CONTEXT_MANAGER
+GUPNP_IS_WINDOWS_CONTEXT_MANAGER_CLASS
+GUPNP_TYPE_WINDOWS_CONTEXT_MANAGER
+GUPNP_WINDOWS_CONTEXT_MANAGER
+GUPNP_WINDOWS_CONTEXT_MANAGER_CLASS
+GUPNP_WINDOWS_CONTEXT_MANAGER_GET_CLASS
+GUPnPWindowsContextManager
+GUPnPWindowsContextManagerClass
+gupnp_windows_context_manager_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gupnp-unix-context-manager</FILE>
+</SECTION>
+
+<SECTION>
+<FILE>gupnp-linux-context-manager</FILE>
+</SECTION>
+
+<SECTION>
+<FILE>gupnp-network-manager</FILE>
+</SECTION>
diff --git a/libgupnp/gupnp-context.c b/libgupnp/gupnp-context.c
index d9a36b0..05b9325 100644
--- a/libgupnp/gupnp-context.c
+++ b/libgupnp/gupnp-context.c
@@ -30,7 +30,7 @@
  * GUPnP classes. It automatically starts a web server on demand.
  *
  * For debugging, it is possible to see the messages being sent and received by
- * exporting %GUPNP_DEBUG.
+ * exporting <envar>GUPNP_DEBUG</envar>.
  */
 
 #include <config.h>
@@ -684,7 +684,7 @@ host_path_data_set_language (HostPathData *data, const char *language)
 /**
  * gupnp_context_set_default_language:
  * @context: A #GUPnPContext
- * @language A language tag as defined in RFC 2616 3.10
+ * @language: A language tag as defined in RFC 2616 3.10
  *
  * Set the default language for the Content-Length header to @language.
  *
diff --git a/libgupnp/gupnp-error.h b/libgupnp/gupnp-error.h
index 90afcc7..a850857 100644
--- a/libgupnp/gupnp-error.h
+++ b/libgupnp/gupnp-error.h
@@ -104,6 +104,7 @@ gupnp_xml_error_quark (void) G_GNUC_CONST;
  * @GUPNP_XML_ERROR_PARSE: Generic XML parsing error.
  * @GUPNP_XML_ERROR_NO_NODE: A required XML node was not found.
  * @GUPNP_XML_ERROR_EMPTY_NODE: An XML node is unexpectedly empty.
+ * @GUPNP_XML_ERROR_INVALID_ATTRIBUTE: An XML node has an unknown attribute.
  * @GUPNP_XML_ERROR_OTHER: Unknown/unhandled XML related errors.
  *
  * #GError codes used for errors in the #GUPNP_XML_ERROR domain, during
diff --git a/libgupnp/gupnp-service-proxy.c b/libgupnp/gupnp-service-proxy.c
index fdf642e..0faa739 100644
--- a/libgupnp/gupnp-service-proxy.c
+++ b/libgupnp/gupnp-service-proxy.c
@@ -371,7 +371,7 @@ gupnp_service_proxy_class_init (GUPnPServiceProxyClass *klass)
  * @proxy: A #GUPnPServiceProxy
  * @action: An action
  * @error: The location where to store any error, or %NULL
- * @Varargs: tuples of in parameter name, in parameter type, and in parameter
+ * @...: tuples of in parameter name, in parameter type, and in parameter
  * value, followed by %NULL, and then tuples of out parameter name,
  * out parameter type, and out parameter value location, terminated with %NULL
  *
@@ -749,7 +749,7 @@ gupnp_service_proxy_send_action_list (GUPnPServiceProxy *proxy,
  * @callback: (scope async): The callback to call when sending the action has succeeded
  * or failed
  * @user_data: User data for @callback
- * @Varargs: tuples of in parameter name, in parameter type, and in parameter
+ * @...: tuples of in parameter name, in parameter type, and in parameter
  * value, terminated with %NULL
  *
  * Sends action @action with parameters @Varargs to the service exposed by
@@ -1132,7 +1132,7 @@ gupnp_service_proxy_begin_action_hash
  * @proxy: A #GUPnPServiceProxy
  * @action: A #GUPnPServiceProxyAction handle
  * @error: The location where to store any error, or %NULL
- * @Varargs: tuples of out parameter name, out parameter type, and out parameter
+ * @...: tuples of out parameter name, out parameter type, and out parameter
  * value location, terminated with %NULL. The out parameter values should be
  * freed after use
  *
@@ -1381,7 +1381,7 @@ gupnp_service_proxy_end_action_valist (GUPnPServiceProxy       *proxy,
  * in @out_values must be freed using #g_list_free and each element in it using
  * #g_value_unset and #g_slice_free.
  *
- * Return value : %TRUE on success.
+ * Returns: %TRUE on success.
  **/
 gboolean
 gupnp_service_proxy_end_action_list (GUPnPServiceProxy       *proxy,
diff --git a/libgupnp/gupnp-service.c b/libgupnp/gupnp-service.c
index 81e5607..b1271bd 100644
--- a/libgupnp/gupnp-service.c
+++ b/libgupnp/gupnp-service.c
@@ -355,7 +355,7 @@ gupnp_service_action_get_locales (GUPnPServiceAction *action)
 /**
  * gupnp_service_action_get:
  * @action: A #GUPnPServiceAction
- * @Varargs: tuples of argument name, argument type, and argument value
+ * @...: tuples of argument name, argument type, and argument value
  * location, terminated with %NULL.
  *
  * Retrieves the specified action arguments.
@@ -543,7 +543,7 @@ gupnp_service_action_get_argument_count (GUPnPServiceAction *action)
 /**
  * gupnp_service_action_set:
  * @action: A #GUPnPServiceAction
- * @Varargs: tuples of return value name, return value type, and
+ * @...: tuples of return value name, return value type, and
  * actual return value, terminated with %NULL.
  *
  * Sets the specified action return values.
@@ -1737,7 +1737,7 @@ gupnp_service_class_init (GUPnPServiceClass *klass)
 /**
  * gupnp_service_notify:
  * @service: A #GUPnPService
- * @Varargs: Tuples of variable name, variable type, and variable value,
+ * @...: Tuples of variable name, variable type, and variable value,
  * terminated with %NULL.
  *
  * Notifies listening clients that the properties listed in @Varargs
diff --git a/libgupnp/gupnp-xml-doc.h b/libgupnp/gupnp-xml-doc.h
index bad0902..5404b0e 100644
--- a/libgupnp/gupnp-xml-doc.h
+++ b/libgupnp/gupnp-xml-doc.h
@@ -55,6 +55,12 @@ gupnp_xml_doc_get_type (void) G_GNUC_CONST;
 typedef struct _GUPnPXMLDoc GUPnPXMLDoc;
 typedef struct _GUPnPXMLDocClass GUPnPXMLDocClass;
 
+/**
+ * GUPnPXMLDoc:
+ * @doc: Pointer to the document.
+ *
+ * Reference-counting wrapper for libxml's #xmlDoc
+ */
 struct _GUPnPXMLDoc {
         GObject parent;
         /*< public >*/
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]