Update API documentation.
authorMatthew Barnes <mbarnes@redhat.com>
Sat, 25 Aug 2012 21:04:04 +0000 (17:04 -0400)
committerMatthew Barnes <mbarnes@redhat.com>
Sat, 25 Aug 2012 23:34:32 +0000 (19:34 -0400)
Make sure all new APIs in 3.6 have "Since: 3.6" tags.

24 files changed:
addressbook/libebook/e-book-types.h
addressbook/libebook/e-vcard.h
addressbook/libedata-book/e-data-book-factory.c
calendar/libecal/e-cal-types.h
calendar/libedata-cal/e-cal-backend-sync.c
calendar/libedata-cal/e-cal-backend.c
calendar/libedata-cal/e-data-cal-factory.c
camel/camel-certdb.c
camel/camel-enums.h
camel/camel-folder-summary.c
camel/camel-service.c
camel/camel-session.c
camel/camel-string-utils.c
camel/camel-vee-data-cache.c
camel/camel-vee-data-cache.h
camel/camel-vee-folder.c
camel/camel-vee-store.c
camel/camel-vee-summary.c
docs/reference/libedataserver/libedataserver-sections.txt
libedataserver/e-source-authenticator.h
libedataserver/e-source-extension.c
libedataserver/e-source-refresh.h
libedataserverui/e-name-selector-dialog.c
libedataserverui/e-name-selector.c

index f98232c..f90c9dd 100644 (file)
@@ -52,6 +52,13 @@ typedef enum {
        E_BOOK_ERROR_NOT_SUPPORTED
 } EBookStatus;
 
+/**
+ * EDataBookStatus:
+ *
+ * XXX Document me!
+ *
+ * Since: 3.6
+ **/
 typedef enum {
        E_DATA_BOOK_STATUS_SUCCESS,
        E_DATA_BOOK_STATUS_BUSY,
index ee03ad1..5f4156c 100644 (file)
@@ -135,6 +135,12 @@ G_BEGIN_DECLS
 #define EVC_X_VIDEO_URL                        "X-EVOLUTION-VIDEO-URL"
 #define EVC_X_WANTS_HTML               "X-MOZILLA-HTML"
 #define EVC_X_YAHOO                    "X-YAHOO"
+
+/**
+ * EVC_X_BOOK_UID:
+ *
+ * Since: 3.6
+ **/
 #define EVC_X_BOOK_UID                 "X-EVOLUTION-BOOK-UID"
 
 /* Constants for Evo contact lists only */
index 1faeb59..f286604 100644 (file)
@@ -671,6 +671,16 @@ e_data_book_factory_new (GCancellable *cancellable,
                cancellable, error, NULL);
 }
 
