GNOME.org
 

[gupnp] doc: Add/Fix Since: annotations

commit 4133874c7ce1f71032ea390dae1d3aee538b715e
Author: Jens Georg <mail jensge org>
Date:   Sat Jun 5 19:48:55 2021 +0200

    doc: Add/Fix Since: annotations
    
    Add missing Since:, move existints ones from unstable versions to the
    first stable version to feature this function

 doc/gupnp-docs.xml                    | 43 ++++++++++-------------------------
 libgupnp/gupnp-context-manager.c      | 16 +++++++------
 libgupnp/gupnp-context.c              | 10 ++++----
 libgupnp/gupnp-device-info.c          |  4 ++--
 libgupnp/gupnp-root-device.c          |  4 ++--
 libgupnp/gupnp-service-proxy-action.c |  4 ++--
 libgupnp/gupnp-service-proxy.c        | 17 ++++++++------
 libgupnp/gupnp-service.c              | 10 ++++----
 libgupnp/gupnp-xml-doc.c              | 10 ++++----
 9 files changed, 52 insertions(+), 66 deletions(-)
---
diff --git a/doc/gupnp-docs.xml b/doc/gupnp-docs.xml
index 6b760c0..1101042 100644
--- a/doc/gupnp-docs.xml
+++ b/doc/gupnp-docs.xml
@@ -126,34 +126,20 @@
     <xi:include href="xml/api-index-0.12.3.xml"><xi:fallback /></xi:include>
   </index>
 
-  <index id="api-index-0-13-0" role="0.13.0">
-    <title>Index of new symbols in 0.13.0</title>
-    <xi:include href="xml/api-index-0.13.0.xml"><xi:fallback /></xi:include>
+  <index id="api-index-0-14-0" role="0.14.0">
+    <title>Index of new symbols in 0.14.0</title>
+    <xi:include href="xml/api-index-0.14.0.xml"><xi:fallback /></xi:include>
   </index>
 
-  <index id="api-index-0-13-3" role="0.13.3">
-    <title>Index of new symbols in 0.13.3</title>
-    <xi:include href="xml/api-index-0.13.3.xml"><xi:fallback /></xi:include>
-  </index>
-
-  <index id="api-index-0-17-0" role="0.17.0">
-    <title>Index of new symbols in 0.17.0</title>
-    <xi:include href="xml/api-index-0.17.0.xml"><xi:fallback /></xi:include>
-  </index>
 
-  <index id="api-index-0-17-2" role="0.17.2">
-    <title>Index of new symbols in 0.17.2</title>
-    <xi:include href="xml/api-index-0.17.2.xml"><xi:fallback /></xi:include>
+  <index id="api-index-0-18-0" role="0.18.9">
+    <title>Index of new symbols in 0.18.0</title>
+    <xi:include href="xml/api-index-0.18.0.xml"><xi:fallback /></xi:include>
   </index>
 
-  <index id="api-index-0-19-1" role="0.19.1">
-    <title>Index of new symbols in 0.19.1</title>
-    <xi:include href="xml/api-index-0.19.1.xml"><xi:fallback /></xi:include>
-  </index>
-
-  <index id="api-index-0-19-2" role="0.19.2">
-    <title>Index of new symbols in 0.19.2</title>
-    <xi:include href="xml/api-index-0.19.2.xml"><xi:fallback /></xi:include>
+  <index id="api-index-0-20-0" role="0.20.0">
+    <title>Index of new symbols in 0.20.0</title>
+    <xi:include href="xml/api-index-0.20.0.xml"><xi:fallback /></xi:include>
   </index>
 
   <index id="api-index-0-20-3" role="0.20.3">
@@ -191,14 +177,9 @@
     <xi:include href="xml/api-index-0.20.12.xml"><xi:fallback /></xi:include>
   </index>
 
-  <index id="api-index-1-1-0" role="1.1.0">
-    <title>Index of new symbols in 1.1.0</title>
-    <xi:include href="xml/api-index-1.1.0.xml"><xi:fallback /></xi:include>
-  </index>
-
-  <index id="api-index-1-1-1" role="1.1.1">
-    <title>Index of new symbols in 1.1.1</title>
-    <xi:include href="xml/api-index-1.1.1.xml"><xi:fallback /></xi:include>
+  <index id="api-index-1-2-0" role="1.2.0">
+    <title>Index of new symbols in 1.2.0</title>
+    <xi:include href="xml/api-index-1.2.0.xml"><xi:fallback /></xi:include>
   </index>
 
   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
