aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/libeshell/libeshell-docs.sgml
diff options
context:
space:
mode:
authorMatthew Barnes <mbarnes@redhat.com>2012-12-10 21:09:59 +0800
committerMatthew Barnes <mbarnes@redhat.com>2012-12-13 03:33:43 +0800
commitd09d8de870b6697c8a8b262e7e077b871a69b315 (patch)
tree3b718882e7a0bb0a996daf2967a033d91714c9b5 /doc/reference/libeshell/libeshell-docs.sgml
parentb61331ed03ac1c7a9b8614e25510040b9c60ae02 (diff)
downloadgsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar
gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar.gz
gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar.bz2
gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar.lz
gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar.xz
gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.tar.zst
gsoc2013-evolution-d09d8de870b6697c8a8b262e7e077b871a69b315.zip
Consolidate base utility libraries into libeutil.
Evolution consists of entirely too many small utility libraries, which increases linking and loading time, places a burden on higher layers of the application (e.g. modules) which has to remember to link to all the small in-tree utility libraries, and makes it difficult to generate API documentation for these utility libraries in one Gtk-Doc module. Merge the following utility libraries under the umbrella of libeutil, and enforce a single-include policy on libeutil so we can reorganize the files as desired without disrupting its pseudo-public API. libemail-utils/libemail-utils.la libevolution-utils/libevolution-utils.la filter/libfilter.la widgets/e-timezone-dialog/libetimezonedialog.la widgets/menus/libmenus.la widgets/misc/libemiscwidgets.la widgets/table/libetable.la widgets/text/libetext.la This also merges libedataserverui from the Evolution-Data-Server module, since Evolution is its only consumer nowadays, and I'd like to make some improvements to those APIs without concern for backward-compatibility. And finally, start a Gtk-Doc module for libeutil. It's going to be a project just getting all the symbols _listed_ much less _documented_. But the skeletal structure is in place and I'm off to a good start.
Diffstat (limited to 'doc/reference/libeshell/libeshell-docs.sgml')
-rw-r--r--doc/reference/libeshell/libeshell-docs.sgml44
1 files changed, 44 insertions, 0 deletions
diff --git a/doc/reference/libeshell/libeshell-docs.sgml b/doc/reference/libeshell/libeshell-docs.sgml
new file mode 100644
index 0000000000..8a9404fdc9
--- /dev/null
+++ b/doc/reference/libeshell/libeshell-docs.sgml
@@ -0,0 +1,44 @@
+<?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>Evolution Shell (libeshell)</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>.
+ </releaseinfo>
+ </bookinfo>
+
+ <chapter>
+ <title>The Shell</title>
+ <xi:include href="xml/e-shell.xml"/>
+ <xi:include href="xml/e-shell-backend.xml"/>
+ <xi:include href="xml/e-shell-window.xml"/>
+ <xi:include href="xml/e-shell-view.xml"/>
+ <xi:include href="xml/e-shell-content.xml"/>
+ <xi:include href="xml/e-shell-sidebar.xml"/>
+ <xi:include href="xml/e-shell-taskbar.xml"/>
+ <xi:include href="xml/e-shell-searchbar.xml"/>
+ <xi:include href="xml/e-shell-settings.xml"/>
+ <xi:include href="xml/e-shell-switcher.xml"/>
+ <xi:include href="xml/e-shell-utils.xml"/>
+ </chapter>
+
+ <chapter>
+ <title>Actions</title>
+ <xi:include href="xml/shell-actions.xml"/>
+ <xi:include href="xml/action-groups.xml"/>
+ </chapter>
+
+ <chapter>
+ <title>Object Hierarchy</title>
+ <xi:include href="xml/tree_index.sgml"/>
+ </chapter>
+
+ <index id="api-index-full">
+ <title>Index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </index>
+
+</book>