From 6b53dd8da13d35ce3e8130b25584371473927a4f Mon Sep 17 00:00:00 2001
From: Matthew Barnes <mbarnes@redhat.com>
Date: Thu, 13 Dec 2012 17:18:51 -0500
Subject: libeshell documentation cleanups.

---
 doc/reference/libeshell/Makefile.am         | 63 ++++++-----------------------
 doc/reference/libeshell/libeshell-docs.sgml |  2 +-
 doc/reference/libeshell/libeshell.types     | 10 +++++
 3 files changed, 24 insertions(+), 51 deletions(-)

(limited to 'doc')

diff --git a/doc/reference/libeshell/Makefile.am b/doc/reference/libeshell/Makefile.am
index 7262075b74..c9afa908ae 100644
--- a/doc/reference/libeshell/Makefile.am
+++ b/doc/reference/libeshell/Makefile.am
@@ -1,32 +1,11 @@
-# The name of the module, e.g. 'glib'.
+# The name of the module.
 DOC_MODULE=libeshell
 
-# The top-level SGML file. You can change this if you want to.
+# The top-level SGML file.
 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
 
 # The directory containing the source code. Relative to $(srcdir).
-# gtk-doc will search all .c & .h files beneath here for inline comments
-# documenting the functions and macros.
-# e.g. DOC_SOURCE_DIR=../../../gtk
-DOC_SOURCE_DIR=../../../shell
-
-# Extra options to pass to gtkdoc-scangobj. Not normally needed.
-SCANGOBJ_OPTIONS=
-
-# Extra options to supply to gtkdoc-scan.
-# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
-SCAN_OPTIONS=
-
-# Extra options to supply to gtkdoc-mkdb.
-MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=e
-
-# Extra options to supply to gtkdoc-mktmpl
-# e.g. MKTMPL_OPTIONS=--only-section-tmpl
-MKTMPL_OPTIONS=
-
-# Extra options to supply to gtkdoc-fixref. Not normally needed.
-# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
-FIXXREF_OPTIONS=
+DOC_SOURCE_DIR=$(top_srcdir)/shell
 
 # Used for dependencies. The docs will be rebuilt if any of these change.
 HFILE_GLOB=$(top_srcdir)/shell/*.h
@@ -36,45 +15,29 @@ CFILE_GLOB=$(top_srcdir)/shell/*.c
 IGNORE_HFILES= \
 	evo-version.h \
 	e-shell-window-private.h \
-	es-event.h
-
-# Images to copy into HTML directory.
-HTML_IMAGES=
-
-# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
-content_files=
+	es-event.h \
+	$(NULL)
 
-# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
-# These files must be listed here *and* in content_files
-expand_content_files=
-
-# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
-# Only needed if you are using gtkdoc-scangobj to dynamically query widget
-# signals and properties.
 GTKDOC_CFLAGS= \
-	-I$(top_builddir)						\
 	-I$(top_srcdir)							\
+	-I$(top_builddir)						\
 	$(EVOLUTION_DATA_SERVER_CFLAGS)					\
-	$(GTKHTML_CFLAGS)
+	$(GNOME_PLATFORM_CFLAGS)					\
+	$(GTKHTML_CFLAGS)						\
+	$(NULL)
+
 GTKDOC_LIBS=								\
 	$(top_builddir)/libemail-engine/libemail-engine.la		\
 	$(top_builddir)/shell/libeshell.la				\
 	$(top_builddir)/e-util/libeutil.la				\
 	$(EVOLUTION_DATA_SERVER_LIBS)					\
-	$(GTKHTML_LIBS)
+	$(GNOME_PLATFORM_LIBS)						\
+	$(GTKHTML_LIBS)							\
+	$(NULL)
 
 # This includes the standard gtk-doc make rules, copied by gtkdocize.
 include $(top_srcdir)/gtk-doc.make
 
-# Other files to distribute
-# e.g. EXTRA_DIST += version.xml.in
-EXTRA_DIST +=
-
-# Files not to distribute
-# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
-# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
-#DISTCLEANFILES +=
-
 #TESTS = $(GTKDOC_CHECK)
 
 -include $(top_srcdir)/git.mk
diff --git a/doc/reference/libeshell/libeshell-docs.sgml b/doc/reference/libeshell/libeshell-docs.sgml
index 8a9404fdc9..22bc93fa19 100644
--- a/doc/reference/libeshell/libeshell-docs.sgml
+++ b/doc/reference/libeshell/libeshell-docs.sgml
@@ -3,7 +3,7 @@
                "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>Evolution Shell (libeshell)</title>
+    <title>Evolution Shell Reference Manual</title>
     <releaseinfo>
       The latest version of this documentation can be found on-line at
       <ulink role="online-location" url="http://library.gnome.org/devel/libeshell/">http://library.gnome.org/devel/libeshell/</ulink>.
diff --git a/doc/reference/libeshell/libeshell.types b/doc/reference/libeshell/libeshell.types
index b0038d55e1..2bc9a71963 100644
--- a/doc/reference/libeshell/libeshell.types
+++ b/doc/reference/libeshell/libeshell.types
@@ -1,3 +1,13 @@
+#include <shell/e-shell.h>
+#include <shell/e-shell-backend.h>
+#include <shell/e-shell-content.h>
+#include <shell/e-shell-searchbar.h>
+#include <shell/e-shell-sidebar.h>
+#include <shell/e-shell-switcher.h>
+#include <shell/e-shell-taskbar.h>
+#include <shell/e-shell-view.h>
+#include <shell/e-shell-window.h>
+
 e_shell_get_type
 e_shell_backend_get_type
 e_shell_content_get_type
-- 
cgit