GNOME.org
 

[evolution-data-server] Correct some developer code comments and annotations

commit d7036fa73fb3d18560355271497cb1be541ab441
Author: Milan Crha <mcrha redhat com>
Date:   Thu May 18 10:04:06 2017 +0200

    Correct some developer code comments and annotations

 src/addressbook/libebook-contacts/e-vcard.c  |    2 +-
 src/addressbook/libedata-book/e-book-cache.c |    4 ++--
 src/calendar/libedata-cal/e-cal-cache.c      |    2 +-
 src/calendar/libedata-cal/e-cal-cache.h      |    2 +-
 src/libedataserver/e-soup-session.c          |    2 +-
 src/libedataserver/e-webdav-session.c        |   26 +++++++++++++++-----------
 src/libedataserver/e-xml-utils.c             |   22 +++++++++++-----------
 src/vala/EDataServer-1.2.metadata            |    1 -
 8 files changed, 32 insertions(+), 29 deletions(-)
---
diff --git a/src/addressbook/libebook-contacts/e-vcard.c b/src/addressbook/libebook-contacts/e-vcard.c
index f9d897c..f11a17d 100644
--- a/src/addressbook/libebook-contacts/e-vcard.c
+++ b/src/addressbook/libebook-contacts/e-vcard.c
@@ -2920,7 +2920,7 @@ e_vcard_util_set_x_attribute (EVCard *vcard,
  * @vcard: an #EVCard
  * @x_name: the attribute name, which starts with "X-"
  *
- * Returns: (nullable) (transfer-full): Value of attribute @x_name, or %NULL,
+ * Returns: (nullable) (transfer full): Value of attribute @x_name, or %NULL,
  *    when there is no such attribute. Free the returned pointer with g_free(),
  *    when no longer needed.
  *
diff --git a/src/addressbook/libedata-book/e-book-cache.c b/src/addressbook/libedata-book/e-book-cache.c
index 9538988..9b7efa2 100644
--- a/src/addressbook/libedata-book/e-book-cache.c
+++ b/src/addressbook/libedata-book/e-book-cache.c
@@ -6090,8 +6090,8 @@ e_book_cache_class_init (EBookCacheClass *klass)
                G_TYPE_BOOLEAN);
 
        /**
-        * @EBookCache:dup-contact-revision:
-        * A signal being called to get revision of an EContact.
+        * EBookCache:dup-contact-revision:
+        * A signal being called to get revision of an #EContact.
         * The default implementation returns E_CONTACT_REV field value.
         **/
        signals[DUP_CONTACT_REVISION] = g_signal_new (
diff --git a/src/calendar/libedata-cal/e-cal-cache.c b/src/calendar/libedata-cal/e-cal-cache.c
index 47c467f..a3c14ec 100644
--- a/src/calendar/libedata-cal/e-cal-cache.c
+++ b/src/calendar/libedata-cal/e-cal-cache.c
@@ -3612,7 +3612,7 @@ e_cal_cache_class_init (ECalCacheClass *klass)
        klass->dup_component_revision = ecc_dup_component_revision;
 
        /**
-        * @ECalCache:dup-component-revision:
+        * ECalCache:dup-component-revision:
         * A signal being called to get revision of an icalcomponent.
         * The default implementation uses a concatenation of
         * DTSTAMP '-' LASTMODIFIED '-' SEQUENCE.
diff --git a/src/calendar/libedata-cal/e-cal-cache.h b/src/calendar/libedata-cal/e-cal-cache.h
index ede88a7..8d1b312 100644
--- a/src/calendar/libedata-cal/e-cal-cache.h
+++ b/src/calendar/libedata-cal/e-cal-cache.h
@@ -121,7 +121,7 @@ ECalCacheSearchData *
                                                 const gchar *extra);
 ECalCacheSearchData *
                e_cal_cache_search_data_copy    (const ECalCacheSearchData *data);
-void           e_cal_cache_search_data_free    (/* ECalCacheSearchData * */ gpointer data);
+void           e_cal_cache_search_data_free    (/* ECalCacheSearchData * */ gpointer ptr);
 
 /**
  * ECalCacheSearchFunc:
diff --git a/src/libedataserver/e-soup-session.c b/src/libedataserver/e-soup-session.c
index 437a941..a790a5b 100644
--- a/src/libedataserver/e-soup-session.c
+++ b/src/libedataserver/e-soup-session.c
@@ -684,7 +684,7 @@ e_soup_session_new_request (ESoupSession *session,
 }
 
 /**
- * e_soup_session_new_request:
+ * e_soup_session_new_request_uri:
  * @session: an #ESoupSession
  * @method: an HTTP method
  * @uri: a #SoupURI to use for the request
diff --git a/src/libedataserver/e-webdav-session.c b/src/libedataserver/e-webdav-session.c
index 1db6a2c..f01471e 100644
--- a/src/libedataserver/e-webdav-session.c
+++ b/src/libedataserver/e-webdav-session.c
@@ -59,6 +59,10 @@ G_DEFINE_BOXED_TYPE (EWebDAVAccessControlEntry, e_webdav_access_control_entry, e
  * @href: href of the resource
  * @etag: (nullable): optional ETag of the resource, or %NULL
  * @display_name: (nullable): optional display name of the resource, or %NULL
+ * @content_type: (nullable): optional Content-Type of the resource, or %NULL
+ * @content_length: optional Content-Length of the resource, or 0
+ * @creation_date: optional date of creation of the resource, or 0
+ * @last_modified: optional last modified time of the resource, or 0
  * @description: (nullable): optional description of the resource, or %NULL
  * @color: (nullable): optional color of the resource, or %NULL
  *
@@ -1258,8 +1262,8 @@ e_webdav_session_post_sync (EWebDAVSession *webdav,
  * @uri: (nullable): URI to issue the request for, or %NULL to read from #ESource
  * @depth: requested depth, can be one of %E_WEBDAV_DEPTH_THIS, %E_WEBDAV_DEPTH_THIS_AND_CHILDREN or 
%E_WEBDAV_DEPTH_INFINITY
  * @xml: (nullable): the request itself, as an #EXmlDocument, the root element should be DAV:propfind, or 
%NULL
- * @func: an #EWebDAVPropstatTraverseFunc function to call for each DAV:propstat in the multistatus response
- * @func_user_data: user data passed to @func
+ * @func: (scope call): an #EWebDAVPropstatTraverseFunc function to call for each DAV:propstat in the 
multistatus response
+ * @func_user_data: (closure func): user data passed to @func
  * @cancellable: optional #GCancellable object, or %NULL
  * @error: return location for a #GError, or %NULL
  *
@@ -1425,8 +1429,8 @@ e_webdav_session_proppatch_sync (EWebDAVSession *webdav,
  * @uri: (nullable): URI to issue the request for, or %NULL to read from #ESource
  * @depth: (nullable): requested depth, can be %NULL, then no Depth header is sent
  * @xml: the request itself, as an #EXmlDocument
- * @func: (nullable): an #EWebDAVPropstatTraverseFunc function to call for each DAV:propstat in the 
multistatus response, or %NULL
- * @func_user_data: user data passed to @func
+ * @func: (nullable) (scope call): an #EWebDAVPropstatTraverseFunc function to call for each DAV:propstat in 
the multistatus response, or %NULL
+ * @func_user_data: (closure func): user data passed to @func
  * @out_content_type: (nullable) (transfer full): return location for response Content-Type, or %NULL
  * @out_content: (nullable) (transfer full): return location for response content, or %NULL
  * @cancellable: optional #GCancellable object, or %NULL
@@ -1887,7 +1891,7 @@ e_webdav_session_extract_href_and_etag (SoupMessage *message,
  * @uri: URI of the resource to read
  * @out_href: (out) (nullable) (transfer full): optional return location for href of the resource, or %NULL
  * @out_etag: (out) (nullable) (transfer full): optional return location for etag of the resource, or %NULL
- * @out_stream: (out) (caller-allocates): a #GOutputStream to write data to
+ * @out_stream: (out caller-allocates): a #GOutputStream to write data to
  * @cancellable: optional #GCancellable object, or %NULL
  * @error: return location for a #GError, or %NULL
  *
@@ -3010,8 +3014,8 @@ e_webdav_session_traverse_propstat_response (EWebDAVSession *webdav,
  * @webdav: an #EWebDAVSession
  * @message: (nullable): an optional #SoupMessage corresponding to the response, or %NULL
  * @xml_data: a #GByteArray containing DAV:multistatus response
- * @func: an #EWebDAVPropstatTraverseFunc function to call for each DAV:propstat in the multistatus response
- * @func_user_data: user data passed to @func
+ * @func: (scope call): an #EWebDAVPropstatTraverseFunc function to call for each DAV:propstat in the 
multistatus response
+ * @func_user_data: (closure func): user data passed to @func
  * @error: return location for a #GError, or %NULL
  *
  * Traverses a DAV:multistatus response and calls @func for each returned DAV:propstat.
@@ -3052,8 +3056,8 @@ e_webdav_session_traverse_multistatus_response (EWebDAVSession *webdav,
  * @webdav: an #EWebDAVSession
  * @message: (nullable): an optional #SoupMessage corresponding to the response, or %NULL
  * @xml_data: a #GByteArray containing DAV:mkcol-response response
- * @func: an #EWebDAVPropstatTraverseFunc function to call for each DAV:propstat in the response
- * @func_user_data: user data passed to @func
+ * @func: (scope call): an #EWebDAVPropstatTraverseFunc function to call for each DAV:propstat in the 
response
+ * @func_user_data: (closure func): user data passed to @func
  * @error: return location for a #GError, or %NULL
  *
  * Traverses a DAV:mkcol-response response and calls @func for each returned DAV:propstat.
@@ -3094,8 +3098,8 @@ e_webdav_session_traverse_mkcol_response (EWebDAVSession *webdav,
  * @webdav: an #EWebDAVSession
  * @message: (nullable): an optional #SoupMessage corresponding to the response, or %NULL
  * @xml_data: a #GByteArray containing CALDAV:mkcalendar-response response
- * @func: an #EWebDAVPropstatTraverseFunc function to call for each DAV:propstat in the response
- * @func_user_data: user data passed to @func
+ * @func: (scope call): an #EWebDAVPropstatTraverseFunc function to call for each DAV:propstat in the 
response
+ * @func_user_data: (closure func): user data passed to @func
  * @error: return location for a #GError, or %NULL
  *
  * Traverses a CALDAV:mkcalendar-response response and calls @func for each returned DAV:propstat.
diff --git a/src/libedataserver/e-xml-utils.c b/src/libedataserver/e-xml-utils.c
index 381a351..9aa5b5f 100644
--- a/src/libedataserver/e-xml-utils.c
+++ b/src/libedataserver/e-xml-utils.c
@@ -39,7 +39,7 @@
 #endif
 
 /**
- * e_xml_parse_file:
+ * e_xml_parse_file: (skip)
  * @filename: path to an XML file
  *
  * Reads a local XML file and parses the contents into an XML document
@@ -152,7 +152,7 @@ e_xml_save_file (const gchar *filename,
 }
 
 /**
- * e_xml_get_child_by_name:
+ * e_xml_get_child_by_name: (skip)
  * @parent: an XML node structure
  * @child_name: element name of a child node
  *
@@ -179,9 +179,9 @@ e_xml_get_child_by_name (const xmlNode *parent,
 }
 
 /**
- * e_xml_parse_data:
- * @data: an XML data
- * @length: (length-of data): length of data, should be greated than zero
+ * e_xml_parse_data: (skip)
+ * @data: (array length=length) (element-type guint8): an XML data
+ * @length: length of data, should be greated than zero
  *
  * Parses XML data into an #xmlDocPtr. Free returned pointer
  * with xmlFreeDoc(), when no longer needed.
@@ -202,7 +202,7 @@ e_xml_parse_data (gconstpointer data,
 }
 
 /**
- * e_xml_new_xpath_context_with_namespaces:
+ * e_xml_new_xpath_context_with_namespaces: (skip)
  * @doc: an #xmlDocPtr
  * @...: %NULL-terminated list of pairs (prefix, href) with namespaces
  *
@@ -247,7 +247,7 @@ e_xml_new_xpath_context_with_namespaces (xmlDoc *doc,
 }
 
 /**
- * e_xml_xpath_context_register_namespaces:
+ * e_xml_xpath_context_register_namespaces: (skip)
  * @xpath_ctx: an #xmlXPathContextPtr
  * @prefix: namespace prefix
  * @href: namespace href
@@ -303,7 +303,7 @@ e_xml_xpath_context_register_namespaces (xmlXPathContext *xpath_ctx,
 }
 
 /**
- * e_xml_xpath_eval:
+ * e_xml_xpath_eval: (skip)
  * @xpath_ctx: an #xmlXPathContextPtr
  * @format: printf-like format specifier of path to evaluate
  * @...: arguments for the @format
@@ -320,7 +320,7 @@ e_xml_xpath_context_register_namespaces (xmlXPathContext *xpath_ctx,
  * Since: 3.26
  **/
 xmlXPathObject *