diff --git a/libgupnp/gupnp-context-manager.c b/libgupnp/gupnp-context-manager.c
index 1648fd4..e103ef5 100644
--- a/libgupnp/gupnp-context-manager.c
+++ b/libgupnp/gupnp-context-manager.c
@@ -513,7 +513,7 @@ gupnp_context_manager_class_init (GUPnPContextManagerClass *klass)
          * for any or %G_SOCKET_FAMILY_IPV4 for IPv4 contexts or
          * %G_SOCKET_FAMILY_IPV6 for IPv6 contexts
          *
-         * Since: 1.1.0
+         * Since: 1.2.0
          **/
         g_object_class_install_property
                 (object_class,
@@ -533,7 +533,7 @@ gupnp_context_manager_class_init (GUPnPContextManagerClass *klass)
          * The UDA version the contexts will support. Use %GSSDP_UDA_VERSION_UNSPECIFIED
          * for using the default UDA version.
          *
-         * Since: 1.1.2
+         * Since: 1.2.0
          **/
         g_object_class_install_property
                 (object_class,
@@ -619,7 +619,7 @@ gupnp_context_manager_class_init (GUPnPContextManagerClass *klass)
  *
  * Returns: (transfer full): A new #GUPnPContextManager object.
  *
- * Since: 0.17.2
+ * Since: 0.18.0
  **/
 GUPnPContextManager *
 gupnp_context_manager_create (guint port)
@@ -643,7 +643,7 @@ gupnp_context_manager_create (guint port)
  *
  * Returns: (transfer full): A new #GUPnPContextManager object.
  *
- * Since: 1.1.0
+ * Since: 1.2.0
  **/
 GUPnPContextManager *
 gupnp_context_manager_create_full (GSSDPUDAVersion uda_version, GSocketFamily family, guint port)
@@ -749,7 +749,7 @@ gupnp_context_manager_rescan_control_points (GUPnPContextManager *manager)
  * #GUPnPContextManager::context-available handler after you create a
  * #GUPnPControlPoint object for the newly available context.
  *
- * Since: 0.13.0
+ * Since: 0.14.0
  **/
 void
 gupnp_context_manager_manage_control_point (GUPnPContextManager *manager,
@@ -776,7 +776,7 @@ gupnp_context_manager_manage_control_point (GUPnPContextManager *manager,
  * #GUPnPContextManager::context-available handler after you create a
  * #GUPnPRootDevice object for the newly available context.
  *
- * Since: 0.13.0
+ * Since: 0.14.0
  **/
 void
 gupnp_context_manager_manage_root_device (GUPnPContextManager *manager,
@@ -799,7 +799,7 @@ gupnp_context_manager_manage_root_device (GUPnPContextManager *manager,
  * Get the network port associated with this context manager.
  * Returns: The network port asssociated with this context manager.
  *
- * Since: 0.19.1
+ * Since: 0.20.0
  */
 guint
 gupnp_context_manager_get_port (GUPnPContextManager *manager)
@@ -843,6 +843,7 @@ gupnp_context_manager_get_white_list (GUPnPContextManager *manager)
  * both
  *
  * Returns: The socket family
+ * Since: 1.2.0
  */
 GSocketFamily
 gupnp_context_manager_get_socket_family (GUPnPContextManager *manager)
@@ -864,6 +865,7 @@ gupnp_context_manager_get_socket_family (GUPnPContextManager *manager)
  * Get the UDA protocol version the contexts are implementing
  *
  * Returns: The UDA protocol version
+ * Since: 1.2.0
  */
 GSSDPUDAVersion
 gupnp_context_manager_get_uda_version (GUPnPContextManager *manager)
diff --git a/libgupnp/gupnp-context.c b/libgupnp/gupnp-context.c
index 2f5ef9e..c08b41a 100644
--- a/libgupnp/gupnp-context.c
+++ b/libgupnp/gupnp-context.c
@@ -499,7 +499,7 @@ gupnp_context_class_init (GUPnPContextClass *klass)
          * sends Accept-Language and no language-specific pages to serve
          * exist. The property defaults to 'en'.
          *
-         * Since: 0.17.0
+         * Since: 0.18.0
          **/
         g_object_class_install_property
                 (object_class,
@@ -778,7 +778,7 @@ host_path_data_set_language (HostPathData *data, const char *language)
  * no files hosted in languages which match the requested ones the
  * Content-Language header is set to this value. The default value is "en".
  *
- * Since: 0.17.0
+ * Since: 0.18.0
  */
 void
 gupnp_context_set_default_language (GUPnPContext *context,
@@ -815,7 +815,7 @@ gupnp_context_set_default_language (GUPnPContext *context,
  * Returns: (transfer none): The default content of the Content-Language
  * header.
  *
- * Since: 0.17.0
+ * Since: 0.18.0
  */
 const char *
 gupnp_context_get_default_language (GUPnPContext *context)
@@ -1308,7 +1308,7 @@ path_compare_func (HostPathData *path_data,
  *
  * Return value: %TRUE on success, %FALSE otherwise.
  *
- * Since: 0.13.3
+ * Since: 0.14.0
  **/
 gboolean
 gupnp_context_host_path_for_agent (GUPnPContext *context,
@@ -1614,7 +1614,7 @@ gupnp_context_remove_server_handler (GUPnPContext *context, const char *path)
  * Returns: A re-written version of the @uri if the context is on a link-local
  * IPv6 address, a copy of the @uri otherwise or %NULL if @uri was invalid
  *
- * Since: 1.1.1
+ * Since: 1.2.0
  */
 char *
 gupnp_context_rewrite_uri (GUPnPContext *context, const char *uri)
diff --git a/libgupnp/gupnp-device-info.c b/libgupnp/gupnp-device-info.c
index 0533b26..0bdbc38 100644
--- a/libgupnp/gupnp-device-info.c
+++ b/libgupnp/gupnp-device-info.c
@@ -1073,7 +1073,7 @@ gupnp_device_info_list_dlna_device_class_identifier (GUPnPDeviceInfo *info)
  * %NULL if the device description doesn't contain the &lt;dlna:X_DLNACAP&gt;
  * element.
  *
- * Since: 0.13.0
+ * Since: 0.14.0
  **/
 GList *
 gupnp_device_info_list_dlna_capabilities (GUPnPDeviceInfo *info)
@@ -1132,7 +1132,7 @@ gupnp_device_info_list_dlna_capabilities (GUPnPDeviceInfo *info)
  * Return value: a newly allocated string or %NULL if the device
  *               description doesn't contain the given @element
  *
- * Since: 0.13.0
+ * Since: 0.14.0
  **/
 char *
 gupnp_device_info_get_description_value (GUPnPDeviceInfo *info,
diff --git a/libgupnp/gupnp-root-device.c b/libgupnp/gupnp-root-device.c
index bb4cd01..2a26540 100644
--- a/libgupnp/gupnp-root-device.c
+++ b/libgupnp/gupnp-root-device.c
@@ -484,7 +484,7 @@ gupnp_root_device_class_init (GUPnPRootDeviceClass *klass)
          *
          * Device description document. Constructor property.
          *
-         * Since: 0.13.0
+         * Since: 0.14.0
          **/
         g_object_class_install_property
                 (object_class,
@@ -741,7 +741,7 @@ gupnp_root_device_get_description_dir (GUPnPRootDevice *root_device)
  *
  * Returns: (transfer none): The #GSSDPResourceGroup of @root_device.
  *
- * Since: 0.19.2
+ * Since: 0.20.0
  **/
 GSSDPResourceGroup *
 gupnp_root_device_get_ssdp_resource_group (GUPnPRootDevice *root_device)
diff --git a/libgupnp/gupnp-service-proxy-action.c b/libgupnp/gupnp-service-proxy-action.c
index 1d19411..a6689fb 100644
--- a/libgupnp/gupnp-service-proxy-action.c
+++ b/libgupnp/gupnp-service-proxy-action.c
@@ -499,7 +499,7 @@ gupnp_service_proxy_action_new_from_list (const char *action_name,
  *
  * Return value : %TRUE on success.
  *
- * Since: 1.1.2
+ * Since: 1.2.0
  *
  **/
 gboolean
@@ -615,7 +615,7 @@ gupnp_service_proxy_action_get_result_list (GUPnPServiceProxyAction *action,
  *
  * Return value: %TRUE on success.
  *
- * Since: 1.1.2
+ * Since: 1.2.0
  **/
 gboolean
 gupnp_service_proxy_action_get_result_hash (GUPnPServiceProxyAction *action,
diff --git a/libgupnp/gupnp-service-proxy.c b/libgupnp/gupnp-service-proxy.c
index 16525b9..e5bbbf0 100644
--- a/libgupnp/gupnp-service-proxy.c
+++ b/libgupnp/gupnp-service-proxy.c
@@ -391,7 +391,7 @@ gupnp_service_proxy_class_init (GUPnPServiceProxyClass *klass)
  *
  * Return value: %TRUE if sending the action was succesful.
  *
- * Deprecated: 1.1.2: Use gupnp_service_proxy_action_new() and
+ * Deprecated: 1.2.0: Use gupnp_service_proxy_action_new() and
  * gupnp_service_proxy_call_action()
  **/
 gboolean
@@ -428,7 +428,7 @@ gupnp_service_proxy_send_action (GUPnPServiceProxy *proxy,
  *
  * Return value: %TRUE if sending the action was succesful.
  *
- * Deprecated: 1.1.2
+ * Deprecated: 1.2.0
  **/
 gboolean
 gupnp_service_proxy_send_action_valist (GUPnPServiceProxy *proxy,
@@ -502,7 +502,7 @@ out:
  *
  * Return value: %TRUE if sending the action was succesful.
  *
- * Deprecated: 1.1.2: Use gupnp_service_proxy_action_new_from_list() and gupnp_service_proxy_call_action()
+ * Deprecated: 1.2.0: Use gupnp_service_proxy_action_new_from_list() and gupnp_service_proxy_call_action()
  *
  **/
 gboolean
@@ -574,7 +574,7 @@ on_legacy_async_callback (GObject *source, GAsyncResult *res, gpointer user_data
  * gupnp_service_proxy_cancel_action() or
  * gupnp_service_proxy_end_action_valist().
  *
- * Deprecated: 1.1.2: Use gupnp_service_proxy_action_new() and
+ * Deprecated: 1.2.0: Use gupnp_service_proxy_action_new() and
  * gupnp_service_proxy_call_action_async()
  **/
 GUPnPServiceProxyAction *
@@ -837,7 +837,7 @@ gupnp_service_proxy_action_queue_task (GTask *task)
  * be freed when calling gupnp_service_proxy_cancel_action() or
  * gupnp_service_proxy_end_action_valist().
  *
- * Deprecated: 1.1.2
+ * Deprecated: 1.2.0
  **/
 GUPnPServiceProxyAction *
 gupnp_service_proxy_begin_action_valist
@@ -889,7 +889,7 @@ gupnp_service_proxy_begin_action_valist
  * be freed when calling gupnp_service_proxy_cancel_action() or
  * gupnp_service_proxy_end_action_list().
  *
- * Since: 0.13.3
+ * Since: 0.14.0
  **/
 GUPnPServiceProxyAction *
 gupnp_service_proxy_begin_action_list
@@ -1104,7 +1104,7 @@ gupnp_service_proxy_end_action_hash
  *
  * Cancels @action, freeing the @action handle.
  *
- * Deprecated: 1.1.2: Use the #GCancellable passed to
+ * Deprecated: 1.2.0: Use the #GCancellable passed to
  * gupnp_service_proxy_call_action_async() or gupnp_service_proxy_call_action()
  **/
 void
@@ -2080,6 +2080,7 @@ gupnp_service_proxy_get_subscribed (GUPnPServiceProxy *proxy)
  * gupnp_service_proxy_action_get_result_hash() or
  * gupnp_service_proxy_action_get_result_list() to extract the result of the
  * remote call.
+ * Since: 1.2.0
  */
 void
 gupnp_service_proxy_call_action_async (GUPnPServiceProxy       *proxy,
@@ -2120,6 +2121,7 @@ gupnp_service_proxy_call_action_async (GUPnPServiceProxy       *proxy,
  * gupnp_service_proxy_call_action_async().
  *
  * Returns: (nullable) (transfer none): %NULL, if the call had an error, the action otherwise.
+ * Since: 1.2.0
  */
 GUPnPServiceProxyAction *
 gupnp_service_proxy_call_action_finish (GUPnPServiceProxy *proxy,
@@ -2142,6 +2144,7 @@ gupnp_service_proxy_call_action_finish (GUPnPServiceProxy *proxy,
  * Synchronously call the @action on the remote UPnP service.
  *
  * Returns: (nullable)(transfer none): %NULL on error, @action if successful.
+ * Since: 1.2.0
  */
 GUPnPServiceProxyAction *
 gupnp_service_proxy_call_action (GUPnPServiceProxy       *proxy,
diff --git a/libgupnp/gupnp-service.c b/libgupnp/gupnp-service.c
index 5298ac9..ed8f7dd 100644
--- a/libgupnp/gupnp-service.c
+++ b/libgupnp/gupnp-service.c
@@ -436,7 +436,7 @@ gupnp_service_action_get_valist (GUPnPServiceAction *action,
  * #GValue. g_list_free() the returned list and g_value_unset() and g_slice_free()
  * each element.
  *
- * Since: 0.13.3
+ * Since: 0.14.0
  **/
 GList *
 gupnp_service_action_get_values (GUPnPServiceAction *action,
@@ -519,7 +519,7 @@ gupnp_service_action_get_value (GUPnPServiceAction *action,
  * Return value: (transfer full): Value as #GValue associated with @action.
  * g_value_unset() and g_slice_free() it after usage.
  *
- * Since: 0.13.3
+ * Since: 0.14.0
  **/
 GValue *
 gupnp_service_action_get_gvalue (GUPnPServiceAction *action,
@@ -544,7 +544,7 @@ gupnp_service_action_get_gvalue (GUPnPServiceAction *action,
  *
  * Return value: The number of IN arguments from the @action.
  *
- * Since: 0.17.0
+ * Since: 0.18.0
  */
 guint
 gupnp_service_action_get_argument_count (GUPnPServiceAction *action)
@@ -628,7 +628,7 @@ gupnp_service_action_set_valist (GUPnPServiceAction *action,
  *
  * Sets the specified action return values.
  *
- * Since: 0.13.3
+ * Since: 0.14.0
  **/
 void
 gupnp_service_action_set_values (GUPnPServiceAction *action,
@@ -806,7 +806,7 @@ gupnp_service_action_return_error (GUPnPServiceAction *action,
  * Return value: (transfer full): #SoupMessage associated with @action. Unref
  * after using it.
  *
- * Since: 0.13.0
+ * Since: 0.14.0
  **/
 SoupMessage *
 gupnp_service_action_get_message (GUPnPServiceAction *action)
diff --git a/libgupnp/gupnp-xml-doc.c b/libgupnp/gupnp-xml-doc.c
index 1e9ff97..353632d 100644
--- a/libgupnp/gupnp-xml-doc.c
+++ b/libgupnp/gupnp-xml-doc.c
@@ -82,13 +82,13 @@ gupnp_xml_doc_class_init (GUPnPXMLDocClass *klass)
 
 /**
  * gupnp_xml_doc_new:
- * @xml_doc: Pointer to #xmlDoc to wrap under this object
+ * @xml_doc:(transfer full): Pointer to #xmlDoc to wrap under this object
  *
  * Create a new #GUPnPXMLDoc for @xml_doc.
  *
  * Return value: A new #GUPnPXMLDoc, or %NULL on an error
  *
- * Since: 0.13.0
+ * Since: 0.14.0
  **/
 GUPnPXMLDoc *
 gupnp_xml_doc_new (xmlDoc *xml_doc)
@@ -107,13 +107,13 @@ gupnp_xml_doc_new (xmlDoc *xml_doc)
 /**
  * gupnp_xml_doc_new_from_path:
  * @path: Path to xml document
- * @error: Location to put the error into
+ * @error:(optional): Location to put the error into
  *
  * Create a new #GUPnPXMLDoc for the XML document at @path.
  *
- * Return value: A new #GUPnPXMLDoc, or %NULL on an error
+ * Return value:(nullable): A new #GUPnPXMLDoc, or %NULL on an error
  *
- * Since: 0.13.0
+ * Since: 0.14.0
  **/
 GUPnPXMLDoc *
 gupnp_xml_doc_new_from_path (const char *path,
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]