Commit 5dc7ed5e authored by David Zeuthen's avatar David Zeuthen

fix up docs

parent 13821cff
......@@ -419,6 +419,7 @@ docs/version.xml
docs/Makefile
docs/polkit/Makefile
docs/polkitbackend/Makefile
docs/polkitagent/Makefile
docs/man/Makefile
po/Makefile.in
])
......
SUBDIRS = man polkitbackend polkit
SUBDIRS = man polkitbackend polkitagent polkit
EXTRA_DIST = version.xml.in
......@@ -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>
......
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)
<?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>
......@@ -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)
{
......
......@@ -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)
{
......
......@@ -31,7 +31,7 @@
/**
* SECTION:polkitimplicitauthorization
* @title: PolkitImplicitAuthorization
* @short_result: Implicit Authorizations
* @short_description: Implicit Authorizations
*
* Possible implicit authorizations.
*/
......
......@@ -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)
{
......
......@@ -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;
......
......@@ -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
......
......@@ -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)
{
......
......@@ -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;
......
......@@ -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;
......
......@@ -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;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment