diff options
author | Jens Georg <mail@jensge.org> | 2014-05-04 15:42:15 +0200 |
---|---|---|
committer | Jens Georg <mail@jensge.org> | 2014-05-04 15:42:15 +0200 |
commit | 7a948d71aee8bea4a7f3d867fbe1335601b22657 (patch) | |
tree | 867745c1fb46a0ec6678dc6f56c1d498eec2f11e | |
parent | 0fa05ed081177619fb94d7a0c74b17d34915b88a (diff) | |
download | gupnp-7a948d71aee8bea4a7f3d867fbe1335601b22657.tar.gz |
Fix gtk-doc issues
Signed-off-by: Jens Georg <mail@jensge.org>
-rw-r--r-- | doc/gupnp-sections.txt | 20 | ||||
-rw-r--r-- | libgupnp/gupnp-acl-private.h | 4 | ||||
-rw-r--r-- | libgupnp/gupnp-acl.c | 20 | ||||
-rw-r--r-- | libgupnp/gupnp-context.c | 6 |
4 files changed, 37 insertions, 13 deletions
diff --git a/doc/gupnp-sections.txt b/doc/gupnp-sections.txt index c4e8456..c6aab37 100644 --- a/doc/gupnp-sections.txt +++ b/doc/gupnp-sections.txt @@ -180,9 +180,12 @@ gupnp_context_set_subscription_timeout gupnp_context_get_subscription_timeout gupnp_context_get_default_language gupnp_context_set_default_language +gupnp_context_add_server_handler gupnp_context_host_path gupnp_context_host_path_for_agent gupnp_context_unhost_path +gupnp_context_get_acl +gupnp_context_set_acl <SUBSECTION Standard> GUPnPContextClass GUPNP_CONTEXT @@ -473,3 +476,20 @@ GUPnPWhiteListClass <SUBSECTION Private> GUPnPWhiteListPrivate </SECTION> + +<SECTION> +<FILE>gupnp-acl</FILE> +<TITLE>GUPnPAcl</TITLE> +GUPnPAcl +GUPnPAclInterface +gupnp_acl_can_sync +gupnp_acl_get_type +gupnp_acl_is_allowed +gupnp_acl_is_allowed_async +gupnp_acl_is_allowed_finish +<SUBSECTION Standard> +GUPNP_ACL +GUPNP_ACL_GET_INTERFACE +GUPNP_IS_ACL +GUPNP_TYPE_ACL +</SECTION> diff --git a/libgupnp/gupnp-acl-private.h b/libgupnp/gupnp-acl-private.h index ec28ef7..16c9187 100644 --- a/libgupnp/gupnp-acl-private.h +++ b/libgupnp/gupnp-acl-private.h @@ -32,6 +32,8 @@ G_BEGIN_DECLS /** + * AclServerHandler: + * * Closure for the ACL server handler that adds * a) Some data from the original server handler such as user_data and callback * b) Saves information for later use to pass on to ACL such as the service and context @@ -46,6 +48,8 @@ typedef struct _AclServerHandler } AclServerHandler; /** + * AclAsyncHandler: + * * Closure when doing an async ACL request. Stores everything passed into the server handler */ typedef struct _AclAsyncHandler diff --git a/libgupnp/gupnp-acl.c b/libgupnp/gupnp-acl.c index d9accc8..bb5fc2f 100644 --- a/libgupnp/gupnp-acl.c +++ b/libgupnp/gupnp-acl.c @@ -40,7 +40,7 @@ gupnp_acl_default_init (GUPnPAclInterface *klass) * @address: IP address of the peer. * @agent: (allow-none): The User-Agent header of the peer or %NULL if not * unknown. - * @returns: %TRUE if the peer is allowed, %FALSE otherwise + * @returns %TRUE if the peer is allowed, %FALSE otherwise * * Check whether an IP address is allowed to access this resource. * @@ -139,7 +139,7 @@ gupnp_acl_is_allowed_finish (GUPnPAcl *self, /** * gupnp_acl_can_sync: * @self: A #GUPnPAcl - * @returns: %TRUE, if gupnp_acl_is_allowed_async() is supported, %FALSE + * @returns %TRUE, if gupnp_acl_is_allowed_async() is supported, %FALSE * otherwise. * * Check whether gupnp_acl_is_allowed_async() is supported. @@ -156,15 +156,15 @@ gupnp_acl_can_sync (GUPnPAcl *self) /** * acl_server_handler_new: - * - * Allocate a new #AclServerHandler. - * * @service: (allow-none): A #GUPnPContext or %NULL if unknown * @context: The #GUPnPContext the server handler is run on. * @callback: The #SoupServerCallback we're wrapping. * @user_data: The user_data for @callback * @notify: (allow-none): The #GDestroyNotify for @user_data or %NULL if none. * @returns: A newly allocated #AclServerHandler + * + * Allocate a new #AclServerHandler. + * */ AclServerHandler * acl_server_handler_new (GUPnPService *service, @@ -186,10 +186,10 @@ acl_server_handler_new (GUPnPService *service, /** * acl_server_handler_free: + * @handler: An #AclServerHandler instance. * * Free an #AclServerHandler previously allocated with acl_server_handler_new(). * - * @handler: An #AclServerHandler instance. */ void acl_server_handler_free (AclServerHandler *handler) @@ -205,9 +205,6 @@ acl_server_handler_free (AclServerHandler *handler) /** * acl_async_handler_new: - * - * Create a new async closure. - * * @server: A #SoupServer instance. * @message: The #SoupMessage we want to handle. * @path: The path we're trying to serve. @@ -215,6 +212,9 @@ acl_server_handler_free (AclServerHandler *handler) * @client: The #SoupClientContext for this request. * @handler: The #AclServerHandler used with this request. * @returns: A new instance of #AclAsyncHandler. + * + * Create a new async closure. + * */ AclAsyncHandler * acl_async_handler_new (SoupServer *server, @@ -239,10 +239,10 @@ acl_async_handler_new (SoupServer *server, /** * acl_async_handler_free: + * @handler: An instance allocated with acl_async_handler_new() * * Free an #AclAsyncHandler allocated with acl_async_handler_new(). * - * @handler: An instance allocated with acl_async_handler_new() */ void acl_async_handler_free (AclAsyncHandler *handler) diff --git a/libgupnp/gupnp-context.c b/libgupnp/gupnp-context.c index 90c7b18..b5604eb 100644 --- a/libgupnp/gupnp-context.c +++ b/libgupnp/gupnp-context.c @@ -1333,7 +1333,7 @@ gupnp_context_get_acl (GUPnPContext *context) /** * gupnp_context_set_acl: * @context: A #GUPnPContext - * @acl:(allow-none): The new access control list or %NULL to remove the + * @acl: (allow-none): The new access control list or %NULL to remove the * current list. **/ void @@ -1439,8 +1439,8 @@ gupnp_acl_server_handler (SoupServer *server, * serving the resource, %FALSE otherwise. * @path: the toplevel path for the handler. * @callback: callback to invoke for requests under @path - * @user_data: - * @destroy: + * @user_data: the user_data passed to @callback + * @destroy: (allow-none): A #GDestroyNotify for @user_data or %NULL if none. * * Add a #SoupServerCallback to the #GUPnPContext<!-- -->'s #SoupServer. * |