[evolution-data-server] Libebackend: Fixing gtk-doc comments and adding gtk-doc section headers

[Tristan Van Berkom <tvb src gnome org>]

commit 24c97c1e89d376deb5d3a0746f01578b2ec96f98
Author: Tristan Van Berkom <tristan upstairslabs com>
Date:   Fri Dec 6 14:59:54 2013 +0900

    Libebackend: Fixing gtk-doc comments and adding gtk-doc section headers

 libebackend/e-authentication-mediator.c |    1 +
 libebackend/e-authentication-mediator.h |    9 +++++++++
 libebackend/e-authentication-session.h  |   15 +++++++++++++++
 libebackend/e-backend-factory.h         |   13 +++++++++++++
 libebackend/e-backend.c                 |    5 +++--
 libebackend/e-backend.h                 |   15 +++++++++++++++
 6 files changed, 56 insertions(+), 2 deletions(-)
---
diff --git a/libebackend/e-authentication-mediator.c b/libebackend/e-authentication-mediator.c
index af80a54..385c8f0 100644
--- a/libebackend/e-authentication-mediator.c
+++ b/libebackend/e-authentication-mediator.c
@@ -1267,6 +1267,7 @@ e_authentication_mediator_dismiss (EAuthenticationMediator *mediator)
 /**
  * e_authentication_mediator_server_error:
  * @mediator: an #EAuthenticationMediator
+ * @error: the #GError to report
  *
  * Signals to the authentication client that the authentication session has
  * terminated with a server-side error.
diff --git a/libebackend/e-authentication-mediator.h b/libebackend/e-authentication-mediator.h
index f0fe8e3..1df93ab 100644
--- a/libebackend/e-authentication-mediator.h
+++ b/libebackend/e-authentication-mediator.h
@@ -59,11 +59,20 @@ typedef struct _EAuthenticationMediatorPrivate EAuthenticationMediatorPrivate;
  * Since: 3.6
  **/
 struct _EAuthenticationMediator {
+       /*< private >*/
        GObject parent;
        EAuthenticationMediatorPrivate *priv;
 };
 
+/**
+ * EAuthenticationMediatorClass:
+ *
+ * Class structure for the #EAuthenticationMediator object
+ *
+ * Since: 3.6
+ */
 struct _EAuthenticationMediatorClass {
+       /*< private >*/
        GObjectClass parent_class;
 };
 
diff --git a/libebackend/e-authentication-session.h b/libebackend/e-authentication-session.h
index eea00c2..4dc1349 100644
--- a/libebackend/e-authentication-session.h
+++ b/libebackend/e-authentication-session.h
@@ -65,13 +65,27 @@ typedef struct _EAuthenticationSessionPrivate EAuthenticationSessionPrivate;
  * Since: 3.6
  **/
 struct _EAuthenticationSession {
+       /*< private >*/
        GObject parent;
        EAuthenticationSessionPrivate *priv;
 };
 
+/**
+ * EAuthenticationSessionClass:
+ * @execute_sync: Authenticate synchronously
+ * @execute: Initiate authentication
+ * @execute_finish: Complete authentication
+ *
+ * Class structure for the #EAuthenticationSession object
+ *
+ * Since: 3.6
+ */
 struct _EAuthenticationSessionClass {
+       /*< private >*/
        GObjectClass parent_class;
 
+       /*< public >*/
+
        /* Methods */
        EAuthenticationSessionResult
                        (*execute_sync) (EAuthenticationSession *session,
@@ -88,6 +102,7 @@ struct _EAuthenticationSessionClass {
                                         GAsyncResult *result,
                                         GError **error);
 
+       /*< private >*/
        /* Reserved slots. */
        gpointer reserved[16];
 };
diff --git a/libebackend/e-backend-factory.h b/libebackend/e-backend-factory.h
index 88c556e..9b74fff 100644
--- a/libebackend/e-backend-factory.h
+++ b/libebackend/e-backend-factory.h
@@ -60,18 +60,31 @@ typedef struct _EBackendFactoryPrivate EBackendFactoryPrivate;
  * Since: 3.4
  **/
 struct _EBackendFactory {
+       /*< private >*/
        EExtension parent;
        EBackendFactoryPrivate *priv;
 };
 
+/**
+ * EBackendFactoryClass:
+ * @get_hash_key: Get the hash key for this factory
+ * @new_backend: Create a new #EBackend of the appropriate type for the passed #ESource
+ *
+ * Base class structure for the #EBackendFactory class
+ *
+ * Since: 3.4
+ **/
 struct _EBackendFactoryClass {
+       /*< private >*/
        EExtensionClass parent_class;
 
+       /*< public >*/
        /* Methods */
        const gchar *   (*get_hash_key)         (EBackendFactory *factory);
        EBackend *      (*new_backend)          (EBackendFactory *factory,
                                                 ESource *source);
 
+       /*< private >*/
        gpointer reserved[16];
 };
 
diff --git a/libebackend/e-backend.c b/libebackend/e-backend.c
index 2abbf1e..6d8a96f 100644
--- a/libebackend/e-backend.c
+++ b/libebackend/e-backend.c
@@ -859,9 +859,10 @@ e_backend_authenticate_finish (EBackend *backend,
  * @backend: an #EBackend
  *
  * Gets an instance of #EUserPrompter, associated with this @backend.
- * The instance is owned by the @backend.
  *
- * Returns: (transfer-none): an #EUserPrompter instance
+ * The returned instance is owned by the @backend.
+ *
+ * Returns: (transfer none): an #EUserPrompter instance
  *
  * Since: 3.8
  **/
diff --git a/libebackend/e-backend.h b/libebackend/e-backend.h
index 74e7e8d..e2933b8 100644
--- a/libebackend/e-backend.h
+++ b/libebackend/e-backend.h
@@ -62,13 +62,27 @@ typedef struct _EBackendPrivate EBackendPrivate;
  * Since: 3.4
  **/
 struct _EBackend {
+       /*< private >*/
        GObject parent;
        EBackendPrivate *priv;
 };
 
+/**
+ * EBackendClass:
+ * @authenticate_sync: Authenticate synchronously
+ * @authenticate: Initiate authentication
+ * @authenticate_finish: Complete authentication
+ * @get_destination_address: Fetch the destination address
+ *
+ * Base class structure for the #EBackend class
+ *
+ * Since: 3.4
+ **/
 struct _EBackendClass {
+       /*< private >*/
        GObjectClass parent_class;
 
+       /*< public >*/
        /* Methods */
        gboolean        (*authenticate_sync)    (EBackend *backend,
                                                 ESourceAuthenticator *auth,
@@ -88,6 +102,7 @@ struct _EBackendClass {
                                                 gchar **host,
                                                 guint16 *port);
 
+       /*< private >*/
        gpointer reserved[12];
 };