From ab870b27cd05cc39e4755de9c6d9e02944977c17 Mon Sep 17 00:00:00 2001
From: Matthew Barnes <mbarnes@redhat.com>
Date: Tue, 1 Mar 2011 13:04:09 -0500
Subject: Fix Gtk-Doc comment notation.

Seeing lots of what I assume to be doxygen syntax in comment blocks.
---
 calendar/gui/dialogs/comp-editor-util.c | 28 ++++++++++++++++++----------
 calendar/gui/dialogs/comp-editor.c      |  8 ++++----
 calendar/gui/dialogs/event-page.c       |  8 +++++---
 calendar/gui/dialogs/task-page.c        |  5 +++--
 4 files changed, 30 insertions(+), 19 deletions(-)

(limited to 'calendar/gui/dialogs')

diff --git a/calendar/gui/dialogs/comp-editor-util.c b/calendar/gui/dialogs/comp-editor-util.c
index a29d75739c..a98314b389 100644
--- a/calendar/gui/dialogs/comp-editor-util.c
+++ b/calendar/gui/dialogs/comp-editor-util.c
@@ -285,12 +285,18 @@ free_slist_strs (gpointer data)
 
 /**
  * comp_editor_manage_new_attendees:
+ * @comp: The component.
+ * @ma: An attendee.
+ * @add: %TRUE to add attendee's email to new-attendees, %FALSE to remove
+ * from it.
+ *
  * Manages the 'new-attendees' string of new attendees of the component.
- * @param comp: The component.
- * @param ma: An attendee.
- * @param add: TRUE to add attendee's email to new-attendees, FALSE to remove from it.
  *
- * @note The list is just string of emails separated by ';'
+ * <note>
+ *   <para>
+ *     The list is just string of emails separated by ';'
+ *   </para>
+ * </note>
  **/
 void
 comp_editor_manage_new_attendees (ECalComponent *comp,
@@ -316,9 +322,10 @@ comp_editor_manage_new_attendees (ECalComponent *comp,
 
 /**
  * comp_editor_copy_new_attendees:
- * Copies "new-attendees" information from src to des component.
- * @param des: Component, to copy to.
- * @param src: Component, to copy from.
+ * @des: Component, to copy to.
+ * @src: Component, to copy from.
+ *
+ * Copies "new-attendees" information from @src to @des component.
  **/
 void
 comp_editor_copy_new_attendees (ECalComponent *des, ECalComponent *src)
@@ -337,9 +344,10 @@ comp_editor_copy_new_attendees (ECalComponent *des, ECalComponent *src)
 
 /**
  * comp_editor_have_in_new_attendees:
- * @param comp: Component with the "new-attendees" possibly set.
- * @param ma: Meeting attendee to check.
- * @return Whether ma is present in the list of new attendees of the comp.
+ * @comp: Component with the "new-attendees" possibly set.
+ * @ma: Meeting attendee to check.
+ *
+ * Returns: Whether @ma is present in the list of new attendees of the comp.
  **/
 gboolean
 comp_editor_have_in_new_attendees (ECalComponent *comp, EMeetingAttendee *ma)
diff --git a/calendar/gui/dialogs/comp-editor.c b/calendar/gui/dialogs/comp-editor.c
index 2d0f524c10..b6be8bd7e6 100644
--- a/calendar/gui/dialogs/comp-editor.c
+++ b/calendar/gui/dialogs/comp-editor.c
@@ -3193,11 +3193,11 @@ comp_editor_get_comp (CompEditor *editor)
 
 /**
  * comp_editor_get_current_comp
+ * @editor: a #CompEditor
+ * @correct: Set this no non-%NULL if you are interested to know if all
+ * pages reported success when filling component.
  *
- * @param editor
- * @param correct Set this no non-NULL if you are interested to know if
- *                all pages reported success when filling component.
- * @return Newly allocated component, should be unref-ed by g_object_unref.
+ * Returns: Newly allocated component, should be unref-ed by g_object_unref().
  **/
 ECalComponent *
 comp_editor_get_current_comp (CompEditor *editor, gboolean *correct)
diff --git a/calendar/gui/dialogs/event-page.c b/calendar/gui/dialogs/event-page.c
index e4459a4779..5d340a7b13 100644
--- a/calendar/gui/dialogs/event-page.c
+++ b/calendar/gui/dialogs/event-page.c
@@ -3304,9 +3304,10 @@ event_page_get_name_selector (EventPage *epage)
 
 /**
  * event_page_add_attendee
+ * @epage: an #EventPage
+ * @attendee: Attendee to be added.
+ *
  * Add attendee to meeting store and name selector.
- * @param epage EventPage.
- * @param attendee Attendee to be added.
  **/
 void
 event_page_add_attendee (EventPage *epage, EMeetingAttendee *attendee)
@@ -3328,8 +3329,9 @@ event_page_add_attendee (EventPage *epage, EMeetingAttendee *attendee)
 
 /**
  * event_page_remove_all_attendees
+ * @epage: an #EventPage
+ *
  * Removes all attendees from the meeting store and name selector.
- * @param epage EventPage.
  **/
 void
 event_page_remove_all_attendees (EventPage *epage)
diff --git a/calendar/gui/dialogs/task-page.c b/calendar/gui/dialogs/task-page.c
index 8555afdcc9..2bc4988b6e 100644
--- a/calendar/gui/dialogs/task-page.c
+++ b/calendar/gui/dialogs/task-page.c
@@ -2148,9 +2148,10 @@ task_page_get_cancel_comp (TaskPage *page)
 
 /**
  * task_page_add_attendee
+ * @tpage: a #TaskPage
+ * @attendee: Attendee to be added.
+ *
  * Add attendee to meeting store and name selector.
- * @param tpage TaskPage.
- * @param attendee Attendee to be added.
  **/
 void
 task_page_add_attendee (TaskPage *tpage, EMeetingAttendee *attendee)
-- 
cgit v1.2.3