GNOME.org
 

[evolution-kolab/gnome-2-30] evolution-kolab: gtk-doc fixups

commit bc31fd43fd52d8572c89b231315353ec3c807a33
Author: Christian Hilberg <hilberg kernelconcepts de>
Date:   Fri Nov 18 16:21:39 2011 +0100

    evolution-kolab: gtk-doc fixups
    
    * added missing function params to doc comments
    * fixed sgml files (source files came and went,
      have been renamed, ...)

 .../evolution-kolab_addressbook-docs.sgml          |    7 ++---
 .../calendar/evolution-kolab_calendar-docs.sgml    |    6 ++--
 .../camel/evolution-kolab_camel-docs.sgml          |   23 ++++---------------
 .../libekolab/evolution-kolab_libekolab-docs.sgml  |    6 -----
 .../evolution-kolab_libekolabconv-docs.sgml        |   16 +-------------
 src/addressbook/kolab-util-contact-cache.c         |    8 ++++--
 src/calendar/kolab-util-calendar-cache.c           |   19 ++++++++-------
 src/calendar/kolab-util-calendar.c                 |    2 +-
 src/libekolab/kolab-mail-access.c                  |    2 +
 src/libekolab/kolab-settings-handler.c             |    2 -
 src/libekolab/kolab-util-backend.c                 |    2 +-
 11 files changed, 31 insertions(+), 62 deletions(-)
---
diff --git a/docs/reference/addressbook/evolution-kolab_addressbook-docs.sgml b/docs/reference/addressbook/evolution-kolab_addressbook-docs.sgml
index 56cc39f..35ccba7 100644
--- a/docs/reference/addressbook/evolution-kolab_addressbook-docs.sgml
+++ b/docs/reference/addressbook/evolution-kolab_addressbook-docs.sgml
@@ -16,11 +16,10 @@
 
   <chapter>
     <title>[Insert title here]</title>
-        <xi:include href="xml/e-book-backend-kolab-gal.xml"/>
+    <xi:include href="xml/e-book-backend-kolab-factory.xml"/>
     <xi:include href="xml/e-book-backend-kolab.xml"/>
-    <xi:include href="xml/e-book-backend-factory-kolab-gal.xml"/>
-    <xi:include href="xml/e-book-backend-factory-kolab.xml"/>
-
+    <xi:include href="xml/kolab-util-contact-cache.xml" />
+    <xi:include href="xml/kolab-util-contact.xml" />
   </chapter>
   <chapter id="object-tree">
     <title>Object Hierarchy</title>
diff --git a/docs/reference/calendar/evolution-kolab_calendar-docs.sgml b/docs/reference/calendar/evolution-kolab_calendar-docs.sgml
index 1a2fd03..b0c5e57 100644
--- a/docs/reference/calendar/evolution-kolab_calendar-docs.sgml
+++ b/docs/reference/calendar/evolution-kolab_calendar-docs.sgml
@@ -16,10 +16,10 @@
 
   <chapter>
     <title>[Insert title here]</title>
-        <xi:include href="xml/kolab-util-calendar.xml"/>
-    <xi:include href="xml/e-cal-backend-kolab.xml"/>
     <xi:include href="xml/e-cal-backend-kolab-factory.xml"/>
-
+    <xi:include href="xml/e-cal-backend-kolab.xml"/>
+    <xi:include href="xml/kolab-util-calendar-cache.xml" />
+    <xi:include href="xml/kolab-util-calendar.xml"/>
   </chapter>
   <chapter id="object-tree">
     <title>Object Hierarchy</title>
diff --git a/docs/reference/camel/evolution-kolab_camel-docs.sgml b/docs/reference/camel/evolution-kolab_camel-docs.sgml
index 9732768..9bb2976 100644
--- a/docs/reference/camel/evolution-kolab_camel-docs.sgml
+++ b/docs/reference/camel/evolution-kolab_camel-docs.sgml
@@ -16,27 +16,14 @@
 
   <chapter>
     <title>[Insert title here]</title>
