Commit d2b9344b authored by Matthias Clasen's avatar Matthias Clasen

Generate docs for libaccountssservice

parent e6fffb59
......@@ -2,7 +2,7 @@ SUBDIRS = src data po doc
ACLOCAL_AMFLAGS = -I m4 ${ACLOCAL_FLAGS}
EXTRA_DIST =
EXTRA_DIST = gtk-doc.make
DISTCHECK_CONFIGURE_FLAGS = \
--with-systemdsystemunitdir=$$dc_install_base/$(systemdsystemunitdir)
#!/bin/sh
GTKDOCIZE=$(which gtkdocize 2>/dev/null)
if test -z $GTKDOCIZE; then
echo "You don't have gtk-doc installed, and thus won't be able to generate the documentation."
rm -f gtk-doc.make
cat > gtk-doc.make <<EOF
EXTRA_DIST =
CLEANFILES =
EOF
else
gtkdocize || exit $?
fi
ACLOCAL="aclocal $ACLOCAL_FLAGS"
export ACLOCAL
......
......@@ -140,6 +140,16 @@ AC_SUBST(WARN_CFLAGS)
AC_CHECK_HEADERS([shadow.h utmpx.h])
dnl ---------------------------------------------------------------------------
dnl - gtk-doc Documentation
dnl ---------------------------------------------------------------------------
m4_ifdef([GTK_DOC_CHECK], [
GTK_DOC_CHECK([1.15], [--flavour no-tmpl])
],[
AM_CONDITIONAL([ENABLE_GTK_DOC],[false])
])
dnl ---------------------------------------------------------------------------
dnl - DocBook Documentation
dnl ---------------------------------------------------------------------------
......@@ -241,6 +251,7 @@ src/libaccountsservice/accountsservice.pc
doc/Makefile
doc/dbus/Makefile
doc/dbus/AccountsService.xml
doc/libaccountsservice/Makefile
])
AC_OUTPUT
......
SUBDIRS = dbus
SUBDIRS = dbus libaccountsservice
AUTOMAKE_OPTIONS=1.6
DOC_MODULE=libaccountsservice
DOC_MAIN_SGML_FILE=libaccountsservice-docs.xml
DOC_SOURCE_DIR=$(top_srcdir)/src/libaccountsservice
MKBD_OPTIONS=--xml-mode --output-format=xml --name-space=act
HFILE_GLOB=$(top_srcdir)/src/libaccountsservice/*.h
IGNORE_HFILES= \
accounts-generated.h \
accounts-user-generated.h \
ck-manager-generated.h \
ck-seat-generated.h \
ck-session-generated.h \
act-user-enum-types.h
GTKDOC_CFLAGS=-I$(top_srcdir)/src/libaccountsservice
GTKDOC_LIBS=$(top_builddir)/src/libaccountsservice/libaccountsservice.la
include $(top_srcdir)/gtk-doc.make
<?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>libaccountsservice Reference Manual</title>
</bookinfo>
<chapter>
<title>libaccountsservice</title>
<xi:include href="xml/act-user.xml"/>
<xi:include href="xml/act-user-manager.xml"/>
</chapter>
<index id="api-index-full">
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
</book>
......@@ -53,6 +53,18 @@
#include "ck-seat-generated.h"
#include "ck-session-generated.h"
/**
* SECTION:act-user-manager
* @title: ActUserManager
* @short_description: manages ActUser objects
*
* ActUserManager is a manager object that gives access to user
* creation, deletion, enumeration, etc.
*
* There is typically a singleton ActUserManager object, which
* can be obtained by act_user_manager_get_default().
*/
#define ACT_USER_MANAGER_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), ACT_TYPE_USER_MANAGER, ActUserManagerPrivate))
#define CK_NAME "org.freedesktop.ConsoleKit"
......
......@@ -33,6 +33,14 @@
#include "act-user-private.h"
#include "accounts-user-generated.h"
/**
* SECTION:act-user
* @title: ActUser
* @short_description: information about a user account
*
* An ActUser object represents a user account on the system.
*/
#define ACT_USER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ACT_TYPE_USER, ActUserClass))
#define ACT_IS_USER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ACT_TYPE_USER))
#define ACT_USER_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS ((object), ACT_TYPE_USER, ActUserClass))
......
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