GNOME.org
 

[gnome-keyring/dbus-api] Build docs for the secrets API.

commit 691990ce1859191fe6025b90bfbe26af320fb738
Author: Stef Walter <stef memberwebs com>
Date:   Sat Jun 20 01:04:12 2009 +0000

    Build docs for the secrets API.

 .gitignore                               |   36 +++++-----
 configure.in                             |    1 +
 docs/reference/.gitignore                |   15 ++++
 docs/reference/Makefile.am               |    2 +-
 docs/reference/gcr/.gitignore            |   17 -----
 docs/reference/gnome-keyring/.gitignore  |   17 -----
 docs/reference/gp11/.gitignore           |   17 -----
 docs/reference/secrets/.gitignore        |   12 ++++
 docs/reference/secrets/Makefile.am       |  104 ++++++++++++++++++++++++++++++
 docs/reference/secrets/empty/EMPTY       |    1 +
 docs/reference/secrets/secrets-docs.sgml |   39 +++++++++++
 11 files changed, 191 insertions(+), 70 deletions(-)
---
diff --git a/.gitignore b/.gitignore
index 0c6ad24..906d2bd 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,14 +1,25 @@
 *~
+*.o
+*.la
+*.lo
+*.a
 *.bak
+*.tmp
+*.prj
+*.pws
+*.anjuta
+*.tar.gz
+.*project
+.settings
+*.orig
+*.stamp
+.deps
+.libs
+stamp-*
+Makefile
+Makefile.in
 /compile