-e_xml_xpath_eval (xmlXPathContextPtr xpath_ctx,
+e_xml_xpath_eval (xmlXPathContext *xpath_ctx,
                  const gchar *format,
                  ...)
 {
@@ -351,7 +351,7 @@ e_xml_xpath_eval (xmlXPathContextPtr xpath_ctx,
 }
 
 /**
- * e_xml_xpath_eval_as_string:
+ * e_xml_xpath_eval_as_string: (skip)
  * @xpath_ctx: an #xmlXPathContextPtr
  * @format: printf-like format specifier of path to evaluate
  * @...: arguments for the @format
@@ -407,7 +407,7 @@ e_xml_xpath_eval_as_string (xmlXPathContext *xpath_ctx,
 }
 
 /**
- * e_xml_xpath_eval_exists:
+ * e_xml_xpath_eval_exists: (skip)
  * @xpath_ctx: an #xmlXPathContextPtr
  * @format: printf-like format specifier of path to evaluate
  * @...: arguments for the @format
diff --git a/src/vala/EDataServer-1.2.metadata b/src/vala/EDataServer-1.2.metadata
index 4d17726..b643b5d 100644
--- a/src/vala/EDataServer-1.2.metadata
+++ b/src/vala/EDataServer-1.2.metadata
@@ -1,5 +1,4 @@
 // libxml2: replace xml.NodePtr by xml.Node* used by Vala bindings
-xml_save_file.doc type="Xml.Doc*"
 xml_from_hash skip=false type="Xml.Doc*"
 xmlhash_new skip=false type="E.XmlHash"
 xml_parse_file skip=false type="Xml.Doc*"
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]