diff options
author | David Zeuthen <davidz@redhat.com> | 2009-01-21 01:01:58 -0500 |
---|---|---|
committer | David Zeuthen <davidz@redhat.com> | 2009-01-21 01:01:58 -0500 |
commit | 5dc7ed5e713415c448be9e31e7c8ec99c09b83b0 (patch) | |
tree | 1819674518ea890a6f7fa6b81e9305ef2894e1b3 /docs | |
parent | 13821cff7c2d31c9f990f6ac635c773dba060d97 (diff) |
fix up docs
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Makefile.am | 2 | ||||
-rw-r--r-- | docs/polkit/polkit-docs.xml | 49 | ||||
-rw-r--r-- | docs/polkitagent/Makefile.am | 88 | ||||
-rw-r--r-- | docs/polkitagent/polkitagent-docs.xml | 7 |
4 files changed, 119 insertions, 27 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index a349fad..3c4336d 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,4 +1,4 @@ -SUBDIRS = man polkitbackend polkit +SUBDIRS = man polkitbackend polkitagent polkit EXTRA_DIST = version.xml.in diff --git a/docs/polkit/polkit-docs.xml b/docs/polkit/polkit-docs.xml index 6a779f1..e37b9ab 100644 --- a/docs/polkit/polkit-docs.xml +++ b/docs/polkit/polkit-docs.xml @@ -56,18 +56,13 @@ </bookinfo> <reference id="ref-api"> - <title>API Reference</title> - <partintro> - <para> - This part presents the class and function reference for the - <literal>libpolkit-gobject-1</literal> library. - </para> - </partintro> + <title>Core API Reference</title> <xi:include href="xml/polkitauthority.xml"/> - <xi:include href="xml/polkitauthorizationclaim.xml"/> + <xi:include href="xml/polkiterror.xml"/> <xi:include href="xml/polkitauthorizationresult.xml"/> <xi:include href="xml/polkitactiondescription.xml"/> - <xi:include href="xml/polkiterror.xml"/> + <xi:include href="xml/polkitauthorization.xml"/> + <xi:include href="xml/polkitimplicitauthorization.xml"/> <chapter id="subjects"> <title>Subjects</title> <xi:include href="xml/polkitsubject.xml"/> @@ -81,26 +76,28 @@ <xi:include href="xml/polkitunixuser.xml"/> <xi:include href="xml/polkitunixgroup.xml"/> </chapter> - <chapter id="extending"> - <title>Extending PolicyKit</title> - <xi:include href="../polkitbackend/xml/polkitbackendauthority.xml"/> - <xi:include href="../polkitbackend/xml/polkitbackendlocalauthority.xml"/> - <xi:include href="../polkitbackend/xml/polkitbackendactionpool.xml"/> - <xi:include href="../polkitbackend/xml/polkitbackendserver.xml"/> - <xi:include href="../polkitbackend/xml/polkitbackendsessionmonitor.xml"/> - </chapter> </reference> - <chapter id="manpages"> - <title>Manual Pages</title> - <xi:include href="../man/PolicyKit.xml"/> - <xi:include href="../man/polkit.xml"/> - </chapter> + <reference id="ref-backend-api"> + <title>Backend API Reference</title> + <xi:include href="../polkitbackend/xml/polkitbackendauthority.xml"/> + <xi:include href="../polkitbackend/xml/polkitbackendlocalauthority.xml"/> + <xi:include href="../polkitbackend/xml/polkitbackendactionpool.xml"/> + <xi:include href="../polkitbackend/xml/polkitbackendserver.xml"/> + <xi:include href="../polkitbackend/xml/polkitbackendsessionmonitor.xml"/> + </reference> + + <reference id="ref-authentication-agent-api"> + <title>Authentication Agent API Reference</title> + <xi:include href="../polkitagent/xml/polkitagentauthenticationagent.xml"/> + <xi:include href="../polkitagent/xml/polkitagentauthenticationsession.xml"/> + </reference> - <chapter id="polkit-hierarchy"> - <title>Object Hierarchy</title> - <xi:include href="xml/tree_index.sgml"/> - </chapter> + <reference id="manpages"> + <title>Manual Pages</title> + <xi:include href="../man/PolicyKit.xml"/> + <xi:include href="../man/polkit.xml"/> + </reference> <index> <title>Index</title> diff --git a/docs/polkitagent/Makefile.am b/docs/polkitagent/Makefile.am new file mode 100644 index 0000000..248aa35 --- /dev/null +++ b/docs/polkitagent/Makefile.am @@ -0,0 +1,88 @@ + +NULL = + +AUTOMAKE_OPTIONS = 1.7 + +# The name of the module. +DOC_MODULE=polkitagent + +# The top-level SGML file. +DOC_MAIN_SGML_FILE=polkitagent-docs.xml + +# Extra options to supply to gtkdoc-scan +SCAN_OPTIONS=--ignore-headers=config.h + +# The directory containing the source code. Relative to $(srcdir) +DOC_SOURCE_DIR=../../src/polkitagent + +# Used for dependencies +HFILE_GLOB=$(top_srcdir)/src/polkitagent/*.h +CFILE_GLOB=$(top_srcdir)/src/polkitagent/*.c + +# Headers to ignore +IGNORE_HFILES= \ + $(NULL) + +# CFLAGS and LDFLAGS for compiling scan program. Only needed +# if $(DOC_MODULE).types is non-empty. +INCLUDES = \ + $(DBUS_GLIB_CFLAGS) \ + $(GLIB_CFLAGS) \ + $(GIO_CFLAGS) \ + -I$(top_srcdir)/src/polkitagent \ + -I$(top_builddir)/src/polkitagent \ + $(NULL) + +GTKDOC_LIBS = \ + $(DBUS_GLIB_LIBS) \ + $(GLIB_LIBS) \ + $(GIO_LIBS) \ + $(top_builddir)/src/polkit/libpolkit-gobject-1.la \ + $(top_builddir)/src/polkitagent/libpolkit-agent-1.la \ + $(NULL) + +# Extra options to supply to gtkdoc-mkdb +MKDB_OPTIONS=--sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-mktmpl +MKTMPL_OPTIONS= + +# Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE) +content_files = \ + ../version.xml \ + $(NULL) + +# Images to copy into HTML directory +HTML_IMAGES = \ + $(NULL) + +# Extra options to supply to gtkdoc-fixref +FIXXREF_OPTIONS= + +MAINTAINERCLEANFILES = \ + *~ \ + Makefile.in \ + polkitagent.types \ + polkit-*.txt \ + $(NULL) + +if ENABLE_GTK_DOC +include $(top_srcdir)/gtk-doc.make +else +CLEANFILES = +endif + +CLEANFILES += *~ \ + polkitagent-scan.* \ + polkitagent.* \ + *.bak \ + polkitagent-decl-list.txt \ + polkitagent-decl.txt \ + polkitagent-overrides.txt \ + polkitagent-undeclared.txt \ + polkitagent-undocumented.txt \ + polkitagent-sections.txt \ + *.stamp \ + -rf html xml \ + $(NULL) + diff --git a/docs/polkitagent/polkitagent-docs.xml b/docs/polkitagent/polkitagent-docs.xml new file mode 100644 index 0000000..7a56075 --- /dev/null +++ b/docs/polkitagent/polkitagent-docs.xml @@ -0,0 +1,7 @@ +<?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"> +</book> |