[evolution-data-server/gnome-3-6] Fix invalid Gtk-Doc syntax in comments.



commit 22a53d47e25b0f9e0dc6ab513037df30e768d951
Author: Matthew Barnes <mbarnes redhat com>
Date:   Fri Nov 2 13:15:00 2012 -0400

    Fix invalid Gtk-Doc syntax in comments.
    
    Not certain this is everything, just what I could find.

 addressbook/libedata-book/e-data-book-view.c |    7 ++++---
 calendar/libecal/e-cal-check-timezones.c     |    2 +-
 calendar/libecal/e-cal-client.c              |   22 +++++++++++-----------
 calendar/libecal/e-cal-component.c           |    7 ++++---
 calendar/libecal/e-cal.c                     |   22 +++++++++++-----------
 calendar/libedata-cal/e-cal-backend.c        |    4 ++--
 6 files changed, 33 insertions(+), 31 deletions(-)
---
diff --git a/addressbook/libedata-book/e-data-book-view.c b/addressbook/libedata-book/e-data-book-view.c
index a752165..ce78805 100644
--- a/addressbook/libedata-book/e-data-book-view.c
+++ b/addressbook/libedata-book/e-data-book-view.c
@@ -444,7 +444,7 @@ e_data_book_view_notify_update (EDataBookView *book_view,
  * whether the change causes the contact to start matching,
  * no longer match, or stay matching the query specified
  * by @book_view.  This method should be preferred over
- * #e_data_book_view_notify_update when the native
+ * e_data_book_view_notify_update() when the native
  * representation of a contact is a vCard.
  **/
 void
@@ -493,11 +493,12 @@ e_data_book_view_notify_update_vcard (EDataBookView *book_view,
  * whether the change causes the contact to start matching,
  * no longer match, or stay matching the query specified
  * by @book_view.  This method should be preferred over
- * #e_data_book_view_notify_update when the native
+ * e_data_book_view_notify_update() when the native
  * representation of a contact is a vCard.
  *
  * The important difference between this method and
- * #e_data_book_view_notify_update and #e_data_book_view_notify_update_vcard is
+ * e_data_book_view_notify_update() and
+ * e_data_book_view_notify_update_vcard() is
  * that it doesn't match the contact against the book view query to see if it
  * should be included, it assumes that this has been done and the contact is
  * known to exist in the view.
diff --git a/calendar/libecal/e-cal-check-timezones.c b/calendar/libecal/e-cal-check-timezones.c
index dfc43f0..e8f2fea 100644
--- a/calendar/libecal/e-cal-check-timezones.c
+++ b/calendar/libecal/e-cal-check-timezones.c
@@ -238,7 +238,7 @@ addsystemtz (gpointer key,
  * Some programs generate broken meeting invitations with TZID, but
  * without including the corresponding VTIMEZONE. Importing such
  * invitations unchanged causes problems later on (meeting displayed
- * incorrectly, #e_cal_get_component_as_string fails). The situation
+ * incorrectly, e_cal_get_component_as_string() fails). The situation
  * where this occurred in the past (found by a SyncEvolution user) is
  * now handled via the location based mapping.
  *
diff --git a/calendar/libecal/e-cal-client.c b/calendar/libecal/e-cal-client.c
index 79ad3d9..9cc7687 100644
--- a/calendar/libecal/e-cal-client.c
+++ b/calendar/libecal/e-cal-client.c
@@ -1622,8 +1622,8 @@ generate_instances_got_objects_cb (struct get_objects_async_data *goad,
  * @cb_data: Closure data for the callback.
  * @destroy_cb_data: Function to call when the processing is done, to free @cb_data; can be %NULL.
  *
- * Does a combination of #e_cal_client_get_object_list () and
- * #e_cal_client_recur_generate_instances(). Unlike #e_cal_client_generate_instances_sync (),
+ * Does a combination of e_cal_client_get_object_list () and
+ * e_cal_client_recur_generate_instances(). Unlike e_cal_client_generate_instances_sync (),
  * this returns immediately and the @cb callback is called asynchronously.
  *
  * The callback function should do a g_object_ref() of the calendar component
@@ -1794,9 +1794,9 @@ generate_instances_for_object_got_objects_cb (struct get_objects_async_data *goa
  * @cb_data: Closure data for the callback.
  * @destroy_cb_data: Function to call when the processing is done, to free @cb_data; can be %NULL.
  *
- * Does a combination of #e_cal_client_get_object_list () and
- * #e_cal_client_recur_generate_instances(), like #e_cal_client_generate_instances(), but
- * for a single object. Unlike #e_cal_client_generate_instances_for_object_sync (),
+ * Does a combination of e_cal_client_get_object_list() and
+ * e_cal_client_recur_generate_instances(), like e_cal_client_generate_instances(), but
+ * for a single object. Unlike e_cal_client_generate_instances_for_object_sync (),
  * this returns immediately and the @cb callback is called asynchronously.
  *
  * The callback function should do a g_object_ref() of the calendar component
@@ -1899,8 +1899,8 @@ e_cal_client_generate_instances_for_object (ECalClient *client,
  * @cb: (closure cb_data) (scope call): Callback for each generated instance
  * @cb_data: (closure): Closure data for the callback
  *
- * Does a combination of #e_cal_client_get_object_list () and
- * #e_cal_client_recur_generate_instances(), like #e_cal_client_generate_instances_sync(), but
+ * Does a combination of e_cal_client_get_object_list() and
+ * e_cal_client_recur_generate_instances(), like e_cal_client_generate_instances_sync(), but
  * for a single object.
  *
  * The callback function should do a g_object_ref() of the calendar component
@@ -3022,7 +3022,7 @@ complete_get_object_list (gboolean res,
  *
  * Finishes previous call of e_cal_client_get_object_list() and
  * sets @icalcomps to a matching list of #icalcomponent-s.
- * This list should be freed with #e_cal_client_free_icalcomp_slist().
+ * This list should be freed with e_cal_client_free_icalcomp_slist().
  *
  * Returns: %TRUE if successful, %FALSE otherwise.
  *
@@ -3056,7 +3056,7 @@ e_cal_client_get_object_list_finish (ECalClient *client,
  * Gets a list of objects from the calendar that match the query specified
  * by the @sexp argument. The objects will be returned in the @icalcomps
  * argument, which is a list of #icalcomponent.
- * This list should be freed with #e_cal_client_free_icalcomp_slist().
+ * This list should be freed with e_cal_client_free_icalcomp_slist().
  *
  * Returns: %TRUE if successful, %FALSE otherwise.
  *
@@ -3169,7 +3169,7 @@ complete_get_object_list_as_comps (gboolean res,
  *
  * Finishes previous call of e_cal_client_get_object_list_as_comps() and
  * sets @ecalcomps to a matching list of #ECalComponent-s.
- * This list should be freed with #e_cal_client_free_ecalcomp_slist().
+ * This list should be freed with e_cal_client_free_ecalcomp_slist().
  *
  * Returns: %TRUE if successful, %FALSE otherwise.
  *
@@ -3203,7 +3203,7 @@ e_cal_client_get_object_list_as_comps_finish (ECalClient *client,
  * Gets a list of objects from the calendar that match the query specified
  * by the @sexp argument. The objects will be returned in the @ecalcomps
  * argument, which is a list of #ECalComponent.
- * This list should be freed with #e_cal_client_free_ecalcomp_slist().
+ * This list should be freed with e_cal_client_free_ecalcomp_slist().
  *
  * Returns: %TRUE if successful, %FALSE otherwise.
  *
diff --git a/calendar/libecal/e-cal-component.c b/calendar/libecal/e-cal-component.c
index 80324e8..249b8b9 100644
--- a/calendar/libecal/e-cal-component.c
+++ b/calendar/libecal/e-cal-component.c
@@ -1418,9 +1418,10 @@ e_cal_component_commit_sequence (ECalComponent *comp)
  * e_cal_component_abort_sequence:
  * @comp: A calendar component object.
  *
- * Aborts the sequence change needed in the given calendar component, which
- * means it will not require a sequence commit (via #e_cal_component_commit_sequence)
- * even if the changes done require a sequence increment.
+ * Aborts the sequence change needed in the given calendar component,
+ * which means it will not require a sequence commit (via
+ * e_cal_component_commit_sequence()) even if the changes done require a
+ * sequence increment.
  */
 void
 e_cal_component_abort_sequence (ECalComponent *comp)
diff --git a/calendar/libecal/e-cal.c b/calendar/libecal/e-cal.c
index e271d23..810f3ea 100644
--- a/calendar/libecal/e-cal.c
+++ b/calendar/libecal/e-cal.c
@@ -903,7 +903,7 @@ set_local_attachment_store (ECal *ecal)
  * @type: Type of the client.
  *
  * Creates a new calendar client. This does not open the calendar itself,
- * for that, #e_cal_open or #e_cal_open_async needs to be called.
+ * for that, e_cal_open() or e_cal_open_async() needs to be called.
  *
  * Returns: A newly-created calendar client, or NULL if the client could
  * not be constructed because it could not contact the calendar server.
@@ -1359,7 +1359,7 @@ e_cal_get_source_type (ECal *ecal)
  * Queries the state of loading of a calendar client.
  *
  * Returns: A #ECalLoadState value indicating whether the client has
- * not been loaded with #e_cal_open yet, whether it is being
+ * not been loaded with e_cal_open() yet, whether it is being
  * loaded, or whether it is already loaded.
  *
  * Deprecated: 3.2: Use e_client_is_opened() on an #ECalClient instead.
@@ -2199,7 +2199,7 @@ e_cal_free_change_list (GList *list)
  * Gets a list of objects from the calendar that match the query specified
  * by the @query argument. The objects will be returned in the @objects
  * argument, which is a list of #icalcomponent. When done, this list
- * should be freed by using the #e_cal_free_object_list function.
+ * should be freed by using the e_cal_free_object_list() function.
  *
  * Returns: TRUE if the operation was successful, FALSE otherwise.
  *
@@ -2300,7 +2300,7 @@ e_cal_get_object_list_as_comp (ECal *ecal,
  * e_cal_free_object_list: (skip)
  * @objects: List of objects to be freed.
  *
- * Frees a list of objects as returned by #e_cal_get_object_list.
+ * Frees a list of objects as returned by e_cal_get_object_list().
  *
  * Deprecated: 3.2: Use e_cal_client_free_icalcomp_slist() instead.
  */
@@ -2789,8 +2789,8 @@ try_again:
  * @cb: Callback for each generated instance.
  * @cb_data: Closure data for the callback.
  *
- * Does a combination of #e_cal_get_object_list () and
- * #e_cal_recur_generate_instances().
+ * Does a combination of e_cal_get_object_list() and
+ * e_cal_recur_generate_instances().
  *
  * The callback function should do a g_object_ref() of the calendar component
  * it gets passed if it intends to keep it around, since it will be unref'ed
@@ -2829,8 +2829,8 @@ e_cal_generate_instances (ECal *ecal,
  * @cb: Callback for each generated instance.
  * @cb_data: Closure data for the callback.
  *
- * Does a combination of #e_cal_get_object_list () and
- * #e_cal_recur_generate_instances(), like #e_cal_generate_instances(), but
+ * Does a combination of e_cal_get_object_list() and
+ * e_cal_recur_generate_instances(), like e_cal_generate_instances(), but
  * for a single object.
  *
  * The callback function should do a g_object_ref() of the calendar component
@@ -2972,9 +2972,9 @@ build_component_alarms_list (ECal *ecal,
  * time.
  *
  * Returns: A list of #ECalComponentAlarms structures.  This should be freed
- * using the #e_cal_free_alarms() function, or by freeing each element
- * separately with #e_cal_component_alarms_free() and then freeing the list with
- * #g_slist_free().
+ * using the e_cal_free_alarms() function, or by freeing each element
+ * separately with e_cal_component_alarms_free() and then freeing the list with
+ * g_slist_free().
  *
  * Deprecated: 3.2: This function has been dropped completely.
  **/
diff --git a/calendar/libedata-cal/e-cal-backend.c b/calendar/libedata-cal/e-cal-backend.c
index fb6ed86..4258780 100644
--- a/calendar/libedata-cal/e-cal-backend.c
+++ b/calendar/libedata-cal/e-cal-backend.c
@@ -1637,7 +1637,7 @@ object_created_cb (EDataCalView *view,
  *
  * Notifies each of the backend's listeners about a new object.
  *
- * #e_data_cal_notify_object_created() calls this for you. You only need to
+ * e_data_cal_notify_object_created() calls this for you. You only need to
  * call e_cal_backend_notify_object_created() yourself to report objects
  * created by non-EDS clients.
  *
@@ -1731,7 +1731,7 @@ call_match_and_notify_object (EDataCalView *view,
  *
  * Notifies each of the backend's listeners about a modified object.
  *
- * #e_data_cal_notify_object_modified() calls this for you. You only need to
+ * e_data_cal_notify_object_modified() calls this for you. You only need to
  * call e_cal_backend_notify_object_modified() yourself to report objects
  * modified by non-EDS clients.
  *



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