fix up docs

diff --git a/configure.ac b/configure.ac
index db31cf1..c526662 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -419,6 +419,7 @@ docs/version.xml
 docs/Makefile
 docs/polkit/Makefile
 docs/polkitbackend/Makefile
+docs/polkitagent/Makefile
 docs/man/Makefile
 po/Makefile.in
 ])

diff --git a/docs/Makefile.am b/docs/Makefile.am
index a349fad..3c4336d 100644 (file)
--- 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 (file)
--- 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 (file)
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 (file)
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>

diff --git a/src/polkit/polkiterror.c b/src/polkit/polkiterror.c
index 604b9c7..0d9f39d 100644 (file)
--- a/src/polkit/polkiterror.c
+++ b/src/polkit/polkiterror.c
@@ -26,6 +26,14 @@
 #include "polkiterror.h"
 #include "polkitprivate.h"
 
+/**
+ * SECTION:polkiterror
+ * @title: PolkitError
+ * @short_description: Error codes
+ *
+ * Error codes.
+ */
+
 GQuark
 polkit_error_quark (void)
 {

diff --git a/src/polkit/polkitidentity.c b/src/polkit/polkitidentity.c
index 36436af..f1eb852 100644 (file)
--- a/src/polkit/polkitidentity.c
+++ b/src/polkit/polkitidentity.c
@@ -31,6 +31,14 @@
 #include "polkiterror.h"
 #include "polkitprivate.h"
 
+/**
+ * SECTION:polkitidentity
+ * @title: PolkitIdentity
+ * @short_description: Identities
+ *
+ * Identities.
+ */
+
 static void
 base_init (gpointer g_iface)
 {

diff --git a/src/polkit/polkitimplicitauthorization.c b/src/polkit/polkitimplicitauthorization.c
index d2b59fb..5723335 100644 (file)
--- a/src/polkit/polkitimplicitauthorization.c
+++ b/src/polkit/polkitimplicitauthorization.c
@@ -31,7 +31,7 @@
 /**
  * SECTION:polkitimplicitauthorization
  * @title: PolkitImplicitAuthorization
- * @short_result: Implicit Authorizations
+ * @short_description: Implicit Authorizations
  *
  * Possible implicit authorizations.
  */

diff --git a/src/polkit/polkitsubject.c b/src/polkit/polkitsubject.c
index 124a595..ba097f4 100644 (file)
--- a/src/polkit/polkitsubject.c
+++ b/src/polkit/polkitsubject.c
@@ -32,6 +32,14 @@
 #include "polkiterror.h"
 #include "polkitprivate.h"
 
+/**
+ * SECTION:polkitsubject
+ * @title: PolkitSubject
+ * @short_description: Subjects
+ *
+ * Subjects.
+ */
+
 static void
 base_init (gpointer g_iface)
 {

diff --git a/src/polkitagent/polkitagentauthenticationagent.c b/src/polkitagent/polkitagentauthenticationagent.c
index 5014b37..1be919c 100644 (file)
--- a/src/polkitagent/polkitagentauthenticationagent.c
+++ b/src/polkitagent/polkitagentauthenticationagent.c
@@ -26,6 +26,14 @@
 
 #include "polkitagentauthenticationagent.h"
 
+/**
+ * SECTION:polkitagentauthenticationagent
+ * @title: PolkitAgentAuthenticationAgent
+ * @short_description: Authentication Agent
+ *
+ * The #PolkitAgentAuthenticationAgent class is used for implementing authentication agents.
+ */
+
 struct _PolkitAgentAuthenticationAgent
 {
   GObject parent_instance;

diff --git a/src/polkitagent/polkitagentauthenticationsession.c b/src/polkitagent/polkitagentauthenticationsession.c
index 993313c..8d1a165 100644 (file)
--- a/src/polkitagent/polkitagentauthenticationsession.c
+++ b/src/polkitagent/polkitagentauthenticationsession.c
@@ -24,6 +24,14 @@
  *       And we REALLY REALLY really really should use signals instead of callbacks...
  */
 
+/**
+ * SECTION:polkitagentauthenticationsession
+ * @title: PolkitAgentAuthenticationSession
+ * @short_description: Authentcation Sessions
+ *
+ * The #PolkitAgentAuthenticationSession class is used for implementing authentication agents.
+ */
+
 
 /* for getline(), see below */
 #define _GNU_SOURCE

diff --git a/src/polkitbackend/polkitbackendlocalauthority.c b/src/polkitbackend/polkitbackendlocalauthority.c
index 3cb6c46..394967e 100644 (file)
--- a/src/polkitbackend/polkitbackendlocalauthority.c
+++ b/src/polkitbackend/polkitbackendlocalauthority.c
@@ -1591,7 +1591,7 @@ polkit_backend_local_authority_system_bus_name_owner_changed (PolkitBackendAutho
   local_authority = POLKIT_BACKEND_LOCAL_AUTHORITY (authority);
   priv = POLKIT_BACKEND_LOCAL_AUTHORITY_GET_PRIVATE (local_authority);
 
-  g_debug ("name-owner-changed: '%s' '%s' '%s'", name, old_owner, new_owner);
+  //g_debug ("name-owner-changed: '%s' '%s' '%s'", name, old_owner, new_owner);
 
   if (name[0] == ':' && strlen (new_owner) == 0)
     {

diff --git a/src/polkitbackend/polkitbackendserver.c b/src/polkitbackend/polkitbackendserver.c
index d89cb37..ae1940a 100644 (file)
--- a/src/polkitbackend/polkitbackendserver.c
+++ b/src/polkitbackend/polkitbackendserver.c
@@ -30,6 +30,14 @@
 #include "polkitbackendserver.h"
 #include "polkitbackendprivate.h"
 
+/**
+ * SECTION:polkitbackendserver
+ * @title: PolkitBackendServer
+ * @short_description: Proxies authorization backends
+ *
+ * The #PolkitBackendServer class is used for proxying #PolkitBackendAuthority instances on the system message bus.
+ */
+
 struct _PolkitBackendServer
 {
   GObject parent_instance;

diff --git a/src/polkitbackend/polkitbackendserver.h b/src/polkitbackend/polkitbackendserver.h
index 95567bf..62f4085 100644 (file)
--- a/src/polkitbackend/polkitbackendserver.h
+++ b/src/polkitbackend/polkitbackendserver.h
@@ -38,6 +38,9 @@ G_BEGIN_DECLS
 #define POLKIT_BACKEND_IS_SERVER(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), POLKIT_BACKEND_TYPE_SERVER))
 #define POLKIT_BACKEND_IS_SERVER_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), POLKIT_BACKEND_TYPE_SERVER))
 
+#if 0
+typedef struct _PolkitBackendServer    PolkitBackendServer;
+#endif
 typedef struct _PolkitBackendServerClass    PolkitBackendServerClass;
 
 GType                polkit_backend_server_get_type (void) G_GNUC_CONST;

diff --git a/src/polkitbackend/polkitbackendsessionmonitor.c b/src/polkitbackend/polkitbackendsessionmonitor.c
index 5e47f0a..212c3ef 100644 (file)
--- a/src/polkitbackend/polkitbackendsessionmonitor.c
+++ b/src/polkitbackend/polkitbackendsessionmonitor.c
@@ -28,6 +28,14 @@
 #include "polkitbackendsessionmonitor.h"
 #include "ckbindings.h"
 
+/**
+ * SECTION:polkitbackendsessionmonitor
+ * @title: PolkitBackendSessionMonitor
+ * @short_description: Monitor sessions
+ *
+ * The #PolkitBackendSessionMonitor is a utility class to track and monitor sessions.
+ */
+
 struct _PolkitBackendSessionMonitor
 {
   GObject parent_instance;