diff options
author | Jens Georg <mail@jensge.org> | 2014-05-24 20:52:35 +0200 |
---|---|---|
committer | Jens Georg <mail@jensge.org> | 2014-05-24 20:52:35 +0200 |
commit | baa0fa58903e22548add4f77be83064393991c35 (patch) | |
tree | c6002a5921e535e945619cbb5e425e476b57a3fc | |
parent | c1ecb41b1793e655332c02db34fa914877c7dce3 (diff) | |
download | gupnp-baa0fa58903e22548add4f77be83064393991c35.tar.gz |
Update "Since" documentation tags
Signed-off-by: Jens Georg <mail@jensge.org>
-rw-r--r-- | libgupnp/gupnp-acl.c | 2 | ||||
-rw-r--r-- | libgupnp/gupnp-context-manager.c | 12 | ||||
-rw-r--r-- | libgupnp/gupnp-context.c | 18 | ||||
-rw-r--r-- | libgupnp/gupnp-device-info.c | 6 | ||||
-rw-r--r-- | libgupnp/gupnp-root-device.c | 6 | ||||
-rw-r--r-- | libgupnp/gupnp-service-info.c | 4 | ||||
-rw-r--r-- | libgupnp/gupnp-service-proxy.c | 18 | ||||
-rw-r--r-- | libgupnp/gupnp-service.c | 16 | ||||
-rw-r--r-- | libgupnp/gupnp-white-list.c | 28 | ||||
-rw-r--r-- | libgupnp/gupnp-xml-doc.c | 6 |
10 files changed, 102 insertions, 14 deletions
diff --git a/libgupnp/gupnp-acl.c b/libgupnp/gupnp-acl.c index bfb642b..0d4c55a 100644 --- a/libgupnp/gupnp-acl.c +++ b/libgupnp/gupnp-acl.c @@ -26,6 +26,8 @@ * * #GUPnPAcl provides either synchronous or asynchronous functions to check * whether a peer sould be able to access a resource or not. + * + * Since: 0.20.11 */ #include "gupnp-acl.h" diff --git a/libgupnp/gupnp-context-manager.c b/libgupnp/gupnp-context-manager.c index 4132d4b..7c58f31 100644 --- a/libgupnp/gupnp-context-manager.c +++ b/libgupnp/gupnp-context-manager.c @@ -31,6 +31,7 @@ * #GUPnPContext objects for all available network interfaces as they go up * (connect) and down (disconnect), respectively. * + * Since: 0.13.0 */ #include <config.h> @@ -508,6 +509,7 @@ gupnp_context_manager_class_init (GUPnPContextManagerClass *klass) * Same as gupnp_context_manager_create(). * * Returns: (transfer full): A new #GUPnPContextManager object. + * Since: 0.13.0 * Deprecated: 0.17.2: Use gupnp_context_manager_create(). **/ GUPnPContextManager * @@ -536,6 +538,8 @@ gupnp_context_manager_new (GMainContext *main_context, * the implementation falls back to the basic Unix context manager instead. * * Returns: (transfer full): A new #GUPnPContextManager object. + * + * Since: 0.17.2 **/ GUPnPContextManager * gupnp_context_manager_create (guint port) @@ -600,6 +604,8 @@ gupnp_context_manager_create (guint port) * Only the active control points send discovery messages. * This function should be called when servers are suspected to have * disappeared. + * + * Since: 0.20.3 **/ void gupnp_context_manager_rescan_control_points (GUPnPContextManager *manager) @@ -631,6 +637,8 @@ gupnp_context_manager_rescan_control_points (GUPnPContextManager *manager) * You usually want to call this function from * #GUPnPContextManager::context-available handler after you create a * #GUPnPControlPoint object for the newly available context. + * + * Since: 0.13.0 **/ void gupnp_context_manager_manage_control_point (GUPnPContextManager *manager, @@ -653,6 +661,8 @@ gupnp_context_manager_manage_control_point (GUPnPContextManager *manager, * usually want to call this function from * #GUPnPContextManager::context-available handler after you create a * #GUPnPRootDevice object for the newly available context. + * + * Since: 0.13.0 **/ void gupnp_context_manager_manage_root_device (GUPnPContextManager *manager, @@ -671,6 +681,8 @@ 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 */ guint gupnp_context_manager_get_port (GUPnPContextManager *manager) diff --git a/libgupnp/gupnp-context.c b/libgupnp/gupnp-context.c index c13e89f..d7c0433 100644 --- a/libgupnp/gupnp-context.c +++ b/libgupnp/gupnp-context.c @@ -498,6 +498,8 @@ gupnp_context_class_init (GUPnPContextClass *klass) * The content of the Content-Language header id the client * sends Accept-Language and no language-specific pages to serve * exist. The property defaults to 'en'. + * + * Since: 0.17.0 **/ g_object_class_install_property (object_class, @@ -516,6 +518,8 @@ gupnp_context_class_init (GUPnPContextClass *klass) * GUPnPContext:acl: * * An access control list. + * + * Since: 0.20.11 */ g_object_class_install_property (object_class, @@ -537,6 +541,8 @@ gupnp_context_class_init (GUPnPContextClass *klass) * * Return value: (transfer none): The #SoupSession used by GUPnP. Do not unref * this when finished. + * + * Since: 0.12.3 **/ SoupSession * gupnp_context_get_session (GUPnPContext *context) @@ -764,6 +770,8 @@ host_path_data_set_language (HostPathData *data, const char *language) * is required to send a Content-Language header in return. If there are * 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 */ void gupnp_context_set_default_language (GUPnPContext *context, @@ -795,6 +803,8 @@ gupnp_context_set_default_language (GUPnPContext *context, * * Returns: (transfer none): The default content of the Content-Language * header. + * + * Since: 0.17.0 */ const char * gupnp_context_get_default_language (GUPnPContext *context) @@ -1235,6 +1245,8 @@ path_compare_func (HostPathData *path_data, * path @server_path must already be hosted by @context. * * Return value: %TRUE on success, %FALSE otherwise. + * + * Since: 0.13.3 **/ gboolean gupnp_context_host_path_for_agent (GUPnPContext *context, @@ -1307,6 +1319,8 @@ gupnp_context_unhost_path (GUPnPContext *context, * * Returns:(transfer none): The access control list associated with this context or %NULL * if no acl is set. + * + * Since: 0.20.11 **/ GUPnPAcl * gupnp_context_get_acl (GUPnPContext *context) @@ -1321,6 +1335,8 @@ gupnp_context_get_acl (GUPnPContext *context) * @context: A #GUPnPContext * @acl: (allow-none): The new access control list or %NULL to remove the * current list. + * + * Since: 0.20.11 **/ void gupnp_context_set_acl (GUPnPContext *context, GUPnPAcl *acl) @@ -1430,6 +1446,7 @@ gupnp_acl_server_handler (SoupServer *server, * * Add a #SoupServerCallback to the #GUPnPContext<!-- -->'s #SoupServer. * + * Since: 0.20.11 */ void gupnp_context_add_server_handler (GUPnPContext *context, @@ -1480,6 +1497,7 @@ _gupnp_context_add_server_handler_with_data (GUPnPContext *context, * * Add a #SoupServerCallback to the #GUPnPContext<!-- -->'s #SoupServer. * + * Since: 0.20.11 */ void gupnp_context_remove_server_handler (GUPnPContext *context, const char *path) diff --git a/libgupnp/gupnp-device-info.c b/libgupnp/gupnp-device-info.c index 0e21ee4..24f721c 100644 --- a/libgupnp/gupnp-device-info.c +++ b/libgupnp/gupnp-device-info.c @@ -935,6 +935,8 @@ resource_type_match (const char *query, * Returns: (transfer full) (element-type utf8): a #GList of newly allocated strings or * %NULL if the device description doesn't contain the <dlna:X_DLNADOC> * element. + * + * Since: 0.20.4 **/ GList * gupnp_device_info_list_dlna_device_class_identifier (GUPnPDeviceInfo *info) @@ -977,6 +979,8 @@ gupnp_device_info_list_dlna_device_class_identifier (GUPnPDeviceInfo *info) * Returns: (transfer full) (element-type utf8): a #GList of newly allocated strings or * %NULL if the device description doesn't contain the <dlna:X_DLNACAP> * element. + * + * Since: 0.13.0 **/ GList * gupnp_device_info_list_dlna_capabilities (GUPnPDeviceInfo *info) @@ -1031,6 +1035,8 @@ 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 **/ char * gupnp_device_info_get_description_value (GUPnPDeviceInfo *info, diff --git a/libgupnp/gupnp-root-device.c b/libgupnp/gupnp-root-device.c index 1e46798..fe6affc 100644 --- a/libgupnp/gupnp-root-device.c +++ b/libgupnp/gupnp-root-device.c @@ -481,6 +481,8 @@ gupnp_root_device_class_init (GUPnPRootDeviceClass *klass) * GUPnPRootDevice:description-doc: * * Device description document. Constructor property. + * + * Since: 0.13.0 **/ g_object_class_install_property (object_class, @@ -500,6 +502,8 @@ gupnp_root_device_class_init (GUPnPRootDeviceClass *klass) * * The path to device description document. This could either be an * absolute path or path relative to GUPnPRootDevice:description-dir. + * + * Since: 0.13.0 **/ g_object_class_install_property (object_class, @@ -706,6 +710,8 @@ gupnp_root_device_get_description_dir (GUPnPRootDevice *root_device) * Get the #GSSDPResourceGroup used by @root_device. * * Returns: (transfer none): The #GSSDPResourceGroup of @root_device. + * + * Since: 0.19.2 **/ GSSDPResourceGroup * gupnp_root_device_get_ssdp_resource_group (GUPnPRootDevice *root_device) diff --git a/libgupnp/gupnp-service-info.c b/libgupnp/gupnp-service-info.c index a69d564..7e84303 100644 --- a/libgupnp/gupnp-service-info.c +++ b/libgupnp/gupnp-service-info.c @@ -745,9 +745,9 @@ gupnp_service_info_get_introspection_async * if the service does not provide an SCPD. * * If @cancellable is used to cancel the call, @callback will be called with - * error code G_IO_ERROR_CANCELLED. + * error code %G_IO_ERROR_CANCELLED. * - * Since: 0.20.10. + * Since: 0.20.9. **/ void gupnp_service_info_get_introspection_async_full diff --git a/libgupnp/gupnp-service-proxy.c b/libgupnp/gupnp-service-proxy.c index 0c35345..0d8868a 100644 --- a/libgupnp/gupnp-service-proxy.c +++ b/libgupnp/gupnp-service-proxy.c @@ -711,6 +711,8 @@ gupnp_service_proxy_send_action_hash (GUPnPServiceProxy *proxy, * #gupnp_service_proxy_end_action_list. * * Return value: %TRUE if sending the action was succesful. + * + * Since: 0.13.3 **/ gboolean gupnp_service_proxy_send_action_list (GUPnPServiceProxy *proxy, @@ -1056,8 +1058,10 @@ gupnp_service_proxy_begin_action_valist * in-parameter names, types and values. * * Return value: (transfer none): A #GUPnPServiceProxyAction handle. This will - * be freed when calling #gupnp_service_proxy_cancel_action or - * #gupnp_service_proxy_end_action_list. + * be freed when calling gupnp_service_proxy_cancel_action() or + * gupnp_service_proxy_end_action_list(). + * + * Since: 0.13.3 **/ GUPnPServiceProxyAction * gupnp_service_proxy_begin_action_list @@ -1607,7 +1611,7 @@ gupnp_service_proxy_add_notify (GUPnPServiceProxy *proxy, * Sets up @callback to be called whenever a change notification for * @variable is recieved. * - * Since: 0.20.9 + * Since: 0.20.12 * * Return value: %TRUE on success. **/ @@ -1677,10 +1681,10 @@ gupnp_service_proxy_add_notify_full (GUPnPServiceProxy *proxy, * * Cancels the variable change notification for @callback and @user_data. * - * In version 20.9 and earlier this function must not be called directly - * or indirectly from a #GUPnPServiceProxyNotifyCallback associated with - * this service proxy, even if it is for another variable. In later - * versions such calls are allowed. + * Up to version 0.20.9 this function must not be called directlya or + * indirectly from a #GUPnPServiceProxyNotifyCallback associated with this + * service proxy, even if it is for another variable. In later versions such + * calls are allowed. * * Return value: %TRUE on success. **/ diff --git a/libgupnp/gupnp-service.c b/libgupnp/gupnp-service.c index 8e203f6..d971118 100644 --- a/libgupnp/gupnp-service.c +++ b/libgupnp/gupnp-service.c @@ -423,8 +423,10 @@ gupnp_service_action_get_valist (GUPnPServiceAction *action, * A variant of #gupnp_service_action_get that uses #GList instead of varargs. * * Return value: (element-type GValue) (transfer full): The values as #GList of - * #GValue. #g_list_free the returned list and #g_value_unset and #g_slice_free + * #GValue. g_list_free() the returned list and g_value_unset() and g_slice_free() * each element. + * + * Since: 0.13.3 **/ GList * gupnp_service_action_get_values (GUPnPServiceAction *action, @@ -502,10 +504,12 @@ gupnp_service_action_get_value (GUPnPServiceAction *action, * * Retrieves the value of @argument into a GValue of type @type and returns it. * The method exists only and only to satify PyGI, please use - * #gupnp_service_action_get_value and ignore this if possible. + * gupnp_service_action_get_value() and ignore this if possible. * * Return value: (transfer full): Value as #GValue associated with @action. - * #g_value_unset and #g_slice_free it after usage. + * g_value_unset() and g_slice_free() it after usage. + * + * Since: 0.13.3 **/ GValue * gupnp_service_action_get_gvalue (GUPnPServiceAction *action, @@ -529,6 +533,8 @@ gupnp_service_action_get_gvalue (GUPnPServiceAction *action, * Get the number of IN arguments from the @action and return it. * * Return value: The number of IN arguments from the @action. + * + * Since: 0.17.0 */ guint gupnp_service_action_get_argument_count (GUPnPServiceAction *action) @@ -611,6 +617,8 @@ gupnp_service_action_set_valist (GUPnPServiceAction *action, * #GValues) that line up with @arg_names. * * Sets the specified action return values. + * + * Since: 0.13.3 **/ void gupnp_service_action_set_values (GUPnPServiceAction *action, @@ -787,6 +795,8 @@ gupnp_service_action_return_error (GUPnPServiceAction *action, * * Return value: (transfer full): #SoupMessage associated with @action. Unref * after using it. + * + * Since: 0.13.0 **/ SoupMessage * gupnp_service_action_get_message (GUPnPServiceAction *action) diff --git a/libgupnp/gupnp-white-list.c b/libgupnp/gupnp-white-list.c index c928669..67f96a2 100644 --- a/libgupnp/gupnp-white-list.c +++ b/libgupnp/gupnp-white-list.c @@ -27,6 +27,8 @@ * of entries that will be used to filter networks. * The #GUPnPWhiteList could be enabled or not. If it's enabled but the entries * list is empty, it behaves as disabled. + * + * Since: 0.20.5 */ #include <string.h> @@ -143,6 +145,8 @@ gupnp_white_list_class_init (GUPnPWhiteListClass *klass) * GUPnPWhiteList:enabled: * * Whether this white list is active or not. + * + * Since: 0.20.5 **/ g_object_class_install_property (object_class, @@ -160,6 +164,8 @@ gupnp_white_list_class_init (GUPnPWhiteListClass *klass) * GUPnPWhiteList:entries: (type GList(utf8)) * * Whether this white list is active or not. + * + * Since: 0.20.5 **/ g_object_class_install_property (object_class, @@ -180,6 +186,8 @@ gupnp_white_list_class_init (GUPnPWhiteListClass *klass) * The white list is disabled by default. * * Returns: (transfer full): A new #GUPnPWhiteList object. + * + * Since: 0.20.5 **/ GUPnPWhiteList * gupnp_white_list_new (void) @@ -193,7 +201,9 @@ gupnp_white_list_new (void) * @enable: %TRUE to enable @white_list, %FALSE otherwise * * Enable or disable the #GUPnPWhiteList to perform the network filtering. -**/ + * + * Since: 0.20.5 + **/ void gupnp_white_list_set_enabled (GUPnPWhiteList *white_list, gboolean enable) { @@ -210,6 +220,8 @@ gupnp_white_list_set_enabled (GUPnPWhiteList *white_list, gboolean enable) * Return the status of the #GUPnPWhiteList * * Return value: %TRUE if @white_list is enabled, %FALSE otherwise. + * + * Since: 0.20.5 **/ gboolean gupnp_white_list_get_enabled (GUPnPWhiteList *white_list) @@ -226,6 +238,8 @@ gupnp_white_list_get_enabled (GUPnPWhiteList *white_list) * Return the state of the entries list of #GUPnPWhiteList * * Return value: %TRUE if @white_list is empty, %FALSE otherwise. + * + * Since: 0.20.5 **/ gboolean gupnp_white_list_is_empty (GUPnPWhiteList *white_list) @@ -245,6 +259,8 @@ gupnp_white_list_is_empty (GUPnPWhiteList *white_list) * if @entry already exists, it won't be added a second time. * * Return value: %TRUE if @entry is added, %FALSE otherwise. + * + * Since: 0.20.5 **/ gboolean gupnp_white_list_add_entry (GUPnPWhiteList *white_list, gchar* entry) @@ -301,6 +317,8 @@ gupnp_white_list_add_entryv (GUPnPWhiteList *white_list, gchar **entries) * filter networks. * * Return value: %TRUE if @entry is removed, %FALSE otherwise. + * + * Since: 0.20.5 **/ gboolean gupnp_white_list_remove_entry (GUPnPWhiteList *white_list, gchar* entry) @@ -334,6 +352,8 @@ gupnp_white_list_remove_entry (GUPnPWhiteList *white_list, gchar* entry) * Return value: (element-type utf8) (transfer none): a #GList of entries * used to filter networks, interfaces,... or %NULL. * Do not modify or free the list nor its elements. + * + * Since: 0.20.5 **/ GList * gupnp_white_list_get_entries (GUPnPWhiteList *white_list) @@ -350,7 +370,9 @@ gupnp_white_list_get_entries (GUPnPWhiteList *white_list) * Remove all entries from #GList that compose the white list. * The list is now empty. Even if #GUPnPWhiteList is enabled, it will have the * same behavior as if it was disabled. -**/ + * + * Since: 0.20.5 + **/ void gupnp_white_list_clear (GUPnPWhiteList *white_list) { @@ -376,6 +398,8 @@ gupnp_white_list_clear (GUPnPWhiteList *white_list) * * Return value: %TRUE if @context is matching the @white_list criterias, * %FALSE otherwise. + * + * Since: 0.20.5 **/ gboolean gupnp_white_list_check_context (GUPnPWhiteList *white_list, diff --git a/libgupnp/gupnp-xml-doc.c b/libgupnp/gupnp-xml-doc.c index fae4fa1..9c4740a 100644 --- a/libgupnp/gupnp-xml-doc.c +++ b/libgupnp/gupnp-xml-doc.c @@ -28,6 +28,8 @@ * * GObject wrapper for xmlDoc, so that we can use refcounting and weak * references. + * + * Since: 0.13.0 */ #include <string.h> @@ -73,6 +75,8 @@ gupnp_xml_doc_class_init (GUPnPXMLDocClass *klass) * Create a new #GUPnPXMLDoc for @xml_doc. * * Return value: A new #GUPnPXMLDoc, or %NULL on an error + * + * Since: 0.13.0 **/ GUPnPXMLDoc * gupnp_xml_doc_new (xmlDoc *xml_doc) @@ -96,6 +100,8 @@ gupnp_xml_doc_new (xmlDoc *xml_doc) * Create a new #GUPnPXMLDoc for the XML document at @path. * * Return value: A new #GUPnPXMLDoc, or %NULL on an error + * + * Since: 0.13.0 **/ GUPnPXMLDoc * gupnp_xml_doc_new_from_path (const char *path, |