-/*.tmp
-/*.prj
-/*.pws
-/*.anjuta
-/*.tar.gz
 /ABOUT-NLS
-/Makefile
-/Makefile.in
 /aclocal.m4
 /autom4te.cache
 /confdefs.h
@@ -34,9 +45,6 @@
 /missing
 /mkinstalldirs
 /obj
-/stamp-h
-/stamp-h1
-/stamp-h.in
 /gnome-keyring-ask
 /gnome-keyring-daemon
 /list-keyrings
@@ -48,12 +56,4 @@
 /depcomp
 /junk
 /TODO.tasks
-*.o
-*.la
-*.lo
-*.a
-.*project
-.settings
-*.orig
-*.stamp
 
diff --git a/configure.in b/configure.in
index 287d134..ee83ae4 100644
--- a/configure.in
+++ b/configure.in
@@ -557,6 +557,7 @@ docs/reference/Makefile
 docs/reference/gcr/Makefile
 docs/reference/gnome-keyring/Makefile
 docs/reference/gp11/Makefile
+docs/reference/secrets/Makefile
 egg/Makefile
 egg/tests/Makefile
 gcr/gcr.pc
diff --git a/docs/reference/.gitignore b/docs/reference/.gitignore
index 22a4e72..72e1692 100644
--- a/docs/reference/.gitignore
+++ b/docs/reference/.gitignore
@@ -1,3 +1,18 @@
+# Autotools files
 Makefile
 Makefile.in
 
+# Directories created by gtk-doc
+xml/
+tmpl/
+html/
+
+# Files generated by gtk-doc
+*.stamp
+
+# Reports generated by gtk-doc
+*-undeclared.txt
+*-undocumented.txt
+*-unused.txt
+
+
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index bcf7830..2a5efe2 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -1,2 +1,2 @@
 
-SUBDIRS = gcr gnome-keyring gp11
+SUBDIRS = gcr gnome-keyring gp11 secrets
diff --git a/docs/reference/gcr/.gitignore b/docs/reference/gcr/.gitignore
index a769990..d4bd33b 100644
--- a/docs/reference/gcr/.gitignore
+++ b/docs/reference/gcr/.gitignore
@@ -1,20 +1,3 @@
-Makefile
-Makefile.in
-.libs
-
-# Directories created by gtk-doc
-tmpl
-html
-xml
-
-# Files generated by gtk-doc
-*.stamp
-
-# Reports generated by gtk-doc
-*-undeclared.txt
-*-undocumented.txt
-*-unused.txt
-
 # Commit these files if you edit them
 *-decl-list.txt
 *-decl.txt
diff --git a/docs/reference/gnome-keyring/.gitignore b/docs/reference/gnome-keyring/.gitignore
index a769990..d4bd33b 100644
--- a/docs/reference/gnome-keyring/.gitignore
+++ b/docs/reference/gnome-keyring/.gitignore
@@ -1,20 +1,3 @@
-Makefile
-Makefile.in
-.libs
-
-# Directories created by gtk-doc
-tmpl
-html
-xml
-
-# Files generated by gtk-doc
-*.stamp
-
-# Reports generated by gtk-doc
-*-undeclared.txt
-*-undocumented.txt
-*-unused.txt
-
 # Commit these files if you edit them
 *-decl-list.txt
 *-decl.txt
diff --git a/docs/reference/gp11/.gitignore b/docs/reference/gp11/.gitignore
index a769990..d4bd33b 100644
--- a/docs/reference/gp11/.gitignore
+++ b/docs/reference/gp11/.gitignore
@@ -1,20 +1,3 @@
-Makefile
-Makefile.in
-.libs
-
-# Directories created by gtk-doc
-tmpl
-html
-xml
-
-# Files generated by gtk-doc
-*.stamp
-
-# Reports generated by gtk-doc
-*-undeclared.txt
-*-undocumented.txt
-*-unused.txt
-
 # Commit these files if you edit them
 *-decl-list.txt
 *-decl.txt
diff --git a/docs/reference/secrets/.gitignore b/docs/reference/secrets/.gitignore
new file mode 100644
index 0000000..9fc3e57
--- /dev/null
+++ b/docs/reference/secrets/.gitignore
@@ -0,0 +1,12 @@
+# Commit these files if you edit them
+*-decl-list.txt
+*-decl.txt
+*-overrides.txt
+*.args
+*.hierarchy
+*.interfaces
+*.prerequisites
+*.signals
+*.types
+*-sections.txt
+
diff --git a/docs/reference/secrets/Makefile.am b/docs/reference/secrets/Makefile.am
new file mode 100644
index 0000000..5c047c1
--- /dev/null
+++ b/docs/reference/secrets/Makefile.am
@@ -0,0 +1,104 @@
+## 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 of the module, e.g. 'glib'.
+DOC_MODULE=secrets
+
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+#DOC_MODULE_VERSION=2
+
+
+# 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=empty
+
+# 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=
+
+# 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=
+CFILE_GLOB=
+
+# 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=
+
+# 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 =  			    								\
+	$(top_builddir)/daemon/secrets/api/docbook-interface-org.freedesktop.Secrets.Collection.xml	\
+	$(top_builddir)/daemon/secrets/api/docbook-interface-org.freedesktop.Secrets.Item.xml		\
+	$(top_builddir)/daemon/secrets/api/docbook-interface-org.freedesktop.Secrets.Service.xml	\
+	$(top_builddir)/daemon/secrets/api/docbook-interface-org.freedesktop.Secrets.Session.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. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+GTKDOC_CFLAGS=
+GTKDOC_LIBS=
+
+# 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 +=
+
+# 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/secrets/empty/EMPTY b/docs/reference/secrets/empty/EMPTY
new file mode 100644
index 0000000..93933a2
--- /dev/null
+++ b/docs/reference/secrets/empty/EMPTY
@@ -0,0 +1 @@
+An empty directory to placate gtk-doc, and this file to placate git. 
\ No newline at end of file
diff --git a/docs/reference/secrets/secrets-docs.sgml b/docs/reference/secrets/secrets-docs.sgml
new file mode 100644
index 0000000..38c8b93
--- /dev/null
+++ b/docs/reference/secrets/secrets-docs.sgml
@@ -0,0 +1,39 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd";
+[
+  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+]>
+<book id="index">
+  <bookinfo>
+    <title>secrets Reference Manual</title>
+    <releaseinfo>
+      for secrets [VERSION]
+      The latest version of this documentation can be found on-line at
+      <ulink role="online-location" url="http://[SERVER]/secrets/index.html";>http://[SERVER]/secrets/</ulink>.
+    </releaseinfo>
+  </bookinfo>
+
+  <part id="ref-dbus-api">
+    <title>D-Bus API Reference</title>
+    <xi:include href="../../../daemon/secrets/api/docbook-interface-org.freedesktop.Secrets.Collection.xml"/>
+    <xi:include href="../../../daemon/secrets/api/docbook-interface-org.freedesktop.Secrets.Item.xml"/>
+    <xi:include href="../../../daemon/secrets/api/docbook-interface-org.freedesktop.Secrets.Service.xml"/>
+    <xi:include href="../../../daemon/secrets/api/docbook-interface-org.freedesktop.Secrets.Session.xml"/>
+  </part>
+
+  <chapter>
+    <title>[Insert title here]</title>
+    
+  </chapter>
+  <chapter id="object-tree">
+    <title>Object Hierarchy</title>
+     <xi:include href="xml/tree_index.sgml"/>
+  </chapter>
+  <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="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]