gck: Documentation fix up
authorStef Walter <stefw@collabora.co.uk>
Wed, 12 Oct 2011 10:29:41 +0000 (12:29 +0200)
committerStef Walter <stefw@collabora.co.uk>
Wed, 12 Oct 2011 10:29:41 +0000 (12:29 +0200)
.gitignore
docs/reference/gck/Makefile.am
docs/reference/gck/gck.interfaces
docs/reference/gck/gck.types [new file with mode: 0644]
gck/gck-enumerator.c
gck/gck-module.c
gck/gck-object.c
gck/gck-password.c
gck/gck-session.c
gck/gck-slot.c

index c45aa9e..6fd5bc0 100644 (file)
@@ -55,6 +55,7 @@ stamp-*
 /docs/reference/*/*.args
 /docs/reference/*/*.hierarchy
 /docs/reference/*/*.prerequisites
+/docs/reference/*/*.interfaces
 /docs/reference/*/*.signals
 /docs/reference/*/html
 /docs/reference/*/tmpl
index 98cbc34..460e0a0 100644 (file)
@@ -86,7 +86,7 @@ expand_content_files=
 # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
 # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
 GTKDOC_CFLAGS= -I$(top_srcdir) -I$(top_builddir) $(GLIB_CFLAGS) -Wno-error
-GTKDOC_LIBS= $(GLIB_LIBS) $(top_builddir)/$(DOC_MODULE)/lib$(DOC_MODULE).la
+GTKDOC_LIBS= $(GLIB_LIBS) $(top_builddir)/$(DOC_MODULE)/lib$(DOC_MODULE)-@GCK_MAJOR@.la
 
 # This includes the standard gtk-doc make rules, copied by gtkdocize.
 include $(top_srcdir)/gtk-doc.make
diff --git a/docs/reference/gck/gck.types b/docs/reference/gck/gck.types
new file mode 100644 (file)
index 0000000..b5c5d32
--- /dev/null
@@ -0,0 +1,15 @@
+gck_attribute_get_type
+gck_attributes_get_type
+gck_module_info_get_type
+gck_module_get_type
+gck_enumerator_get_type
+gck_slot_info_get_type
+gck_token_info_get_type
+gck_mechanism_info_get_type
+gck_slot_get_type
+gck_session_info_get_type
+gck_session_get_type
+gck_object_get_type
+gck_object_attributes_get_type
+gck_password_get_type
+gck_uri_data_get_type
index add0bee..1ac52dc 100644 (file)
@@ -51,7 +51,6 @@ enum {
 
 /**
  * GckEnumerator:
- * @parent: derived from this.
  *
  * An object that allows enumerating of objects across modules, tokens.
  */
@@ -790,9 +789,9 @@ gck_enumerator_get_object_type (GckEnumerator *self)
  * Set the type of objects to be created by this enumerator. The type must
  * always be either #GckObject or derived from it.
  *
- * If the #GckObjectClass:attribute_types and #GckObjectClass:n_attribute_types
- * are set in a derived class, then the derived class must have a property
- * called 'attributes' of boxed type GCK_TYPE_ATTRIBUTE.
+ * If the #GckObjectAttributes interface is implemented on the derived class
+ * and the attribute_types field is set, then the enumerator will retrieve
+ * attributes for each object.
  */
 void
 gck_enumerator_set_object_type (GckEnumerator *self,
index cdd9d45..5728a30 100644 (file)
@@ -47,7 +47,6 @@
 
 /**
  * GckModule:
- * @parent: derived from this.
  *
  * Holds a loaded and initialized PKCS\#11 module.
  */
index c7b1eb0..4690378 100644 (file)
@@ -39,7 +39,6 @@
 
 /**
  * GckObject:
- * @parent: derived from this.
  *
  * Represents a PKCS11 object handle such as a key or certifiacte.
  */
index 56200ea..f5edfc7 100644 (file)
@@ -42,7 +42,6 @@
 
 /**
  * GckPassword:
- * @parent: parent object
  *
  * A #GTlsPasswordClass that contains information about the PKCS\#11 token
  * or key the password is being requested for.
index 3382051..92542ec 100644 (file)
@@ -44,7 +44,6 @@
 
 /**
  * GckSession:
- * @parent: derived from this.
  *
  * Represents an open PKCS11 session.
  */
@@ -301,8 +300,7 @@ gck_session_class_init (GckSessionClass *klass)
         * When a GckSession is being disposed of it emits this signal to allow
         * a session pool to pick up the handle and keep it around.
         *
-        * If no signal handler claims the handle, then it is closed. This is used by
-        * gck_module_set_pool_sessions() to implement the module session pool.
+        * If no signal handler claims the handle, then it is closed.
         *
         * Returns: Whether or not this handle was claimed.
         */
index 2be6a83..b937ca8 100644 (file)
@@ -41,7 +41,6 @@
 
 /**
  * GckSlot:
- * @parent: derived from this.
  *
  * Represents a PKCS11 slot.
  */