Add some Gtk Doc stuff, can't get it working well though

7 files changed, 127 insertions, 26 deletions

diff --git a/.bzrignore b/.bzrignore
index 4de393d9..fe6257b2 100644
--- a/.bzrignore
+++ b/.bzrignore
@@ -1,27 +1,43 @@
+*.bak
+*.la
+*.lo
+.deps
+.libs
 Makefile
 Makefile.in
 Makefile.in.in
-.deps
-missing
-mkinstalldirs
-install-sh
-gnome-doc-utils.make
-configure
-config.status
-config.log
-autom4te.cache
-aclocal.m4
-depcomp
-omf.make
-xmldocs.make
-greeters/ldm-webkit-greeter
+./aclocal.m4
+./autom4te.cache
+./compile
+./config.guess
+./config.log
+./config.status
+./config.sub
+./configure
+./depcomp
+./gnome-doc-utils.make
+./gtk-doc.make
+./install-sh
+./libtool
+./ltmain.sh
+./missing
+./mkinstalldirs
+./omf.make
+./xmldocs.make
+doc/html
+doc/ldmgreeter.*
+doc/*.stamp
+doc/tmpl
+doc/*.txt
+doc/xml
 greeters/ldm-gtk-greeter
-po/stamp-it
+greeters/ldm-webkit-greeter
+libldmgreeter/libldmgreeter-1.pc
 po/POTFILES
-src/lightdm
+po/stamp-it
 src/display-glue.h
 src/display-manager-glue.h
-src/user-manager-glue.h
-src/session-manager-glue.h
 src/ldmwkgreeter
-libldmgreeter/libldmgreeter-1.pc
+src/lightdm
+src/session-manager-glue.h
+src/user-manager-glue.h
diff --git a/Makefile.am b/Makefile.am
index a2f46021..7a45e3de 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,4 +1,4 @@
-SUBDIRS = libldmgreeter data greeters po src themes
+SUBDIRS = libldmgreeter data greeters po src themes doc
 
 EXTRA_DIST = \
 	autogen.sh \
diff --git a/configure.ac b/configure.ac
index e6fdc585..0c9e868c 100644
--- a/configure.ac
+++ b/configure.ac
@@ -123,6 +123,7 @@ dnl Documentation
 dnl ###########################################################################
 
 GNOME_DOC_INIT
+GTK_DOC_CHECK
 
 dnl ###########################################################################
 dnl Internationalization
@@ -140,6 +141,7 @@ dnl ###########################################################################
 AC_OUTPUT([
 Makefile
 data/Makefile
+doc/Makefile
 greeters/Makefile
 libldmgreeter/libldmgreeter-1.pc
 libldmgreeter/Makefile
diff --git a/doc/Makefile.am b/doc/Makefile.am
new file mode 100644
index 00000000..6edce8b8
--- /dev/null
+++ b/doc/Makefile.am
@@ -0,0 +1,21 @@
+DOC_MODULE=ldmgreeter
+
+DOC_SOURCE_DIR=$(top_srcdir)/libldmgreeter
+
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+HFILE_GLOB=$(top_srcdir)/libldmgreeter/*.h
+CFILE_GLOB=$(top_srcdir)/libldmgreeter/*.c
+
+INCLUDES = \
+	$(LIBLDMGREETER_CFLAGS) \
+	-I$(top_srcdir)/libldmgreeter
+
+GTKDOC_LIBS = \
+	$(LIBLDMGREETER_LIBS) \
+	-L$(top_builddir)/libldmgreeter \
+	-lldmgreeter
+
+include $(top_srcdir)/gtk-doc.make
+
+DISTCLEANFILES = $(DOC_MODULE)-docs.xml $(DOC_MODULE)-overrides.txt $(DOC_MODULE)-sections.txt $(DOC_MODULE).types
diff --git a/doc/ldmgreeter-docs.sgml b/doc/ldmgreeter-docs.sgml
new file mode 100644
index 00000000..316cc0cd
--- /dev/null
+++ b/doc/ldmgreeter-docs.sgml
@@ -0,0 +1,13 @@
+<?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">
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+  <bookinfo>
+    <title>LightDM Greeter Reference Manual</title>
+  </bookinfo>
+
+  <part id="core">
+    <title>Gnome Scan Core Reference</title>
+    <xi:include href="xml/greeter.xml"/>
+  </part>
+</book>
diff --git a/libldmgreeter/greeter.c b/libldmgreeter/greeter.c
index c5674046..57c94eef 100644
--- a/libldmgreeter/greeter.c
+++ b/libldmgreeter/greeter.c
@@ -51,6 +51,13 @@ struct GreeterPrivate
 
 G_DEFINE_TYPE (Greeter, greeter, G_TYPE_OBJECT);
 
+/**
+ * greeter_new:
+ * 
+ * Create a new greeter.
+ * 
+ * Return value: the new #Greeter
+ **/
 Greeter *
 greeter_new (/*int argc, char **argv*/)
 {
@@ -60,7 +67,7 @@ greeter_new (/*int argc, char **argv*/)
         return NULL;
     }*/
 
