From 3e70ecbab850bcc08ee89e1256d82cca70d80ee7 Mon Sep 17 00:00:00 2001
From: Stef Walter <stefw@gnome.org>
Date: Mon, 21 Jan 2013 11:06:41 +0100
Subject: Add public iterator API to p11-kit

---
 doc/Makefile.am             |  1 +
 doc/annotation-glossary.xml | 67 +++++++++++++++++++++++++++++++++++++++++++++
 doc/p11-kit-docs.sgml       |  3 ++
 doc/p11-kit-sections.txt    | 17 ++++++++++++
 4 files changed, 88 insertions(+)
 create mode 100644 doc/annotation-glossary.xml

(limited to 'doc')

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 3154215..e5befe7 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -69,6 +69,7 @@ content_files=p11-kit-config.xml p11-kit-sharing.xml \
 	p11-kit-devel.xml \
 	p11-kit-trust.xml \
 	p11-kit.xml \
+	annotation-glossary.xml \
 	$(NULL)
 
 # SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
diff --git a/doc/annotation-glossary.xml b/doc/annotation-glossary.xml
new file mode 100644
index 0000000..4a0f8a6
--- /dev/null
+++ b/doc/annotation-glossary.xml
@@ -0,0 +1,67 @@
+<?xml version="1.0"?>
+<!DOCTYPE glossary PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!ENTITY version SYSTEM "version.xml">
+]>
+
+<glossary id="annotation-glossary">
+<title>Annotation Glossary</title>
+<glossdiv><title>A</title>
+	<glossentry>
+		<glossterm><anchor id="annotation-glossterm-allow-none"/>allow-none</glossterm>
+		<glossdef>
+			<para>NULL is ok, both for passing and for returning.</para>
+		</glossdef>
+	</glossentry>
+	<glossentry>
+		<glossterm><anchor id="annotation-glossterm-array"/>array</glossterm>
+		<glossdef>
+			<para>Parameter points to an array of items.</para>
+		</glossdef>
+	</glossentry>
+</glossdiv>
+<glossdiv><title>E</title>
+	<glossentry>
+		<glossterm><anchor id="annotation-glossterm-element-type"/>element-type</glossterm>
+		<glossdef>
+			<para>Generics and defining elements of containers and arrays.</para>
+		</glossdef>
+	</glossentry>
+</glossdiv>
+<glossdiv><title>I</title>
+	<glossentry>
+		<glossterm><anchor id="annotation-glossterm-inout"/>inout</glossterm>
+		<glossdef>
+			<para>Parameter for input and for returning results. Default is <acronym>transfer full</acronym>.</para>
+		</glossdef>
+	</glossentry>
+</glossdiv>
+<glossdiv><title>O</title>
+	<glossentry>
+		<glossterm><anchor id="annotation-glossterm-out"/>out</glossterm>
+		<glossdef>
+			<para>Parameter for returning results. Default is <acronym>transfer full</acronym>.</para>
+		</glossdef>
+	</glossentry>
+</glossdiv>
+<glossdiv><title>T</title>
+	<glossentry>
+		<glossterm><anchor id="annotation-glossterm-transfer full"/>transfer full</glossterm>
+		<glossdef>
+			<para>Free data after the code is done.</para>
+		</glossdef>
+	</glossentry>
+	<glossentry>
+		<glossterm><anchor id="annotation-glossterm-type"/>type</glossterm>
+		<glossdef>
+			<para>Override the parsed C type with given type</para>
+		</glossdef>
+	</glossentry>
+	<glossentry>
+		<glossterm><anchor id="annotation-glossterm-transfer none"/>transfer none</glossterm>
+		<glossdef>
+			<para>Don't free data after the code is done.</para>
+		</glossdef>
+	</glossentry>
+</glossdiv>
+</glossary>
\ No newline at end of file
diff --git a/doc/p11-kit-docs.sgml b/doc/p11-kit-docs.sgml
index 5627f6f..7138690 100644
--- a/doc/p11-kit-docs.sgml
+++ b/doc/p11-kit-docs.sgml
@@ -27,10 +27,13 @@
 		<xi:include href="xml/p11-kit-pin.xml"/>
 		<xi:include href="xml/p11-kit-util.xml"/>
 		<xi:include href="xml/p11-kit-future.xml"/>
+
 		<index id="api-index-full">
 			<title>API Index</title>
 			<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
 		</index>
+
+		<xi:include href="annotation-glossary.xml"/>
 	</chapter>
 
 	<xi:include href="p11-kit-devel.xml"/>
diff --git a/doc/p11-kit-sections.txt b/doc/p11-kit-sections.txt
index c6a4686..dc85f2d 100644
--- a/doc/p11-kit-sections.txt
+++ b/doc/p11-kit-sections.txt
@@ -86,4 +86,21 @@ p11_kit_set_progname
 p11_kit_be_quiet
 p11_kit_be_loud
 p11_kit_message
+p11_kit_destroyer
+P11KitIter
+p11_kit_iter_new
+p11_kit_iter_set_session_flags
+p11_kit_iter_add_callback
+p11_kit_iter_callback
+p11_kit_iter_add_filter
+p11_kit_iter_begin
+p11_kit_iter_begin_with
+p11_kit_iter_next
+p11_kit_iter_get_module
+p11_kit_iter_get_slot
+p11_kit_iter_get_session
+p11_kit_iter_keep_session
+p11_kit_iter_get_object
+p11_kit_iter_load_attributes
+p11_kit_iter_free
 </SECTION>
-- 
cgit v1.1