[gupnp/wip/phako/cleanup: 6/10] doc: Add/Fix Since: annotations
- From: Jens Georg <jensgeorg src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gupnp/wip/phako/cleanup: 6/10] doc: Add/Fix Since: annotations
- Date: Sat, 5 Jun 2021 18:10:00 +0000 (UTC)
commit 5c458faa6ad985db9f66a02d20ef538559930ac8
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
libgupnp/gupnp-context-manager.c | 16 +++++++++-------
libgupnp/gupnp-context.c | 8 ++++----
libgupnp/gupnp-service-proxy.c | 8 ++++----
libgupnp/gupnp-xml-doc.c | 10 +++++-----
4 files changed, 22 insertions(+), 20 deletions(-)
---
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..fa6abc3 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,
diff --git a/libgupnp/gupnp-service-proxy.c b/libgupnp/gupnp-service-proxy.c
index 3874b63..04f40d7 100644
--- a/libgupnp/gupnp-service-proxy.c
+++ b/libgupnp/gupnp-service-proxy.c
@@ -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
@@ -2081,7 +2081,7 @@ gupnp_service_proxy_get_subscribed (GUPnPServiceProxy *proxy)
* gupnp_service_proxy_action_get_result_list() to extract the result of the
* remote call.
*
- * Since: 1.1.2
+ * Since: 1.2.0
*/
void
gupnp_service_proxy_call_action_async (GUPnPServiceProxy *proxy,
@@ -2122,7 +2122,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.1.2
+ * Since: 1.2.0
*/
GUPnPServiceProxyAction *
gupnp_service_proxy_call_action_finish (GUPnPServiceProxy *proxy,
@@ -2145,7 +2145,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.1.2
+ * Since: 1.2.0
*/
GUPnPServiceProxyAction *
gupnp_service_proxy_call_action (GUPnPServiceProxy *proxy,
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]