[evolution-data-server] libebackend documentation touch ups.



commit bb8903285e5591e17cc535570623e68599e041de
Author: Matthew Barnes <mbarnes redhat com>
Date:   Sat May 26 12:08:09 2012 -0400

    libebackend documentation touch ups.

 docs/reference/libebackend/libebackend-docs.xml |   10 +++++++++-
 libebackend/e-backend-factory.c                 |    2 +-
 libebackend/e-backend.c                         |    2 +-
 libebackend/e-data-factory.c                    |    2 +-
 libebackend/e-dbus-server.c                     |    2 +-
 libebackend/e-extensible.c                      |    2 +-
 libebackend/e-extension.c                       |    2 +-
 libebackend/e-module.c                          |    2 +-
 libebackend/e-offline-listener.c                |    2 +-
 9 files changed, 17 insertions(+), 9 deletions(-)
---
diff --git a/docs/reference/libebackend/libebackend-docs.xml b/docs/reference/libebackend/libebackend-docs.xml
index 5ec2486..5abb0ca 100644
--- a/docs/reference/libebackend/libebackend-docs.xml
+++ b/docs/reference/libebackend/libebackend-docs.xml
@@ -9,7 +9,7 @@
   </bookinfo>
 
   <chapter>
-    <title>Evolution-Data-Server Manual: Backend Utilities (libebackend)</title>
+    <title>Base Classes for Backends</title>
     <xi:include href="xml/e-backend.xml"/>
     <xi:include href="xml/e-backend-factory.xml"/>
     <xi:include href="xml/e-data-factory.xml"/>
@@ -17,10 +17,18 @@
     <xi:include href="xml/e-extensible.xml"/>
     <xi:include href="xml/e-extension.xml"/>
     <xi:include href="xml/e-module.xml"/>
+  </chapter>
+
+  <chapter>
+    <title>Miscellaneous Utilities</title>
     <xi:include href="xml/e-file-cache.xml"/>
     <xi:include href="xml/e-dbhash.xml"/>
     <xi:include href="xml/e-db3-utils.xml"/>
     <xi:include href="xml/e-sqlite3-vfs.xml"/>
+  </chapter>
+
+  <chapter>
+    <title>Deprecated Classes</title>
     <xi:include href="xml/e-offline-listener.xml"/>
   </chapter>
 
diff --git a/libebackend/e-backend-factory.c b/libebackend/e-backend-factory.c
index caee05d..8068e4a 100644
--- a/libebackend/e-backend-factory.c
+++ b/libebackend/e-backend-factory.c
@@ -18,7 +18,7 @@
 
 /**
  * SECTION: e-backend-factory
- * @short_description: an abstract base class for backend factories
+ * @short_description: An abstract base class for backend factories
  * @include: libebackend/e-backend-factory.h
  *
  * An #EBackendFactory's job is to create an #EBackend instance for a
diff --git a/libebackend/e-backend.c b/libebackend/e-backend.c
index 3d25f85..df18f28 100644
--- a/libebackend/e-backend.c
+++ b/libebackend/e-backend.c
@@ -18,7 +18,7 @@
 
 /**
  * SECTION: e-backend
- * @short_description: an abstract base class for backends
+ * @short_description: An abstract base class for backends
  * @include: libebackend/e-backend.h
  *
  * An #EBackend is paired with an #ESource to facilitate performing
diff --git a/libebackend/e-data-factory.c b/libebackend/e-data-factory.c
index dded87f..4cdf3f1 100644
--- a/libebackend/e-data-factory.c
+++ b/libebackend/e-data-factory.c
@@ -18,7 +18,7 @@
 
 /**
  * SECTION: e-data-factory
- * @short_description: an abstract base class for a D-Bus server
+ * @short_description: An abstract base class for a backend-based server
  * @include: libebackend/e-data-factory
  **/
 
diff --git a/libebackend/e-dbus-server.c b/libebackend/e-dbus-server.c
index 917ea44..0d72a36 100644
--- a/libebackend/e-dbus-server.c
+++ b/libebackend/e-dbus-server.c
@@ -18,7 +18,7 @@
 
 /**
  * SECTION: e-dbus-server
- * @short_description: an abstract base class for a D-Bus server
+ * @short_description: An abstract base class for a D-Bus server
  * @include: libebackend/e-dbus-server
  **/
 
diff --git a/libebackend/e-extensible.c b/libebackend/e-extensible.c
index 7b929b5..40248b7 100644
--- a/libebackend/e-extensible.c
+++ b/libebackend/e-extensible.c
@@ -18,7 +18,7 @@
 
 /**
  * SECTION: e-extensible
- * @short_description: an interface for extending objects
+ * @short_description: An interface for extending objects
  * @include: libebackend/e-extensible.h
  *
  * #EExtension objects can be tacked on to any #GObject instance that
diff --git a/libebackend/e-extension.c b/libebackend/e-extension.c
index 5395da7..2efe3eb 100644
--- a/libebackend/e-extension.c
+++ b/libebackend/e-extension.c
@@ -18,7 +18,7 @@
 
 /**
  * SECTION: e-extension
- * @short_description: abstract base class for extensions
+ * @short_description: An abstract base class for extensions
  * @include: libebackend/e-extension.h
  *
  * #EExtension provides a way to extend the functionality of objects
diff --git a/libebackend/e-module.c b/libebackend/e-module.c
index 7863bc7..34c5412 100644
--- a/libebackend/e-module.c
+++ b/libebackend/e-module.c
@@ -18,7 +18,7 @@
 
 /**
  * SECTION: e-module
- * @short_description: a module loader
+ * @short_description: A module loader
  * @include: libebackend/e-module.h
  **/
 
diff --git a/libebackend/e-offline-listener.c b/libebackend/e-offline-listener.c
index e9469d7..bee26f7 100644
--- a/libebackend/e-offline-listener.c
+++ b/libebackend/e-offline-listener.c
@@ -22,7 +22,7 @@
 
 /**
  * SECTION: e-offline-listener
- * @short_description: (Deprecated) Tracks Evolution's online/offline state
+ * @short_description: Tracks Evolution's online/offline state
  *
  * An #EOfflineListener basically just tracks Evolution's online/offline
  * state and emits a #EOfflineListener:changed signal when a state change



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]