[gom] gom: API documentation improvements



commit c22bdd710b058e2bfba196985d88495a3ab7e90c
Author: Bastien Nocera <hadess hadess net>
Date:   Tue Jun 10 14:45:00 2014 +0200

    gom: API documentation improvements

 gom/gom-adapter.c         |    5 +++--
 gom/gom-command-builder.c |    6 ++++--
 gom/gom-repository.c      |    5 +++--
 3 files changed, 10 insertions(+), 6 deletions(-)
---
diff --git a/gom/gom-adapter.c b/gom/gom-adapter.c
index 8d7ed61..e8201bb 100644
--- a/gom/gom-adapter.c
+++ b/gom/gom-adapter.c
@@ -439,8 +439,9 @@ gom_adapter_close_finish (GomAdapter    *adapter,
 
 /**
  * gom_adapter_execute_sql:
- * @adapter: (in): A #GomAdapter.
- * @sql: (in): SQL to execute.
+ * @adapter: A #GomAdapter.
+ * @sql: SQL to execute.
+ * @error: a #GError
  *
  * This is a helper function to make simple execution of SQL easier.
  * It is primarily meant for things like "BEGIN;" and "COMMIT;".
diff --git a/gom/gom-command-builder.c b/gom/gom-command-builder.c
index 99e9552..7c839a2 100644
--- a/gom/gom-command-builder.c
+++ b/gom/gom-command-builder.c
@@ -659,7 +659,8 @@ resource_get_property(GObject     *object,
 
 /**
  * gom_command_builder_build_insert:
- * @builder: (in): A #GomCommandBuilder.
+ * @builder: A #GomCommandBuilder.
+ * @resource: a #GomResource
  *
  * Builds a new #GomCommand that will insert the parameters of the resource
  * into the underlying database.
@@ -764,7 +765,8 @@ gom_command_builder_build_insert (GomCommandBuilder *builder,
 
 /**
  * gom_command_builder_build_update:
- * @builder: (in): A #GomCommandBuilder.
+ * @builder: A #GomCommandBuilder.
+ * @resource: a #GomResource
  *
  * Builds a new #GomCommand that will update the contents stored for @resource
  * in the underlying database.
diff --git a/gom/gom-repository.c b/gom/gom-repository.c
index 5fdaeba..f7759af 100644
--- a/gom/gom-repository.c
+++ b/gom/gom-repository.c
@@ -226,7 +226,7 @@ out:
  * @version: (in): The version to migrate to.
  * @migrator: (in) (scope call): A function to perform the migrations.
  * @migrator_data: (in): User data for @migrator.
- * @error:
+ * @error: a #GError
  *
  * Performs a migration on the underlying database. This will
  * call @migrator from the SQLite thread for each migration to perform.
@@ -280,6 +280,7 @@ gom_repository_migrate_sync (GomRepository          *repository,
  * @repository: (in): A #GomRepository.
  * @version: (in): The version to migrate to.
  * @migrator: (in) (scope async): A function to perform the migrations.
+ * @migrator_data: (in): User data for @migrator
  * @callback: (in): A callback to execute upon completion.
  * @user_data: (in): User data for @callback.
  *
@@ -382,7 +383,7 @@ bail_object:
  * @repository: (in): A #GomRepository.
  * @version: (in): The version to migrate to.
  * @object_types: (element-type GType) (transfer container): a #GList of #GType
- * @error:
+ * @error: a #GError
  *
  * Performs an automatic migration on the underlying database. For
  * each of the #GType passed in @object_types, the table will be


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