-        <xi:include href="xml/camel-kolab-imapx-store.xml"/>
+    <xi:include href="xml/camel-kolab-imapx-folder.xml" />
+    <xi:include href="xml/camel-kolab-imapx-metadata-db.xml"/>
+    <xi:include href="xml/camel-kolab-imapx-metadata.xml"/>
+    <xi:include href="xml/camel-kolab-imapx-provider.xml"/>
+    <xi:include href="xml/camel-kolab-imapx-store.xml"/>
     <xi:include href="xml/camel-kolab-imapx-transport.xml"/>
     <xi:include href="xml/camel-kolab-session.xml"/>
-    <xi:include href="xml/camel-imapx-server.xml"/>
-    <xi:include href="xml/camel-imapx-folder.xml"/>
-    <xi:include href="xml/camel-imapx-stream.xml"/>
-    <xi:include href="xml/camel-imapx-summary.xml"/>
-    <xi:include href="xml/camel-imapx-store.xml"/>
-    <xi:include href="xml/camel-imapx-store-summary.xml"/>
-    <xi:include href="xml/camel-kolab-utils.xml"/>
     <xi:include href="xml/camel-kolab-stream.xml"/>
-    <xi:include href="xml/camel-kolab-provider.xml"/>
-    <xi:include href="xml/camel-private.xml"/>
-    <xi:include href="xml/camel-kolab-imapx-metadata-db.xml"/>
-    <xi:include href="xml/camel-kolab-imapx-provider.xml"/>
-    <xi:include href="xml/camel-kolab-imapx-metadata.xml"/>
-    <xi:include href="xml/camel-kolab-http.xml"/>
-    <xi:include href="xml/camel-imapx-metadata.xml"/>
-    <xi:include href="xml/camel-imapx-exception.xml"/>
-    <xi:include href="xml/camel-imapx-utils.xml"/>
-    <xi:include href="xml/camel-imapx-view-summary.xml"/>
 
   </chapter>
   <chapter id="object-tree">
diff --git a/docs/reference/libekolab/evolution-kolab_libekolab-docs.sgml b/docs/reference/libekolab/evolution-kolab_libekolab-docs.sgml
index 4ad4b22..4ff3028 100644
--- a/docs/reference/libekolab/evolution-kolab_libekolab-docs.sgml
+++ b/docs/reference/libekolab/evolution-kolab_libekolab-docs.sgml
@@ -23,18 +23,12 @@
     <xi:include href="xml/kolab-mail-info-db.xml"/>
     <xi:include href="xml/kolab-mail-side-cache.xml"/>
     <xi:include href="xml/kolab-mail-mime-builder.xml"/>
-    <xi:include href="xml/kolab-util-ldap.xml"/>
     <xi:include href="xml/kolab-settings-handler.xml"/>
     <xi:include href="xml/kolab-util-backend.xml"/>
     <xi:include href="xml/kolab-mail-handle-friend.xml"/>
-    <xi:include href="xml/kolab-util-cal-freebusy.xml"/>
-    <xi:include href="xml/kolab-util-http.xml"/>
     <xi:include href="xml/kolab-folder-summary.xml"/>
     <xi:include href="xml/kolab-backend-types.xml"/>
     <xi:include href="xml/kolab-mail-summary.xml"/>
-    <xi:include href="xml/kolab-types.xml"/>
-    <xi:include href="xml/kolab-util-types.xml"/>
-    <xi:include href="xml/kolab-util-glib.xml"/>
 
   </chapter>
   <chapter id="object-tree">
diff --git a/docs/reference/libekolabconv/evolution-kolab_libekolabconv-docs.sgml b/docs/reference/libekolabconv/evolution-kolab_libekolabconv-docs.sgml
index ffcbf17..ccca891 100644
--- a/docs/reference/libekolabconv/evolution-kolab_libekolabconv-docs.sgml
+++ b/docs/reference/libekolabconv/evolution-kolab_libekolabconv-docs.sgml
@@ -16,21 +16,7 @@
 
   <chapter>
     <title>[Insert title here]</title>