-    return g_object_new (GREETER_TYPE, /*"?", argv[1],*/ NULL);
+    return g_object_new (TYPE_GREETER, /*"?", argv[1],*/ NULL);
 }
 
 static gboolean
@@ -73,6 +80,14 @@ timed_login_cb (gpointer data)
     return TRUE;
 }
 
+/**
+ * greeter_connect:
+ * @greeter: The greeter to connect
+ *
+ * Connects the greeter to the display manager.
+ * 
+ * Return value: TRUE if successfully connected
+ **/
 gboolean
 greeter_connect (Greeter *greeter)
 {
@@ -148,6 +163,12 @@ update_users (Greeter *greeter)
     greeter->priv->have_users = TRUE;
 }
 
+/**
+ * greeter_get_num_users:
+ * @greeter: a #Greeter
+ *
+ * Return value: The number of users able to log in
+ **/
 gint
 greeter_get_num_users (Greeter *greeter)
 {
@@ -155,6 +176,12 @@ greeter_get_num_users (Greeter *greeter)
     return g_list_length (greeter->priv->users);
 }
 
+/**
+ * greeter_get_users:
+ * @greeter:
+ * 
+ * Return value: A list of #UserInfo that should be presented to the user.
+ */
 const GList *
 greeter_get_users (Greeter *greeter)
 {
@@ -347,6 +374,12 @@ greeter_get_is_authenticated (Greeter *greeter)
     return greeter->priv->is_authenticated;
 }
 
+/**
+ * greeter_get_can_suspend:
+ * @greeter: A #Greeter
+ *
+ * Return value: TRUE if the greeter can suspend the machine
+ **/
 gboolean
 greeter_get_can_suspend (Greeter *greeter)
 {
@@ -502,7 +535,7 @@ greeter_init (Greeter *greeter)
     const gchar *bus_address, *object;
     DBusBusType bus_type = DBUS_BUS_SYSTEM;
 
-    greeter->priv = G_TYPE_INSTANCE_GET_PRIVATE (greeter, GREETER_TYPE, GreeterPrivate);
+    greeter->priv = G_TYPE_INSTANCE_GET_PRIVATE (greeter, TYPE_GREETER, GreeterPrivate);
 
     greeter->priv->system_bus = dbus_g_bus_get (DBUS_BUS_SYSTEM, &error);
     if (!greeter->priv->system_bus)
@@ -541,6 +574,14 @@ greeter_class_init (GreeterClass *klass)
 {
     g_type_class_add_private (klass, sizeof (GreeterPrivate));
 
+    /**
+     * Greeter::show-prompt:
+     * @greeter: The greeter on which the signal is emitted
+     * @text: The text to show in the prompt
+     * 
+     * The ::show-prompt signal gets emitted when the greeter
+     * should show a prompt to the user.
+     **/
     signals[SHOW_PROMPT] =
         g_signal_new ("show-prompt",
                       G_TYPE_FROM_CLASS (klass),
diff --git a/libldmgreeter/greeter.h b/libldmgreeter/greeter.h
index 2891c84a..05d4b901 100644
--- a/libldmgreeter/greeter.h
+++ b/libldmgreeter/greeter.h
@@ -16,21 +16,29 @@
 
 G_BEGIN_DECLS
 
-#define GREETER_TYPE (greeter_get_type())
-#define GREETER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GREETER_TYPE, Greeter));
+#define TYPE_GREETER            (greeter_get_type())
+#define GREETER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), TYPE_GREETER, Greeter));
+#define GREETER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), TYPE_GREETER, GreeterClass))
+#define IS_GREETER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), TYPE_GREETER))
+#define IS_GREETER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), TYPE_GREETER))
+#define GREETER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), TYPE_GREETER, GreeterClass))
 
+
+/*<private>*/
 typedef struct GreeterPrivate GreeterPrivate;
 
 typedef struct
 {
     GObject         parent_instance;
-    GreeterPrivate *priv;
+    GreeterPrivate *GSEAL (priv);
 } Greeter;
 
 typedef struct
 {
     GObjectClass parent_class;
-  
+
+    /*< private >*/
+
     void (*show_prompt)(Greeter *greeter, const gchar *text);
     void (*show_message)(Greeter *greeter, const gchar *text);
     void (*show_error)(Greeter *greeter, const gchar *text);