+/**
+ * e_data_book_factory_get_registry:
+ * @factory: an #EDataBookFactory
+ *
+ * Returns the #ESourceRegistry owned by @factory.
+ *
+ * Returns: the #ESourceRegistry
+ *
+ * Since: 3.6
+ **/
 ESourceRegistry *
 e_data_book_factory_get_registry (EDataBookFactory *factory)
 {
index 8c181ff..3dab5d8 100644 (file)
@@ -44,6 +44,13 @@ typedef enum {
        E_CAL_CHANGE_DELETED = 1 << 2
 } ECalChangeType;
 
+/**
+ * ECalChange:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 typedef struct {
        ECalComponent *comp;
        ECalChangeType type;
@@ -76,6 +83,13 @@ typedef enum {
 #define E_CALENDAR_STATUS_CORBA_EXCEPTION E_CALENDAR_STATUS_DBUS_EXCEPTION
 #endif
 
+/**
+ * EDataCalCallStatus:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 typedef enum {
        Success,
        Busy,
@@ -112,6 +126,13 @@ typedef enum {
        NotOpened
 } EDataCalCallStatus;
 
+/**
+ * EDataCalObjType:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 typedef enum {
        Event = 1 << 0,
        Todo = 1 << 1,
@@ -119,6 +140,13 @@ typedef enum {
        AnyType = 0x07
 } EDataCalObjType;
 
+/**
+ * EDataCalObjModType:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 typedef enum {
        This = 1 << 0,
        ThisAndPrior = 1 << 1,
index f14269e..1a0ad95 100644 (file)
@@ -296,6 +296,8 @@ e_cal_backend_sync_get_free_busy (ECalBackendSync *backend,
  * @error: Out parameter for a #GError.
  *
  * Calls the create_objects_sync method on the given backend.
+ *
+ * Since: 3.6
  */
 void
 e_cal_backend_sync_create_objects (ECalBackendSync *backend,
@@ -326,16 +328,18 @@ e_cal_backend_sync_create_objects (ECalBackendSync *backend,
  * @error: Out parameter for a #GError.
  *
  * Calls the modify_objects_sync method on the given backend.
+ *
+ * Since: 3.6
  */
 void
 e_cal_backend_sync_modify_objects (ECalBackendSync *backend,
-                                                                   EDataCal *cal,
-                                                                   GCancellable *cancellable,
-                                                                   const GSList *calobjs,
-                                                                   CalObjModType mod,
-                                                                   GSList **old_components,
-                                                                   GSList **new_components,
-                                                                   GError **error)
+                                   EDataCal *cal,
+                                   GCancellable *cancellable,
+                                   const GSList *calobjs,
+                                   CalObjModType mod,
+                                   GSList **old_components,
+                                   GSList **new_components,
+                                   GError **error)
 {
        e_return_data_cal_error_if_fail (backend && E_IS_CAL_BACKEND_SYNC (backend), InvalidArg);
        e_return_data_cal_error_if_fail (E_CAL_BACKEND_SYNC_GET_CLASS (backend)->modify_objects_sync != NULL, UnsupportedMethod);
@@ -358,6 +362,8 @@ e_cal_backend_sync_modify_objects (ECalBackendSync *backend,
  * @error: Out parameter for a #GError.
  *
  * Calls the remove_objects_sync method on the given backend.
+ *
+ * Since: 3.6
  */
 void
 e_cal_backend_sync_remove_objects (ECalBackendSync *backend,
index 03b0900..fee91d8 100644 (file)
@@ -1077,6 +1077,8 @@ e_cal_backend_get_free_busy (ECalBackend *backend,
  *
  * Calls the create_object method on the given backend.
  * This might be finished with e_data_cal_respond_create_objects().
+ *
+ * Since: 3.6
  **/
 void
 e_cal_backend_create_objects (ECalBackend *backend,
@@ -1110,6 +1112,8 @@ e_cal_backend_create_objects (ECalBackend *backend,
  *
  * Calls the modify_objects method on the given backend.
  * This might be finished with e_data_cal_respond_modify_objects().
+ *
+ * Since: 3.6
  **/
 void
 e_cal_backend_modify_objects (ECalBackend *backend,
@@ -1145,6 +1149,8 @@ e_cal_backend_modify_objects (ECalBackend *backend,
  * Removes objects in a calendar backend.  The backend will notify all of its
  * clients about the change.
  * This might be finished with e_data_cal_respond_remove_objects().
+ *
+ * Since: 3.6
  **/
 void
 e_cal_backend_remove_objects (ECalBackend *backend,
index 15f1ed4..9899c31 100644 (file)
@@ -566,6 +566,16 @@ e_data_cal_factory_new (GCancellable *cancellable,
                cancellable, error, NULL);
 }
 
+/**
+ * e_data_cal_factory_get_registry:
+ * @factory: an #EDataCalFactory
+ *
+ * Returns the #ESourceRegistry owned by @factory.
+ *
+ * Returns: the #ESourceRegistry
+ *
+ * Since: 3.6
+ **/
 ESourceRegistry *
 e_data_cal_factory_get_registry (EDataCalFactory *factory)
 {
index 128089c..5f19f55 100644 (file)
@@ -442,6 +442,13 @@ camel_certdb_touch (CamelCertDB *certdb)
        certdb->flags |= CAMEL_CERTDB_DIRTY;
 }
 
+/**
+ * camel_certdb_get_host:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 CamelCert *
 camel_certdb_get_host (CamelCertDB *certdb,
                        const gchar *hostname)
@@ -461,6 +468,13 @@ camel_certdb_get_host (CamelCertDB *certdb,
        return cert;
 }
 
+/**
+ * camel_certdb_put:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 void
 camel_certdb_put (CamelCertDB *certdb,
                   CamelCert *cert)
@@ -488,6 +502,13 @@ camel_certdb_put (CamelCertDB *certdb,
        camel_certdb_unlock (certdb, CAMEL_CERTDB_DB_LOCK);
 }
 
+/**
+ * camel_certdb_remove_host:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 void
 camel_certdb_remove_host (CamelCertDB *certdb,
                           const gchar *hostname)
index 1fbb41c..b8e84ca 100644 (file)
@@ -311,6 +311,21 @@ typedef enum {
        CAMEL_SASL_ANON_TRACE_EMPTY
 } CamelSaslAnonTraceType;
 
+/**
+ * CamelServiceConnectionStatus:
+ * @CAMEL_SERVICE_DISCONNECTED:
+ *   #CamelService is disconnected from a remote server.
+ * @CAMEL_SERVICE_CONNECTING:
+ *   #CamelService is connecting to a remote server.
+ * @CAMEL_SERVICE_CONNECTED:
+ *   #CamelService is connected to a remote server.
+ * @CAMEL_SERVICE_DISCONNECTING:
+ *   #CamelService is disconnecting from a remote server.
+ *
+ * Connection status returned by camel_service_get_connection_status().
+ *
+ * Since: 3.6
+ **/
 typedef enum {
        CAMEL_SERVICE_DISCONNECTED,
        CAMEL_SERVICE_CONNECTING,
index d1564d5..56340a5 100644 (file)
@@ -3443,7 +3443,7 @@ camel_folder_summary_remove_uid (CamelFolderSummary *summary,
  *
  * Returns: Whether the @uid was found and removed from the @summary.
  *
- * Since: 3.4.3
+ * Since: 3.6
  **/
 gboolean
 camel_folder_summary_remove_uids (CamelFolderSummary *summary,
index b069c4d..316b688 100644 (file)
@@ -1759,6 +1759,8 @@ camel_service_connect_finish (CamelService *service,
  * they will be cancelled.
  *
  * Returns: %TRUE if the connection was severed or %FALSE otherwise
+ *
+ * Since: 3.6
  **/
 gboolean
 camel_service_disconnect_sync (CamelService *service,
index f713a62..abcf34f 100644 (file)
@@ -1012,6 +1012,8 @@ camel_session_remove_service (CamelSession *session,
  * unreferenced with g_object_unref() when finished with it.
  *
  * Returns: a #CamelService instance, or %NULL
+ *
+ * Since: 3.6
  **/
 CamelService *
 camel_session_ref_service (CamelSession *session,
@@ -1052,7 +1054,7 @@ camel_session_ref_service (CamelSession *session,
  *
  * Returns: a #CamelService instance, or %NULL
  *
- * Since: 3.2
+ * Since: 3.6
  **/
 CamelService *
 camel_session_ref_service_by_url (CamelSession *session,
index 0089fe5..cd92d8a 100644 (file)
@@ -357,6 +357,8 @@ camel_pstring_free (const gchar *string)
  * camel_pstring_dump_stat:
  *
  * Dumps to stdout memory statistic about the string pool.
+ *
+ * Since: 3.6
  **/
 void
 camel_pstring_dump_stat (void)
index 6355e56..72f652a 100644 (file)
@@ -27,8 +27,7 @@
 
 #include "camel-vee-data-cache.h"
 
-struct _CamelVeeSubfolderDataPrivate
-{
+struct _CamelVeeSubfolderDataPrivate {
        CamelFolder *folder;
        const gchar *folder_id; /* stored in string pool */
 };
@@ -111,6 +110,13 @@ vee_subfolder_data_hash_folder (CamelFolder *folder,
        }
 }
 
+/**
+ * camel_vee_subfolder_data_new:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 CamelVeeSubfolderData *
 camel_vee_subfolder_data_new (CamelFolder *folder)
 {
@@ -130,6 +136,13 @@ camel_vee_subfolder_data_new (CamelFolder *folder)
        return data;
 }
 
+/**
+ * camel_vee_subfolder_data_get_folder:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 CamelFolder *
 camel_vee_subfolder_data_get_folder (CamelVeeSubfolderData *data)
 {
@@ -138,6 +151,13 @@ camel_vee_subfolder_data_get_folder (CamelVeeSubfolderData *data)
        return data->priv->folder;
 }
 
+/**
+ * camel_vee_subfolder_data_get_folder_id:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 const gchar *
 camel_vee_subfolder_data_get_folder_id (CamelVeeSubfolderData *data)
 {
@@ -148,8 +168,7 @@ camel_vee_subfolder_data_get_folder_id (CamelVeeSubfolderData *data)
 
 /* ----------------------------------------------------------------------- */
 
-struct _CamelVeeMessageInfoDataPrivate
-{
+struct _CamelVeeMessageInfoDataPrivate {
        CamelVeeSubfolderData *subfolder_data;
        const gchar *orig_message_uid; /* stored in string pool */
        const gchar *vee_message_uid; /* stored in string pool */
@@ -198,6 +217,13 @@ camel_vee_message_info_data_init (CamelVeeMessageInfoData *data)
        data->priv = G_TYPE_INSTANCE_GET_PRIVATE (data, CAMEL_TYPE_VEE_MESSAGE_INFO_DATA, CamelVeeMessageInfoDataPrivate);
 }
 
+/**
+ * camel_vee_message_info_data_new:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 CamelVeeMessageInfoData *
 camel_vee_message_info_data_new (CamelVeeSubfolderData *subfolder_data,
                                  const gchar *orig_message_uid)
@@ -219,6 +245,13 @@ camel_vee_message_info_data_new (CamelVeeSubfolderData *subfolder_data,
        return data;
 }
 
+/**
+ * camel_vee_message_info_data_get_subfolder_data:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 CamelVeeSubfolderData *
 camel_vee_message_info_data_get_subfolder_data (CamelVeeMessageInfoData *data)
 {
@@ -227,6 +260,13 @@ camel_vee_message_info_data_get_subfolder_data (CamelVeeMessageInfoData *data)
        return data->priv->subfolder_data;
 }
 
+/**
+ * camel_vee_message_info_data_get_orig_message_uid:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 const gchar *
 camel_vee_message_info_data_get_orig_message_uid (CamelVeeMessageInfoData *data)
 {
@@ -235,6 +275,13 @@ camel_vee_message_info_data_get_orig_message_uid (CamelVeeMessageInfoData *data)
        return data->priv->orig_message_uid;
 }
 
+/**
+ * camel_vee_message_info_data_get_vee_message_uid:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 const gchar *
 camel_vee_message_info_data_get_vee_message_uid (CamelVeeMessageInfoData *data)
 {
@@ -245,8 +292,7 @@ camel_vee_message_info_data_get_vee_message_uid (CamelVeeMessageInfoData *data)
 
 /* ----------------------------------------------------------------------- */
 
-struct _CamelVeeDataCachePrivate
-{
+struct _CamelVeeDataCachePrivate {
        GMutex *sf_mutex; /* guards subfolder_hash */
        GHashTable *subfolder_hash; /* CamelFolder * => CamelVeeSubfolderData * */
 
@@ -257,8 +303,7 @@ struct _CamelVeeDataCachePrivate
 
 G_DEFINE_TYPE (CamelVeeDataCache, camel_vee_data_cache, G_TYPE_OBJECT)
 
-typedef struct _VeeData
-{
+typedef struct _VeeData {
        CamelFolder *folder;
        const gchar *orig_message_uid;
 } VeeData;
@@ -346,12 +391,26 @@ camel_vee_data_cache_init (CamelVeeDataCache *data_cache)
        data_cache->priv->vee_message_uid_hash = g_hash_table_new_full (g_direct_hash, g_direct_equal, NULL, NULL);
 }
 
+/**
+ * camel_vee_data_cache_new:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 CamelVeeDataCache *
 camel_vee_data_cache_new (void)
 {
        return g_object_new (CAMEL_TYPE_VEE_DATA_CACHE, NULL);
 }
 
+/**
+ * camel_vee_data_cache_add_subfolder:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 void
 camel_vee_data_cache_add_subfolder (CamelVeeDataCache *data_cache,
                                     CamelFolder *subfolder)
@@ -440,6 +499,13 @@ remove_orig_by_folder_cb (gpointer key,
        return vee_data && vee_data->folder == folder;
 }
 
+/**
+ * camel_vee_data_cache_remove_subfolder:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 void
 camel_vee_data_cache_remove_subfolder (CamelVeeDataCache *data_cache,
                                        CamelFolder *subfolder)
@@ -458,6 +524,13 @@ camel_vee_data_cache_remove_subfolder (CamelVeeDataCache *data_cache,
        g_mutex_unlock (data_cache->priv->mi_mutex);
 }
 
+/**
+ * camel_vee_data_cache_get_subfolder_data:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 CamelVeeSubfolderData *
 camel_vee_data_cache_get_subfolder_data (CamelVeeDataCache *data_cache,
                                          CamelFolder *folder)
@@ -482,11 +555,16 @@ camel_vee_data_cache_get_subfolder_data (CamelVeeDataCache *data_cache,
        return res;
 }
 
-/* Returns whether data_cache contains certain UID for certain folder;
+/**
+ * camel_vee_data_cache_contains_message_info_data:
+ *
+ * Returns whether data_cache contains certain UID for certain folder;
  * instead of camel_vee_data_cache_get_message_info_data() only
  * returns FALSE if not, while camel_vee_data_cache_get_message_info_data()
  * auto-adds it to data_cache.
-*/
+ *
+ * Since: 3.6
+ */
 gboolean
 camel_vee_data_cache_contains_message_info_data (CamelVeeDataCache *data_cache,
                                                  CamelFolder *folder,
@@ -514,6 +592,13 @@ camel_vee_data_cache_contains_message_info_data (CamelVeeDataCache *data_cache,
        return res;
 }
 
+/**
+ * camel_vee_data_cache_get_message_info_data:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 CamelVeeMessageInfoData *
 camel_vee_data_cache_get_message_info_data (CamelVeeDataCache *data_cache,
                                             CamelFolder *folder,
@@ -568,6 +653,13 @@ camel_vee_data_cache_get_message_info_data (CamelVeeDataCache *data_cache,
        return res;
 }
 
+/**
+ * camel_vee_data_cache_get_message_info_data_by_vuid:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 CamelVeeMessageInfoData *
 camel_vee_data_cache_get_message_info_data_by_vuid (CamelVeeDataCache *data_cache,
                                                     const gchar *vee_message_uid)
@@ -594,8 +686,7 @@ camel_vee_data_cache_get_message_info_data_by_vuid (CamelVeeDataCache *data_cach
        return res;
 }
 
-struct ForeachMiData
-{
+struct ForeachMiData {
        CamelFolder *fromfolder;
        void (* func) (CamelVeeMessageInfoData *mi_data,
                        CamelFolder *subfolder,
@@ -620,6 +711,13 @@ cvdc_foreach_mi_data_cb (gpointer key,
                fmd->func (mi_data, vdata->folder, fmd->user_data);
 }
 
+/**
+ * camel_vee_data_cache_foreach_message_info_data:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 void
 camel_vee_data_cache_foreach_message_info_data (CamelVeeDataCache *data_cache,
                                                 CamelFolder *fromfolder,
@@ -644,6 +742,13 @@ camel_vee_data_cache_foreach_message_info_data (CamelVeeDataCache *data_cache,
        g_mutex_unlock (data_cache->priv->mi_mutex);
 }
 
+/**
+ * camel_vee_data_cache_remove_message_info_data:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 void
 camel_vee_data_cache_remove_message_info_data (CamelVeeDataCache *data_cache,
                                                CamelVeeMessageInfoData *mi_data)
index ce03304..4174a00 100644 (file)
@@ -97,6 +97,11 @@ typedef struct _CamelVeeDataCache CamelVeeDataCache;
 typedef struct _CamelVeeDataCacheClass CamelVeeDataCacheClass;
 typedef struct _CamelVeeDataCachePrivate CamelVeeDataCachePrivate;
 
+/**
+ * CamelVeeSubfolderData:
+ *
+ * Since: 3.6
+ **/
 struct _CamelVeeSubfolderData {
        GObject parent;
        CamelVeeSubfolderDataPrivate *priv;
@@ -117,6 +122,11 @@ const gchar *      camel_vee_subfolder_data_get_folder_id
 
 /* ----------------------------------------------------------------------- */
 
+/**
+ * CamelVeeMessageInfoData:
+ *
+ * Since: 3.6
+ **/
 struct _CamelVeeMessageInfoData {
        GObject parent;
        CamelVeeMessageInfoDataPrivate *priv;
@@ -142,6 +152,11 @@ const gchar *      camel_vee_message_info_data_get_vee_message_uid
 
 /* ----------------------------------------------------------------------- */
 
+/**
+ * CamelVeeDataCache:
+ *
+ * Since: 3.6
+ **/
 struct _CamelVeeDataCache {
        GObject parent;
        CamelVeeDataCachePrivate *priv;
index ad1b766..461d689 100644 (file)
@@ -1293,6 +1293,13 @@ camel_vee_folder_set_expression (CamelVeeFolder *vfolder,
        CAMEL_VEE_FOLDER_GET_CLASS (vfolder)->set_expression (vfolder, expr);
 }
 
+/**
+ * camel_vee_folder_get_expression:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 const gchar *
 camel_vee_folder_get_expression (CamelVeeFolder *vfolder)
 {
@@ -1457,6 +1464,13 @@ camel_vee_folder_set_folders (CamelVeeFolder *vf,
        camel_folder_thaw (CAMEL_FOLDER (vf));
 }
 
+/**
+ * camel_vee_folder_add_vuid:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 void
 camel_vee_folder_add_vuid (CamelVeeFolder *vfolder,
                            CamelVeeMessageInfoData *mi_data,
@@ -1500,6 +1514,13 @@ camel_vee_folder_add_vuid (CamelVeeFolder *vfolder,
        vee_folder_note_added_uid (vfolder, vsummary, mi_data, changes, FALSE);
 }
 
+/**
+ * camel_vee_folder_remove_vuid:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 void
 camel_vee_folder_remove_vuid (CamelVeeFolder *vfolder,
                               CamelVeeMessageInfoData *mi_data,
@@ -1586,6 +1607,13 @@ camel_vee_folder_get_location (CamelVeeFolder *vf,
        }
 }
 
+/**
+ * camel_vee_folder_get_vee_uid_folder:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 CamelFolder *
 camel_vee_folder_get_vee_uid_folder (CamelVeeFolder *vf,
                                      const gchar *vee_message_uid)
@@ -1613,6 +1641,13 @@ camel_vee_folder_get_vee_uid_folder (CamelVeeFolder *vf,
        return res;
 }
 
+/**
+ * camel_vee_folder_set_auto_update:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 void
 camel_vee_folder_set_auto_update (CamelVeeFolder *vfolder,
                                   gboolean auto_update)
@@ -1627,6 +1662,13 @@ camel_vee_folder_set_auto_update (CamelVeeFolder *vfolder,
        g_object_notify (G_OBJECT (vfolder), "auto-update");
 }
 
+/**
+ * camel_vee_folder_get_auto_update:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 gboolean
 camel_vee_folder_get_auto_update (CamelVeeFolder *vfolder)
 {
index 87228ff..ff9ea68 100644 (file)
@@ -560,6 +560,13 @@ camel_vee_store_new (void)
        return g_object_new (CAMEL_TYPE_VEE_STORE, NULL);
 }
 
+/**
+ * camel_vee_store_get_vee_data_cache:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 CamelVeeDataCache *
 camel_vee_store_get_vee_data_cache (CamelVeeStore *vstore)
 {
@@ -568,6 +575,13 @@ camel_vee_store_get_vee_data_cache (CamelVeeStore *vstore)
        return vstore->priv->vee_data_cache;
 }
 
+/**
+ * camel_vee_store_get_unmatched_folder:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 CamelVeeFolder *
 camel_vee_store_get_unmatched_folder (CamelVeeStore *vstore)
 {
@@ -579,6 +593,13 @@ camel_vee_store_get_unmatched_folder (CamelVeeStore *vstore)
        return vstore->priv->unmatched_folder;
 }
 
+/**
+ * camel_vee_store_get_unmatched_enabled:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 gboolean
 camel_vee_store_get_unmatched_enabled (CamelVeeStore *vstore)
 {
@@ -587,6 +608,13 @@ camel_vee_store_get_unmatched_enabled (CamelVeeStore *vstore)
        return vstore->priv->unmatched_enabled;
 }
 
+/**
+ * camel_vee_store_set_unmatched_enabled:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 void
 camel_vee_store_set_unmatched_enabled (CamelVeeStore *vstore,
                                        gboolean is_enabled)
@@ -613,8 +641,7 @@ camel_vee_store_set_unmatched_enabled (CamelVeeStore *vstore,
        camel_folder_info_free (fi_unmatched);
 }
 
-struct AddToUnmatchedData
-{
+struct AddToUnmatchedData {
        CamelVeeFolder *unmatched_folder;
        CamelFolderChangeInfo *changes;
        gboolean unmatched_enabled;
@@ -639,6 +666,13 @@ add_to_unmatched_folder_cb (CamelVeeMessageInfoData *mi_data,
                camel_vee_folder_add_vuid (atud->unmatched_folder, mi_data, atud->changes);
 }
 
+/**
+ * camel_vee_store_note_subfolder_used:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 void
 camel_vee_store_note_subfolder_used (CamelVeeStore *vstore,
                                      CamelFolder *subfolder,
@@ -709,6 +743,13 @@ remove_vuid_count_record_cb (CamelVeeMessageInfoData *mi_data,
        g_hash_table_remove (vuid_usage_counts, camel_vee_message_info_data_get_vee_message_uid (mi_data));
 }
 
+/**
+ * camel_vee_store_note_subfolder_unused:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 void
 camel_vee_store_note_subfolder_unused (CamelVeeStore *vstore,
                                        CamelFolder *subfolder,
@@ -749,6 +790,13 @@ camel_vee_store_note_subfolder_unused (CamelVeeStore *vstore,
        g_mutex_unlock (vstore->priv->sf_counts_mutex);
 }
 
+/**
+ * camel_vee_store_note_vuid_used:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 void
 camel_vee_store_note_vuid_used (CamelVeeStore *vstore,
                                 CamelVeeMessageInfoData *mi_data,
@@ -797,6 +845,13 @@ camel_vee_store_note_vuid_used (CamelVeeStore *vstore,
        g_mutex_unlock (vstore->priv->vu_counts_mutex);
 }
 
+/**
+ * camel_vee_store_note_vuid_unused:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 void
 camel_vee_store_note_vuid_unused (CamelVeeStore *vstore,
                                   CamelVeeMessageInfoData *mi_data,
@@ -851,8 +906,7 @@ camel_vee_store_note_vuid_unused (CamelVeeStore *vstore,
        g_mutex_unlock (vstore->priv->vu_counts_mutex);
 }
 
-struct RebuildUnmatchedData
-{
+struct RebuildUnmatchedData {
        CamelVeeDataCache *data_cache;
        CamelVeeFolder *unmatched_folder;
        CamelFolderChangeInfo *changes;
@@ -932,6 +986,13 @@ vee_store_rebuild_unmatched_folder (CamelSession *session,
        g_cancellable_set_error_if_cancelled (cancellable, error);
 }
 
+/**
+ * camel_vee_store_rebuild_unmatched_folder:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 void
 camel_vee_store_rebuild_unmatched_folder (CamelVeeStore *vstore,
                                           GCancellable *cancellable,
index ea00a6d..c003b57 100644 (file)
@@ -398,6 +398,13 @@ get_uids_for_subfolder (gpointer key,
        g_hash_table_insert (user_data, (gpointer) camel_pstring_strdup (key), GINT_TO_POINTER (1));
 }
 
+/**
+ * camel_vee_summary_get_uids_for_subfolder:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 GHashTable *
 camel_vee_summary_get_uids_for_subfolder (CamelVeeSummary *summary,
                                           CamelFolder *subfolder)
@@ -484,6 +491,13 @@ camel_vee_summary_add (CamelVeeSummary *s,
        return vmi;
 }
 
+/**
+ * camel_vee_summary_remove:
+ *
+ * FIXME Document me!
+ *
+ * Since: 3.6
+ **/
 void
 camel_vee_summary_remove (CamelVeeSummary *summary,
                           const gchar *vuid,
@@ -527,6 +541,8 @@ camel_vee_summary_remove (CamelVeeSummary *summary,
  * Makes sure @summary flags on @uid corresponds to those 
  * in the subfolder of vee-folder, and updates internal counts
  * on @summary as well.
+ *
+ * Since: 3.6
  **/
 void
 camel_vee_summary_replace_flags (CamelVeeSummary *summary,
index 62b69da..a7af852 100644 (file)
@@ -488,6 +488,25 @@ e_source_collection_get_type
 </SECTION>
 
 <SECTION>
+<FILE>e-source-extension</FILE>
+<TITLE>ESourceExtension</TITLE>
+ESourceExtension
+E_SOURCE_PARAM_SETTING
+e_source_extension_get_source
+<SUBSECTION Standard>
+E_SOURCE_EXTENSION
+E_IS_SOURCE_EXTENSION
+E_TYPE_SOURCE_EXTENSION
+E_SOURCE_EXTENSION_CLASS
+E_IS_SOURCE_EXTENSION_CLASS
+E_SOURCE_EXTENSION_GET_CLASS
+ESourceExtensionClass
+<SUBSECTION Private>
+ESourceExtensionPrivate
+e_source_extension_get_type
+</SECTION>
+
+<SECTION>
 <FILE>e-source-goa</FILE>
 <TITLE>ESourceGoa</TITLE>
 ESourceGoa
@@ -509,25 +528,6 @@ e_source_goa_get_type
 </SECTION>
 
 <SECTION>
-<FILE>e-source-extension</FILE>
-<TITLE>ESourceExtension</TITLE>
-ESourceExtension
-E_SOURCE_PARAM_SETTING
-e_source_extension_get_source
-<SUBSECTION Standard>
-E_SOURCE_EXTENSION
-E_IS_SOURCE_EXTENSION
-E_TYPE_SOURCE_EXTENSION
-E_SOURCE_EXTENSION_CLASS
-E_IS_SOURCE_EXTENSION_CLASS
-E_SOURCE_EXTENSION_GET_CLASS
-ESourceExtensionClass
-<SUBSECTION Private>
-ESourceExtensionPrivate
-e_source_extension_get_type
-</SECTION>
-
-<SECTION>
 <FILE>e-source-mail-account</FILE>
 <TITLE>ESourceMailAccount</TITLE>
 ESourceMailAccount
index e9c0b7f..a380599 100644 (file)
@@ -49,6 +49,11 @@ G_BEGIN_DECLS
 typedef struct _ESourceAuthenticator ESourceAuthenticator;
 typedef struct _ESourceAuthenticatorInterface ESourceAuthenticatorInterface;
 
+/**
+ * ESourceAuthenticatorInterface:
+ *
+ * Since: 3.6
+ **/
 struct _ESourceAuthenticatorInterface {
        GTypeInterface parent_interface;
 
index 1a42e83..b13d0d1 100644 (file)
@@ -167,6 +167,8 @@ e_source_extension_init (ESourceExtension *extension)
  * Returns the #ESource instance to which @extension belongs.
  *
  * Returns: (transfer none): the #ESource instance
+ *
+ * Since: 3.6
  **/
 ESource *
 e_source_extension_get_source (ESourceExtension *extension)
index 1856176..019002e 100644 (file)
@@ -77,6 +77,11 @@ struct _ESourceRefreshClass {
        ESourceExtensionClass parent_class;
 };
 
+/**
+ * ESourceRefreshFunc:
+ *
+ * Since: 3.6
+ **/
 typedef void   (*ESourceRefreshFunc)           (ESource *source,
                                                 gpointer user_data);
 
index 308ce20..b079134 100644 (file)
@@ -600,6 +600,17 @@ e_name_selector_dialog_new (ESourceRegistry *registry)
                "registry", registry, NULL);
 }
 
+/**
+ * e_name_selector_dialog_get_registry:
+ * @name_selector_dialog: an #ENameSelectorDialog
+ *
+ * Returns the #ESourceRegistry that was passed to
+ * e_name_selector_dialog_new().
+ *
+ * Returns: the #ESourceRegistry
+ *
+ * Since: 3.6
+ **/
 ESourceRegistry *
 e_name_selector_dialog_get_registry (ENameSelectorDialog *name_selector_dialog)
 {
index effd8fe..87f7f8f 100644 (file)
@@ -375,6 +375,16 @@ e_name_selector_new (ESourceRegistry *registry)
                "registry", registry, NULL);
 }
 
+/**
+ * e_name_selector_get_registry:
+ * @name_selector: an #ENameSelector
+ *
+ * Returns the #ESourceRegistry passed to e_name_selector_new().
+ *
+ * Returns: the #ESourceRegistry
+ *
+ * Since: 3.6
+ **/
 ESourceRegistry *
 e_name_selector_get_registry (ENameSelector *name_selector)
 {