From 479cbd55ee5739d3cd2566379575451dbecf4c54 Mon Sep 17 00:00:00 2001 From: Stef Walter Date: Thu, 31 Mar 2011 12:41:43 +0200 Subject: Documentation and API cleanup. * Rename source directory * More consistent with return values from URI functions. * Allow formatting URI to take a uri type. --- doc/Makefile.am | 80 ++++++++++++++++++++++++++++++++++++++--------- doc/p11-kit-docs.sgml | 24 ++++++++++++++ doc/p11-kit-overrides.txt | 0 doc/p11-kit-sections.txt | 40 ++++++++++++++++++++++++ doc/version.xml.in | 1 + 5 files changed, 130 insertions(+), 15 deletions(-) create mode 100644 doc/p11-kit-docs.sgml create mode 100644 doc/p11-kit-overrides.txt create mode 100644 doc/p11-kit-sections.txt create mode 100644 doc/version.xml.in (limited to 'doc') diff --git a/doc/Makefile.am b/doc/Makefile.am index 52c269b..b18d86a 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,22 +1,72 @@ +abs_top_builddir = @abs_top_builddir@ -# p11-kit-glue.xml +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 -PARTS = \ - p11-kit-config.xml \ - p11-kit-multiple-problem.xml +# The name of the module, e.g. 'glib'. +DOC_MODULE=p11-kit -BOOK = \ - p11-kit.xml +# The top-level SGML file. You can change this if you want to. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml -DOCUMENTS = \ - html/p11-kit.html +# 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=../p11-kit -all-local: $(DOCUMENTS) +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS= --version -html/p11-kit.html: $(BOOK) $(PARTS) - xmlto --skip-validation -vv html-nochunks -o html/ p11-kit.xml +# Extra options to supply to gtkdoc-scan. +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS= --rebuild-types -EXTRA_DIST = \ - $(BOOK) \ - $(PARTS) \ - docbook-params.xsl +# 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-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)/p11-kit/p11-kit-*.h +CFILE_GLOB=$(top_srcdir)/p11-kit/p11-kit-*.c + +# Header files to ignore when scanning. +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES= p11-kit-private.h pkcs11.h hash.h conf.h util.h + +# 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=p11-kit-config.xml p11-kit-multiple-problem.xml + +# 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. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +INCLUDES= +GTKDOC_LIBS= + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.make + +EXTRA_DIST += \ + version.xml.in diff --git a/doc/p11-kit-docs.sgml b/doc/p11-kit-docs.sgml new file mode 100644 index 0000000..03fd582 --- /dev/null +++ b/doc/p11-kit-docs.sgml @@ -0,0 +1,24 @@ + + + +]> + + + P11-Kit Manual + for p11-kit &version; + + + + Reference + + + + + API Index + + + + diff --git a/doc/p11-kit-overrides.txt b/doc/p11-kit-overrides.txt new file mode 100644 index 0000000..e69de29 diff --git a/doc/p11-kit-sections.txt b/doc/p11-kit-sections.txt new file mode 100644 index 0000000..fbe7452 --- /dev/null +++ b/doc/p11-kit-sections.txt @@ -0,0 +1,40 @@ +
+p11-kit-uri +P11_KIT_URI_SCHEME +P11_KIT_URI_SCHEME_LEN +P11KitUriType +P11KitUriResult +P11KitUri +p11_kit_uri_new +p11_kit_uri_get_module_info +p11_kit_uri_match_module_info +p11_kit_uri_get_token_info +p11_kit_uri_match_token_info +p11_kit_uri_get_attribute_types +p11_kit_uri_get_attribute +p11_kit_uri_set_attribute +p11_kit_uri_clear_attribute +p11_kit_uri_match_attributes +p11_kit_uri_set_unrecognized +p11_kit_uri_any_unrecognized +p11_kit_uri_format +p11_kit_uri_parse +p11_kit_uri_free +
+ +
+p11-kit +p11_kit_initialize_registered +p11_kit_finalize_registered +p11_kit_registered_modules +p11_kit_registered_module_to_name +p11_kit_registered_name_to_module +p11_kit_registered_option +p11_kit_initialize_module +p11_kit_finalize_module +
+ +
+p11-kit-util +p11_kit_strerror +
\ No newline at end of file diff --git a/doc/version.xml.in b/doc/version.xml.in new file mode 100644 index 0000000..27323da --- /dev/null +++ b/doc/version.xml.in @@ -0,0 +1 @@ +@VERSION@ \ No newline at end of file -- cgit v1.1