-        <xi:include href="xml/kolab-conv.xml"/>
-    <xi:include href="xml/note.xml"/>
-    <xi:include href="xml/incidence.xml"/>
-    <xi:include href="xml/task.xml"/>
-    <xi:include href="xml/event.xml"/>
-    <xi:include href="xml/contact.xml"/>
-    <xi:include href="xml/common.xml"/>
-    <xi:include href="xml/e-cal-component-parser.xml"/>
-    <xi:include href="xml/evolution.xml"/>
-    <xi:include href="xml/e-util.xml"/>
-    <xi:include href="xml/e-contact-parser.xml"/>
-    <xi:include href="xml/kolab_constants.xml"/>
-    <xi:include href="xml/kolab.xml"/>
-    <xi:include href="xml/kolab_abstract.xml"/>
-    <xi:include href="xml/kolab_util.xml"/>
+    <xi:include href="xml/kolab-conv.xml"/>
 
   </chapter>
   <chapter id="object-tree">
diff --git a/src/addressbook/kolab-util-contact-cache.c b/src/addressbook/kolab-util-contact-cache.c
index 378eb8d..4e20849 100644
--- a/src/addressbook/kolab-util-contact-cache.c
+++ b/src/addressbook/kolab-util-contact-cache.c
@@ -85,10 +85,12 @@ kolab_util_contact_cache_update_object (EBookBackendCache *cache,
  * kolab_util_contact_cache_assure_uid_on_econtact:
  * @cache: An EBookBackendCache.
  * @koma: A KolabMailAccess instance.
- * @ksettings: The KolabSettingsHandler for @koma.
- * @ecalcomp: An EContact.
+ * @uri: An EContact uri string.
+ * @econtact: An EContact.
+ * @bulk: Whether or not this is a mass operation.
+ * @error: GError placeholder.
  *
- * Sets a new uid to econtact and assures, that it is not used in @koma, so far.
+ * Sets a new uid to econtact and assures that it is not yet used in @koma.
  *
  * Returns: On Success TRUE is returned.
  */
diff --git a/src/calendar/kolab-util-calendar-cache.c b/src/calendar/kolab-util-calendar-cache.c
index 6e3680e..676d0a7 100644
--- a/src/calendar/kolab-util-calendar-cache.c
+++ b/src/calendar/kolab-util-calendar-cache.c
@@ -109,11 +109,13 @@ kolab_util_calendar_cache_get_tz (ECalBackendCache *cache,
 /**
  * kolab_util_calendar_cache_get_object:
  * @cal_cache: An Cache.
- * @kma: A KolabMailAccess object.
+ * @koma: A KolabMailAccess object.
+ * @uri: An ECalComponent uri string.
  * @uid: The uid to search for.
- * @rid: A RECURRENCE-ID or NULL.
+ * @bulk: Whether or not this is a mass operation.
+ * @error: GError placeholder.
  *
- * Retrieves the the object denoted by uid and rid from the given cal_cache. If
+ * Retrieves the the object referenced by @uid from the given @cal_cache. If
  * none is found, NULL is returned.
  *
  * Returns: An ECalComponent containing the object. Unref if no longer needed.
@@ -196,17 +198,14 @@ kolab_util_calendar_cache_update_object (ECalBackendCache *cache,
 /**
  * kolab_util_calendar_cache_remove_instance:
  * @cal_cache: An ECalBackendCache.
- * @kma: An KolabMailAccess object
  * @mod: CalObjModType to apply to the remove request.
+ * @oldcomp: The object before the removal took place.
  * @uid: The UID of the recurring event.
  * @rid: The recurrence ID of the recurrence.
- * @id: An ECalComponentId.
- * @old_object: The object before the removal took place.
- * @object: Returns the object after the removal took place.
  *
  * Removes an instance of an event with recurrence.
  *
- * Returns: Status of the operation as ECalBackendSyncStatus.
+ * Returns: The modified component.
  **/
 ECalComponent * 
 kolab_util_calendar_cache_remove_instance (ECalBackendCache *cal_cache,
@@ -272,8 +271,10 @@ g_debug ("%s()[%u] called.", __func__, __LINE__);
  * kolab_util_calendar_cache_assure_uid_on_ecalcomponent:
  * @cache: An ECalBackendCache.
  * @koma: A KolabMailAccess instance.
- * @ksettings: The KolabSettingsHandler for @koma.
+ * @uri: An ECalComponent uri string.
  * @ecalcomp: An ECalComponent.
+ * @bulk: Whether or not this is a mass operation.
+ * @error: GError placeholder.
  *
  * Sets a new uid to ecalcomp and assures, that it is not used in @koma, so far.
  *
diff --git a/src/calendar/kolab-util-calendar.c b/src/calendar/kolab-util-calendar.c
index 2b8e7b3..575721d 100644
--- a/src/calendar/kolab-util-calendar.c
+++ b/src/calendar/kolab-util-calendar.c
@@ -41,7 +41,7 @@ G_DEFINE_TYPE (KolabUtilCalendar, kolab_util_calendar, G_TYPE_OBJECT)
 /**
  * kolab_util_calendar_extract:
  * @icalcomp: An icalcomponent.
- * @comptype: The component type to process.
+ * @source_type: The data type to process.
  * @ecalcomp: An ECalComponent to return the extracted values to.
  * @tzcomp: An ECaComponent to return contained timezone data.
  *
diff --git a/src/libekolab/kolab-mail-access.c b/src/libekolab/kolab-mail-access.c
index b494e4f..a75b3df 100644
--- a/src/libekolab/kolab-mail-access.c
+++ b/src/libekolab/kolab-mail-access.c
@@ -2321,6 +2321,7 @@ kolab_mail_access_store_handle (KolabMailAccess *self,
  * kolab_mail_access_retrieve_handle:
  * @self: a #KolabMailAccess instance
  * @kmailhandle: the #KolabMailHandle to retrieve PIM data for
+ * @bulk: Whether or not this is a mass operation
  * @err: a #GError object (or NULL)
  *
  * Retrieves the actual PIM data for a #KolabMailHandle. The PIM data is read
@@ -2563,6 +2564,7 @@ kolab_mail_access_delete_handle (KolabMailAccess *self,
  * kolab_mail_access_delete_by_uid:
  * @self: a #KolabMailAccess instance
  * @uid: the UID of the #KolabMailHandle to delete
+ * @sourcename: the name of the source to delete an object from
  * @err: a #GError object (or NULL)
  *
  * Looks up a #KolabMailHandle by it's @uid and deletes the PIM data
diff --git a/src/libekolab/kolab-settings-handler.c b/src/libekolab/kolab-settings-handler.c
index 2c41bbe..ae82470 100644
--- a/src/libekolab/kolab-settings-handler.c
+++ b/src/libekolab/kolab-settings-handler.c
@@ -771,7 +771,6 @@ kolab_settings_handler_create_table (KolabSettingsHandlerTblID tbl_id)
 
 /**
  * kolab_settings_handler_set_value:
- * kolab_settings_handler_get_bool_field:
  * @self: a #KolabSettingsHandler instance
  * @tbl_id: ID for the internal table to store the @value in
  * @key: the key string to reference the value with
@@ -831,7 +830,6 @@ kolab_settings_handler_set_value (KolabSettingsHandler *self,
 
 /**
  * kolab_settings_handler_get_value:
- * kolab_settings_handler_get_bool_field:
  * @self: a #KolabSettingsHandler instance
  * @tbl_id: ID for the internal table to store the @value in
  * @key: the key string to reference the value with
diff --git a/src/libekolab/kolab-util-backend.c b/src/libekolab/kolab-util-backend.c
index fcf68a7..ea1cfb4 100644
--- a/src/libekolab/kolab-util-backend.c
+++ b/src/libekolab/kolab-util-backend.c
@@ -105,7 +105,7 @@ kolab_util_backend_foldername_new_from_sourcename (const gchar *sourcename,
 
 /**
  * kolab_util_backend_get_relative_path_from_uri:
- * %uri: An URI string
+ * @uri: An URI string
  *
  * Extracts the path from the given uri. Leading "/" are removed.
  *
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]