Reference documentation

7 files changed, 404 insertions, 0 deletions

diff --git a/docs/reference/libsecret/Makefile.am b/docs/reference/libsecret/Makefile.am
new file mode 100644
index 0000000..33bc1ce
--- /dev/null
+++ b/docs/reference/libsecret/Makefile.am
@@ -0,0 +1,102 @@
+## Process this file with automake to produce Makefile.in
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# This is a blank Makefile.am for using gtk-doc.
+# Copy this to your project's API docs directory and modify the variables to
+# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
+# of using the various options.
+
+# The name the module, e.g. 'glib'.
+DOC_MODULE=libsecret
+
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+DOC_MODULE_VERSION=@SECRET_MAJOR@
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# The directory containing the source code. Relative to $(srcdir).
+# gtk-doc will search all .c & .h files beneath here for inline comments
+# documenting the functions and macros.
+# e.g. DOC_SOURCE_DIR=../../../gtk
+DOC_SOURCE_DIR=$(top_srcdir)/library
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS=
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCAN_OPTIONS=--deprecated-guards="SECRET_DISABLE_DEPRECATED"
+
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-mktmpl
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+MKTMPL_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkhtml
+MKHTML_OPTIONS=
+
+# Extra options to supply to gtkdoc-fixref. Not normally needed.
+# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
+FIXXREF_OPTIONS=
+
+# Used for dependencies. The docs will be rebuilt if any of these change.
+# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
+# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
+HFILE_GLOB=$(top_srcdir)/library/*.h
+CFILE_GLOB=$(top_srcdir)/library/*.c
+
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+EXTRA_HFILES=
+
+# Header files to ignore when scanning. Use base file name, no paths
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES= \
+	mock-service.h \
+	secret-dbus-generated.h \
+	secret-private.h \
+	$(NULL)
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+HTML_IMAGES=
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
+content_files=
+
+# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# These files must be listed here *and* in content_files
+# e.g. expand_content_files=running.sgml
+expand_content_files=
+
+# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
+# Only needed if you are using gtkdoc-scangobj to dynamically query widget
+# signals and properties.
+# 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) $(GOBJECT_LIBS) \
+	$(top_builddir)/library/libsecret-@SECRET_MAJOR@.la
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+# e.g. EXTRA_DIST += version.xml.in
+# EXTRA_DIST +=
+
+# Files not to distribute
+# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
+# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
+DISTCLEANFILES = tmpl/secret-unused.sgml
+
+# Comment this out if you want your docs-status tested during 'make check'
+#TESTS_ENVIRONMENT = cd $(srcsrc)
+#TESTS = $(GTKDOC_CHECK)
diff --git a/docs/reference/libsecret/libsecret-docs.sgml b/docs/reference/libsecret/libsecret-docs.sgml
new file mode 100644
index 0000000..cd8a762
--- /dev/null
+++ b/docs/reference/libsecret/libsecret-docs.sgml
@@ -0,0 +1,34 @@
+<?xml version="1.0"?>
+<!DOCTYPE book 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">
+]>
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+	<bookinfo>
+		<title>Libsecret Library Reference Manual</title>
+		<releaseinfo>
+			for libsecret &version;.
+			An online version of this documentation can be found at
+			<ulink role="online-location" url="http://developer.gnome.org/libsecret/stable/">http://developer.gnome.org/libsecret/stable/</ulink>.
+		</releaseinfo>
+	</bookinfo>
+
+	<part id="simple">
+		<title>Simple API</title>
+		<xi:include href="xml/secret-password.xml"/>
+	</part>
+
+	<part id="complete">
+		<title>Complete API</title>
+		<xi:include href="xml/secret-service.xml"/>
+		<xi:include href="xml/secret-collection.xml"/>
+		<xi:include href="xml/secret-item.xml"/>
+		<xi:include href="xml/secret-value.xml"/>
+		<xi:include href="xml/secret-prompt.xml"/>
+		<xi:include href="xml/secret-error.xml"/>
+	</part>
+
+	<xi:include href="xml/annotation-glossary.xml">
+		<xi:fallback />
+	</xi:include>
+</book>
diff --git a/docs/reference/libsecret/libsecret-overrides.txt b/docs/reference/libsecret/libsecret-overrides.txt
new file mode 100644
index 0000000..13f485f
--- /dev/null
+++ b/docs/reference/libsecret/libsecret-overrides.txt
@@ -0,0 +1,2 @@
+# These are manually-edited to override or add declarations to those scanned
+# from the header files.
diff --git a/docs/reference/libsecret/libsecret-sections.txt b/docs/reference/libsecret/libsecret-sections.txt
new file mode 100644
index 0000000..ee86fcd
--- /dev/null
+++ b/docs/reference/libsecret/libsecret-sections.txt
@@ -0,0 +1,252 @@
+<SECTION>
+<FILE>secret-collection</FILE>
+SecretCollection
+SecretCollectionClass
+secret_collection_new
+secret_collection_new_finish
+secret_collection_new_sync
+secret_collection_create
+secret_collection_create_finish
+secret_collection_create_sync
+secret_collection_delete
+secret_collection_delete_finish
+secret_collection_delete_sync
+secret_collection_get_created
+secret_collection_get_items
+secret_collection_get_label
+secret_collection_set_label
+secret_collection_set_label_finish
+secret_collection_set_label_sync
+secret_collection_get_locked
+secret_collection_get_modified
+secret_collection_refresh
+<SUBSECTION Standard>
+SECRET_COLLECTION
+SECRET_COLLECTION_CLASS
+SECRET_COLLECTION_GET_CLASS
+SECRET_IS_COLLECTION
+SECRET_IS_COLLECTION_CLASS
+SECRET_TYPE_COLLECTION
+SecretCollectionPrivate
+secret_collection_get_type
+</SECTION>
+
+<SECTION>
+<FILE>secret-item</FILE>
+SecretItem
+SecretItemClass
+secret_item_new
+secret_item_new_finish
+secret_item_new_sync
+secret_item_create
+secret_item_create_finish
+secret_item_create_sync
+secret_item_delete
+secret_item_delete_finish
+secret_item_delete_sync
+secret_item_get_attributes
+secret_item_set_attributes
+secret_item_set_attributes_finish
+secret_item_set_attributes_sync
+secret_item_get_created
+secret_item_get_label
+secret_item_set_label
+secret_item_set_label_finish
+secret_item_set_label_sync
+secret_item_get_locked
+secret_item_get_modified
+secret_item_get_schema
+secret_item_get_secret
+secret_item_get_secret_finish
+secret_item_get_secret_sync
+secret_item_set_secret
+secret_item_set_secret_finish
+secret_item_set_secret_sync
+secret_item_refresh
+<SUBSECTION Standard>
+SECRET_IS_ITEM
+SECRET_IS_ITEM_CLASS
+SECRET_ITEM
+SECRET_ITEM_CLASS
+SECRET_ITEM_GET_CLASS
+SECRET_TYPE_ITEM
+SecretItemPrivate
+secret_item_get_type
+</SECTION>
+
+<SECTION>
+<FILE>secret-error</FILE>
+SECRET_ERROR
+SecretError
+<SUBSECTION Standard>
+SECRET_TYPE_ERROR
+secret_error_get_quark
+secret_error_get_type
+</SECTION>
+
+<SECTION>
+<FILE>secret-password</FILE>
+SecretSchema
+SecretSchemaType
+secret_password_store
+secret_password_storev
+secret_password_store_finish
+secret_password_store_sync
+secret_password_storev_sync
+secret_password_lookup
+secret_password_lookupv
+secret_password_lookup_finish
+secret_password_lookup_sync
+secret_password_lookupv_sync
+secret_password_remove
+secret_password_removev
+secret_password_remove_finish
+secret_password_remove_sync
+secret_password_removev_sync
+secret_password_free
+<SUBSECTION Standard>
+SECRET_TYPE_SCHEMA_TYPE
+secret_schema_type_get_type
+</SECTION>
+
+<SECTION>
+<FILE>secret-prompt</FILE>
+SecretPrompt
+SecretPromptClass
+secret_prompt_get_result_value
+secret_prompt_perform
+secret_prompt_perform_finish
+secret_prompt_perform_sync
+secret_prompt_run
+<SUBSECTION Standard>
+SECRET_IS_PROMPT
+SECRET_IS_PROMPT_CLASS
+SECRET_PROMPT
+SECRET_PROMPT_CLASS
+SECRET_PROMPT_GET_CLASS
+SECRET_TYPE_PROMPT
+SecretPromptPrivate
+secret_prompt_get_type
+</SECTION>
+
+<SECTION>
+<FILE>secret-service</FILE>
+SecretService
+SecretServiceClass
+SecretServiceFlags
+secret_service_get
+secret_service_get_sync
+secret_service_get_finish
+secret_service_new
+secret_service_new_finish
+secret_service_new_sync
+secret_service_get_collections
+secret_service_get_flags
+secret_service_get_session_algorithms
+secret_service_get_session_path
+secret_service_ensure_session
+secret_service_ensure_session_finish
+secret_service_ensure_session_sync
+secret_service_ensure_collections
+secret_service_ensure_collections_finish
+secret_service_ensure_collections_sync
+secret_service_search
+secret_service_search_finish
+secret_service_search_sync
+secret_service_search_for_paths
+secret_service_search_for_paths_finish
+secret_service_search_for_paths_sync
+secret_service_get_secrets
+secret_service_get_secrets_finish
+secret_service_get_secrets_sync
+secret_service_get_secrets_for_paths
+secret_service_get_secrets_for_paths_finish
+secret_service_get_secrets_for_paths_sync
+secret_service_get_secret_for_path
+secret_service_get_secret_for_path_finish
+secret_service_get_secret_for_path_sync
+secret_service_lock
+secret_service_lock_finish
+secret_service_lock_sync
+secret_service_lock_paths
+secret_service_lock_paths_finish
+secret_service_lock_paths_sync
+secret_service_unlock
+secret_service_unlock_finish
+secret_service_unlock_sync
+secret_service_unlock_paths
+secret_service_unlock_paths_finish
+secret_service_unlock_paths_sync
+secret_service_store
+secret_service_storev
+secret_service_store_finish
+secret_service_store_sync
+secret_service_storev_sync
+secret_service_lookup
+secret_service_lookupv
+secret_service_lookup_finish
+secret_service_lookup_sync
+secret_service_lookupv_sync
+secret_service_remove
+secret_service_removev
+secret_service_remove_finish
+secret_service_remove_sync
+secret_service_removev_sync
+secret_service_prompt
+secret_service_prompt_finish
+secret_service_prompt_sync
+secret_service_create_collection_path
+secret_service_create_collection_path_finish
+secret_service_create_collection_path_sync
+secret_service_create_item_path
+secret_service_create_item_path_finish
+secret_service_create_item_path_sync
+secret_service_delete_path
+secret_service_delete_path_finish
+secret_service_delete_path_sync
+<SUBSECTION Standard>
+SECRET_IS_SERVICE
+SECRET_IS_SERVICE_CLASS
+SECRET_SERVICE
+SECRET_SERVICE_CLASS
+SECRET_SERVICE_GET_CLASS
+SECRET_TYPE_SERVICE
+SECRET_TYPE_SERVICE_FLAGS
+SecretServicePrivate
+secret_service_flags_get_type
+secret_service_get_type
+</SECTION>
+
+<SECTION>
+<FILE>secret-value</FILE>
+SecretValue
+secret_value_new
+secret_value_new_full
+secret_value_get
+secret_value_get_content_type
+secret_value_ref
+secret_value_unref
+<SUBSECTION Standard>
+SECRET_TYPE_VALUE
+secret_value_get_type
+</SECTION>
+
+<SECTION>
+<FILE>SecretGenService</FILE>
+</SECTION>
+
+<SECTION>
+<FILE>SecretGenCollection</FILE>
+</SECTION>
+
+<SECTION>
+<FILE>SecretGenItem</FILE>
+</SECTION>
+
+<SECTION>
+<FILE>SecretGenSession</FILE>
+</SECTION>
+
+<SECTION>
+<FILE>SecretGenPrompt</FILE>
+</SECTION>
diff --git a/docs/reference/libsecret/libsecret.interfaces b/docs/reference/libsecret/libsecret.interfaces
new file mode 100644
index 0000000..ac03c45
--- /dev/null
+++ b/docs/reference/libsecret/libsecret.interfaces
@@ -0,0 +1,6 @@
+GDBusProxy GDBusInterface GInitable GAsyncInitable
+SecretCollection GDBusInterface GInitable GAsyncInitable
+SecretItem GDBusInterface GInitable GAsyncInitable
+SecretPrompt GDBusInterface GInitable GAsyncInitable
+SecretService GDBusInterface GInitable GAsyncInitable
+GDBusConnection GInitable GAsyncInitable
diff --git a/docs/reference/libsecret/libsecret.types b/docs/reference/libsecret/libsecret.types
new file mode 100644
index 0000000..f9bfa7a
--- /dev/null
+++ b/docs/reference/libsecret/libsecret.types
@@ -0,0 +1,7 @@
+secret_collection_get_type
+secret_error_get_type
+secret_item_get_type
+secret_prompt_get_type
+secret_value_get_type
+secret_service_flags_get_type
+secret_service_get_type
\ No newline at end of file
diff --git a/docs/reference/libsecret/version.xml.in b/docs/reference/libsecret/version.xml.in
new file mode 100644
index 0000000..27323da
--- /dev/null
+++ b/docs/reference/libsecret/version.xml.in
@@ -0,0 +1 @@
+@VERSION@
\ No newline at end of file