[evolution-data-server] Bug 782847 - Some fixes to the developer documentation

[Milan Crha <mcrha src gnome org>]

commit bdc25d463aa086a3ba1a9ff66d99d9b79feae830
Author: Corentin Noël <corentin elementary io>
Date:   Mon May 22 10:00:14 2017 +0200

    Bug 782847 - Some fixes to the developer documentation

 src/libedataserver/e-source-alarms.c           |    4 ++--
 src/libedataserver/e-source-contacts.h         |    8 ++++++++
 src/libedataserver/e-source-ldap.h             |    8 ++++++++
 src/libedataserver/e-source-local.h            |    8 ++++++++
 src/libedataserver/e-source-mail-composition.c |    6 ++++--
 src/libedataserver/e-source-mail-identity.c    |    6 +++---
 src/libedataserver/e-source-mail-signature.c   |    5 +++--
 src/libedataserver/e-source-weather.h          |    8 ++++++++
 8 files changed, 44 insertions(+), 9 deletions(-)
---
diff --git a/src/libedataserver/e-source-alarms.c b/src/libedataserver/e-source-alarms.c
index 6363c35..6644c9e 100644
--- a/src/libedataserver/e-source-alarms.c
+++ b/src/libedataserver/e-source-alarms.c
@@ -223,7 +223,7 @@ e_source_alarms_set_include_me (ESourceAlarms *extension,
  * the #ESource to which @extension belongs.  If no valid timestamp
  * has been set, the function will return %NULL.
  *
- * Returns: an ISO 8601 timestamp, or %NULL
+ * Returns: (nullable): an ISO 8601 timestamp, or %NULL
  *
  * Since: 3.6
  **/
@@ -244,7 +244,7 @@ e_source_alarms_get_last_notified (ESourceAlarms *extension)
  *
  * The returned string should be freed with g_free() when no longer needed.
  *
- * Returns: a newly-allocated copy of #ESourceAlarms:last-notified
+ * Returns: (nullable): a newly-allocated copy of #ESourceAlarms:last-notified
  *
  * Since: 3.6
  **/
diff --git a/src/libedataserver/e-source-contacts.h b/src/libedataserver/e-source-contacts.h
index a5245ca..cf342b4 100644
--- a/src/libedataserver/e-source-contacts.h
+++ b/src/libedataserver/e-source-contacts.h
@@ -43,6 +43,14 @@
        (G_TYPE_INSTANCE_GET_CLASS \
        ((obj), E_TYPE_SOURCE_CONTACTS, ESourceContactsClass))
 
+/**
+ * E_SOURCE_EXTENSION_CONTACTS_BACKEND:
+ *
+ * Pass this extension name to e_source_get_extension() to access
+ * #ESourceContacts.  This is also used as a group name in key files.
+ *
+ * Since: 3.18
+ **/
 #define E_SOURCE_EXTENSION_CONTACTS_BACKEND "Contacts Backend"
 
 G_BEGIN_DECLS
diff --git a/src/libedataserver/e-source-ldap.h b/src/libedataserver/e-source-ldap.h
index bcdd8ed..c76c23c 100644
--- a/src/libedataserver/e-source-ldap.h
+++ b/src/libedataserver/e-source-ldap.h
@@ -44,6 +44,14 @@
        (G_TYPE_INSTANCE_GET_CLASS \
        ((obj), E_TYPE_SOURCE_LDAP, ESourceLDAPClass))
 
+/**
+ * E_SOURCE_EXTENSION_LDAP_BACKEND:
+ *
+ * Pass this extension name to e_source_get_extension() to access
+ * #ESourceLDAP.  This is also used as a group name in key files.
+ *
+ * Since: 3.18
+ **/
 #define E_SOURCE_EXTENSION_LDAP_BACKEND "LDAP Backend"
 
 G_BEGIN_DECLS
diff --git a/src/libedataserver/e-source-local.h b/src/libedataserver/e-source-local.h
index d35d55d..a2ec01a 100644
--- a/src/libedataserver/e-source-local.h
+++ b/src/libedataserver/e-source-local.h
@@ -43,6 +43,14 @@
        (G_TYPE_INSTANCE_GET_CLASS \
        ((obj), E_TYPE_SOURCE_LOCAL, ESourceLocalClass))
 
+/**
+ * E_SOURCE_EXTENSION_LOCAL_BACKEND:
+ *
+ * Pass this extension name to e_source_get_extension() to access
+ * #ESourceLocal.  This is also used as a group name in key files.
+ *
+ * Since: 3.18
+ **/
 #define E_SOURCE_EXTENSION_LOCAL_BACKEND "Local Backend"
 
 G_BEGIN_DECLS
diff --git a/src/libedataserver/e-source-mail-composition.c b/src/libedataserver/e-source-mail-composition.c
index 46d0065..c8ccebe 100644
--- a/src/libedataserver/e-source-mail-composition.c
+++ b/src/libedataserver/e-source-mail-composition.c
@@ -347,7 +347,8 @@ e_source_mail_composition_dup_bcc (ESourceMailComposition *extension)
 /**
  * e_source_mail_composition_set_bcc:
  * @extension: an #ESource
- * @bcc: (allow-none): a %NULL-terminated string array of Bcc recipients
+ * @bcc: (array zero-terminated=1): a %NULL-terminated string array of Bcc
+ *    recipients
  *
  * Sets the recipients which should automatically be added to the blind
  * carbon-copy (Bcc) list when composing a new mail message.  The recipient
@@ -434,7 +435,8 @@ e_source_mail_composition_dup_cc (ESourceMailComposition *extension)
 /**
  * e_source_mail_composition_set_cc:
  * @extension: an #ESourceMailComposition
- * @cc: (allow-none): a %NULL-terminated string array of Cc recipients
+ * @cc: (array zero-terminated=1): a %NULL-terminated string array of Cc
+ *    recipients
  *
  * Sets the recipients which should automatically be added to the carbon
  * copy (Cc) list when composing a new mail message.  The recipient strings
diff --git a/src/libedataserver/e-source-mail-identity.c b/src/libedataserver/e-source-mail-identity.c
index 72bbd9c..9190526 100644
--- a/src/libedataserver/e-source-mail-identity.c
+++ b/src/libedataserver/e-source-mail-identity.c
@@ -818,9 +818,9 @@ e_source_mail_identity_set_aliases (ESourceMailIdentity *extension,
  * e_source_mail_identity_get_aliases() if you need more fine-grained
  * control on the list of aliases.
  *
- * Returns: (transfer full): A newly created #GHashTable will
- *   all the aliases. Returns %NULL if there are none set. Use
- *   g_hash_table_destroy() to free the returned hash table.
+ * Returns: (transfer full) (element-type utf8 utf8) (nullable): A newly created
+ *   #GHashTable will all the aliases. Returns %NULL if there are none set.
+ *   Use g_hash_table_destroy() to free the returned hash table.
  *
  * Since: 3.24
  **/
diff --git a/src/libedataserver/e-source-mail-signature.c b/src/libedataserver/e-source-mail-signature.c
index 7f52c4c..3807fcd 100644
--- a/src/libedataserver/e-source-mail-signature.c
+++ b/src/libedataserver/e-source-mail-signature.c
@@ -267,7 +267,7 @@ e_source_mail_signature_get_file (ESourceMailSignature *extension)
  * e_source_mail_signature_load() sets this automatically if the MIME type
  * has not yet been determined.
  *
- * Returns: the MIME type of the signature content, or %NULL
+ * Returns: (nullable): the MIME type of the signature content, or %NULL
  *
  * Since: 3.6
  **/
@@ -288,7 +288,8 @@ e_source_mail_signature_get_mime_type (ESourceMailSignature *extension)
  *
  * The returned string should be freed with g_free() when no longer needed.
  *
- * Returns: a newly-allocated copy of #ESourceMailSignature:mime-type
+ * Returns: (nullable): a newly-allocated copy of #ESourceMailSignature:mime-type,
+ *    or %NULL
  *
  * Since: 3.6
  **/
diff --git a/src/libedataserver/e-source-weather.h b/src/libedataserver/e-source-weather.h
index 231f191..e102d7d 100644
--- a/src/libedataserver/e-source-weather.h
+++ b/src/libedataserver/e-source-weather.h
@@ -44,6 +44,14 @@
        (G_TYPE_INSTANCE_GET_CLASS \
        ((obj), E_TYPE_SOURCE_WEATHER, ESourceWeatherClass))
 
+/**
+ * E_SOURCE_EXTENSION_WEATHER_BACKEND:
+ *
+ * Pass this extension name to e_source_get_extension() to access
+ * #ESourceWeather.  This is also used as a group name in key files.
+ *
+ * Since: 3.18
+ **/
 #define E_SOURCE_EXTENSION_WEATHER_BACKEND "Weather Backend"
 
 G_BEGIN_DECLS