Fixup GUPnPAcl documentation

Signed-off-by: Jens Georg <mail@jensge.org>

7 files changed, 38 insertions, 1 deletions

diff --git a/doc/gupnp-docs.xml b/doc/gupnp-docs.xml
index d7fb919..712845c 100644
--- a/doc/gupnp-docs.xml
+++ b/doc/gupnp-docs.xml
@@ -73,6 +73,7 @@
     <chapter id="api-utility">
       <title>Utility Functions</title>
       
+      <xi:include href="xml/gupnp-acl.xml"/>
       <xi:include href="xml/gupnp-context.xml"/>
       <xi:include href="xml/gupnp-context-manager.xml"/>
       <xi:include href="xml/gupnp-white-list.xml"/>
diff --git a/doc/gupnp-sections.txt b/doc/gupnp-sections.txt
index c6aab37..70f2c37 100644
--- a/doc/gupnp-sections.txt
+++ b/doc/gupnp-sections.txt
@@ -483,11 +483,11 @@ GUPnPWhiteListPrivate
 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_get_type
 GUPNP_ACL
 GUPNP_ACL_GET_INTERFACE
 GUPNP_IS_ACL
diff --git a/doc/gupnp.types b/doc/gupnp.types
index f8f6b0d..3535c62 100644
--- a/doc/gupnp.types
+++ b/doc/gupnp.types
@@ -1,5 +1,6 @@
 #include <libgupnp/gupnp.h>
 
+gupnp_acl_get_type
 gupnp_context_get_type
 gupnp_context_manager_get_type
 gupnp_control_point_get_type
diff --git a/libgupnp/gupnp-acl.c b/libgupnp/gupnp-acl.c
index bb5fc2f..cafea14 100644
--- a/libgupnp/gupnp-acl.c
+++ b/libgupnp/gupnp-acl.c
@@ -19,6 +19,15 @@
  * Boston, MA 02110-1301, USA.
  */
 
+/**
+ * SECTION:gupnp-acl
+ * @short_description: Object providing a simple access control list for
+ * GUPnP.
+ *
+ * #GUPnPAcl provides either synchronous or asynchronous functions to check
+ * whether a peer sould be able to access a resource or not.
+ */
+
 #include "gupnp-acl.h"
 #include "gupnp-acl-private.h"
 
diff --git a/libgupnp/gupnp-acl.h b/libgupnp/gupnp-acl.h
index a1ba497..df5ebe8 100644
--- a/libgupnp/gupnp-acl.h
+++ b/libgupnp/gupnp-acl.h
@@ -46,7 +46,25 @@ gupnp_acl_get_type (void) G_GNUC_CONST;
     (G_TYPE_INSTANCE_GET_INTERFACE ((obj), \
      GUPNP_TYPE_ACL, GUPnPAclInterface))
 
+/**
+ * GUPnPAcl:
+ *
+ * Handle to an object implementing the #GUPnPAclInterface interface.
+ */
 typedef struct _GUPnPAcl GUPnPAcl;
+
+/**
+ * GUPnPAclInterface:
+ * @parent: The parent interface.
+ * @is_allowed: Check whether access to the resource is granted.
+ * @is_allowed_async: Asynchronously check whether the access is granted.
+ * @is_allowed_finish: Conclude the @is_allowed_async operation.
+ * @can_sync: Whether the ACL can do sync queries.
+ *
+ * Implement a simple access control list for GUPnP.
+ *
+ * Since: 0.20.11
+ */
 typedef struct _GUPnPAclInterface GUPnPAclInterface;
 
 /* Forward declarations to avoid recursive includes */
@@ -79,6 +97,8 @@ struct _GUPnPAclInterface {
 
     gboolean (*can_sync)          (GUPnPAcl *self);
 
+
+    /*< private >*/
     /* future padding */
     void (* _gupnp_reserved1) (void);
     void (* _gupnp_reserved2) (void);
diff --git a/libgupnp/gupnp-context.c b/libgupnp/gupnp-context.c
index b5604eb..28baa66 100644
--- a/libgupnp/gupnp-context.c
+++ b/libgupnp/gupnp-context.c
@@ -516,6 +516,11 @@ gupnp_context_class_init (GUPnPContextClass *klass)
                                       G_PARAM_STATIC_NICK |
                                       G_PARAM_STATIC_BLURB));
 
+        /**
+         * GUPnPContext:acl:
+         *
+         * An access control list.
+         */
         g_object_class_install_property
                 (object_class,
                  PROP_ACL,
diff --git a/libgupnp/gupnp.h b/libgupnp/gupnp.h
index 42ef2a8..10a3fe7 100644
--- a/libgupnp/gupnp.h
+++ b/libgupnp/gupnp.h
@@ -19,6 +19,7 @@
  * Boston, MA 02110-1301, USA.
  */
 
+#include "gupnp-acl.h"
 #include "gupnp-context.h"
 #include "gupnp-context-manager.h"
 #include "gupnp-control-point.h"