GNOME.org
 

[libgit2-glib] Unify documentation of error

commit 38bb76a270e19e52d8180ff22cd4b1512867f29d
Author: Jesse van den Kieboom <jessevdk gmail com>
Date:   Sat Jun 29 13:53:39 2013 +0200

    Unify documentation of error

 libgit2-glib/ggit-config.c       |   24 ++++++++++++------------
 libgit2-glib/ggit-index-entry.c  |    2 +-
 libgit2-glib/ggit-index.c        |   16 ++++++++--------
 libgit2-glib/ggit-repository.c   |   26 +++++++++++++-------------
 libgit2-glib/ggit-tree-builder.c |    4 ++--
 5 files changed, 36 insertions(+), 36 deletions(-)
---
diff --git a/libgit2-glib/ggit-config.c b/libgit2-glib/ggit-config.c
index b6e9422..bce9070 100644
--- a/libgit2-glib/ggit-config.c
+++ b/libgit2-glib/ggit-config.c
@@ -296,7 +296,7 @@ ggit_config_refresh (GgitConfig  *config,
  * ggit_config_get_int32:
  * @config: a #GgitConfig.
  * @name: the name of the configuration value.
- * @error: A #GError
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Get a int32 configuration value.
  *
@@ -331,7 +331,7 @@ ggit_config_get_int32 (GgitConfig   *config,
  * @config: a #GgitConfig.
  * @name: the name of the configuration value
  * @value: the new value
- * @error: A #GError
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Set a int32 value.
  *
@@ -365,7 +365,7 @@ ggit_config_set_int32 (GgitConfig   *config,
  * ggit_config_get_int64:
  * @config: a #GgitConfig.
  * @name: the name of the configuration value.
- * @error: A #GError
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Get a int64 configuration value.
  *
@@ -400,7 +400,7 @@ ggit_config_get_int64 (GgitConfig   *config,
  * @config: a #GgitConfig.
  * @name: the name of the configuration value
  * @value: the new value
- * @error: A #GError
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Set a int64 value.
  *
@@ -434,7 +434,7 @@ ggit_config_set_int64 (GgitConfig   *config,
  * ggit_config_get_bool:
  * @config: a #GgitConfig.
  * @name: the name of the configuration value.
- * @error: A #GError
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Get a boolean configuration value.
  *
@@ -469,7 +469,7 @@ ggit_config_get_bool (GgitConfig   *config,
  * @config: a #GgitConfig.
  * @name: the name of the configuration value
  * @value: the new value
- * @error: A #GError
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Set a boolean value.
  *
@@ -503,7 +503,7 @@ ggit_config_set_bool (GgitConfig   *config,
  * ggit_config_get_string:
  * @config: a #GgitConfig.
  * @name: the name of the configuration value.
- * @error: a #GError
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Get the configuration value of @name as string.
  *
@@ -539,7 +539,7 @@ ggit_config_get_string (GgitConfig   *config,
  * @config: a #GgitConfig.
  * @name: the name of the configuration value.
  * @value: the new value
- * @error: A #GError
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Set a new string value of a configuration.
  *
@@ -581,7 +581,7 @@ ggit_config_set_string (GgitConfig   *config,
  * ggit_config_delete_entry:
  * @config: a #GgitConfig.
  * @name: the configuration value.
- * @error: A #GError
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Delete a config variable from the config file.
  *
@@ -635,7 +635,7 @@ callback_wrapper (const git_config_entry *config_entry,
  * @config: a #GgitConfig.
  * @callback: (scope call): a #GgitConfigCallback.
  * @user_data: (allow-none): the user data for @callback
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Call @callback for each configuration value.
  *
@@ -713,7 +713,7 @@ match_foreach (const gchar *name,
  * @config: a #GgitConfig.
  * @regex: a #GRegex.
  * @match_info: (out) (allow-none): a #GMatchInfo.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Matches a configuration against a regular expression. @match_info will
  * contain the match information if the return value is not %NULL, otherwise
@@ -764,7 +764,7 @@ ggit_config_match (GgitConfig  *config,
  * @regex: a #GRegex.
  * @callback: (scope call) (closure user_data): a #GgitConfigMatchCallback.
  * @user_data: (closure): the user data for @callback
- * @error: a #GError
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Call @callback for all configurations matching @regex.
  *
diff --git a/libgit2-glib/ggit-index-entry.c b/libgit2-glib/ggit-index-entry.c
index 53ad1cc..1c20fe3 100644
--- a/libgit2-glib/ggit-index-entry.c
+++ b/libgit2-glib/ggit-index-entry.c
@@ -650,7 +650,7 @@ ggit_index_entry_set_path (GgitIndexEntry *entry,
  * ggit_index_entry_stat:
  * @entry: a #GgitIndexEntry.
  * @file: the file to stat.
- * @error: a #GError
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Fill the entry fields from statting @file.
  *
diff --git a/libgit2-glib/ggit-index.c b/libgit2-glib/ggit-index.c
index 9112e92..185a549 100644
--- a/libgit2-glib/ggit-index.c
+++ b/libgit2-glib/ggit-index.c
@@ -213,7 +213,7 @@ _ggit_index_get_index (GgitIndex *idx)
 /**
  * ggit_index_open:
  * @file: a #GFile.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Create a new bare Git index object as a memory representation of the Git
  * index file in @file, without a repository to back it.
@@ -236,7 +236,7 @@ ggit_index_open (GFile   *file,
 /**
  * ggit_index_read:
  * @idx: a #GgitIndex.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Update the contents of an existing index object in memory by reading from
  * the hard disk.
@@ -268,7 +268,7 @@ ggit_index_read (GgitIndex  *idx,
 /**
  * ggit_index_write:
  * @idx: a #GgitIndex.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Write an existing index object from memory back to disk using an atomic file
  * lock.
@@ -301,7 +301,7 @@ ggit_index_write (GgitIndex  *idx,
  * @idx: a #GgitIndex.
  * @file: the file to search.
  * @stage: the stage to search.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Remove a file from the index (specified by position).
  *
@@ -342,7 +342,7 @@ ggit_index_remove (GgitIndex  *idx,
  * ggit_index_add:
  * @idx: a #GgitIndex.
  * @entry: a #GgitIndexEntry
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Add a file to the index.
  *
@@ -410,7 +410,7 @@ ggit_index_get_entries_resolve_undo (GgitIndex *idx)
  * ggit_index_add_file:
  * @idx: a #GgitIndex.
  * @file: file to add.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Add a file to the index. The specified file must be in the working directory
  * and must exist and be readable.
@@ -459,7 +459,7 @@ ggit_index_add_file (GgitIndex  *idx,
  * ggit_index_add_path:
  * @idx: a #GgitIndex.
  * @path: path to the file to add.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Add a file to the index by path. You can specify both relative paths
  * (to the working directory) and absolute paths. Absolute paths however must
@@ -529,7 +529,7 @@ ggit_index_get_owner (GgitIndex *idx)
 /**
  * ggit_index_write_tree:
  * @idx: a #GgitIndex.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Write a new tree object to disk containing a representation of the current
  * state of the index. The index must be associated to an existing repository
diff --git a/libgit2-glib/ggit-repository.c b/libgit2-glib/ggit-repository.c
index 7f62131..2abe571 100644
--- a/libgit2-glib/ggit-repository.c
+++ b/libgit2-glib/ggit-repository.c
@@ -1094,7 +1094,7 @@ ggit_repository_references_foreach_name (GgitRepository             *repository,
 /**
  * ggit_repository_get_config:
  * @repository: a #GgitRepository
- * @error: a #GError
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Get the config for a specific repository.
  *
@@ -1126,7 +1126,7 @@ ggit_repository_get_config (GgitRepository  *repository,
 /**
  * ggit_repository_get_index:
  * @repository: a #GgitRepository.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Get the index for a specific repository.
  *
@@ -1163,7 +1163,7 @@ ggit_repository_get_index (GgitRepository  *repository,
  * @tagger: a #GgitSignature.
  * @message: the tag message.
  * @flags: a #GgitCreateFlags.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Create a new tag object.
  *
@@ -1215,7 +1215,7 @@ ggit_repository_create_tag (GgitRepository   *repository,
  * @repository: a #GgitRepository.
  * @tag: the tag buffer.
  * @flags: a #GgitCreateFlags.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Create a new tag from a buffer describing the tag object. The buffer must
  * be correctly formatted.
@@ -1260,7 +1260,7 @@ ggit_repository_create_tag_from_buffer (GgitRepository   *repository,
  * @tag_name: the name of the tag.
  * @target: a #GgitObject.
  * @flags: a #GgitCreateFlags.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Creates a new lightweight tag.
  *
@@ -1304,7 +1304,7 @@ ggit_repository_create_tag_lightweight (GgitRepository   *repository,
 /**
  * ggit_repository_list_tags:
  * @repository: a #GgitRepository.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Fill a list with all the tags in the @repository.
  *
@@ -1343,7 +1343,7 @@ ggit_repository_list_tags (GgitRepository  *repository,
  * @branch_name: the name of the branch.
  * @target: a #GgitObject.
  * @flags: a #GgitCreateFlags.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Creates a new branch pointing at a target commit.
  *
@@ -1393,7 +1393,7 @@ typedef gint (* _GitBranchesCallback) (const gchar  *branch_name,
  * @branch_type: a GgitBranchType.
  * @callback: (scope call): a #GgitBranchesCallback.
  * @user_data: callback user data.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Foreach branch of type @branch_type the callback @callback is called.
  **/
@@ -1463,7 +1463,7 @@ ggit_repository_lookup_branch (GgitRepository *repository,
  * ggit_repository_get_remote:
  * @repository: a #GgitRepository.
  * @name: the remote's name.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Gets the remote called @name.
  *
@@ -1499,7 +1499,7 @@ ggit_repository_get_remote (GgitRepository  *repository,
  * @repository: a #GgitRepository.
  * @name: the name of the new remote.
  * @url: the url of the remote.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Adds a remote with the default fetch refspec to the repository's configuration.
  *
@@ -1535,7 +1535,7 @@ ggit_repository_create_remote (GgitRepository  *repository,
 /**
  * ggit_repository_list_remotes:
  * @repository: a #GgitRepository.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Fill a list with all the remotes in @repository.
  *
@@ -1572,7 +1572,7 @@ ggit_repository_list_remotes (GgitRepository  *repository,
  * ggit_repository_lookup_submodule:
  * @repository: a #GgitRepository.
  * @name: the name of the submodule.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Lookups a submodule information by name or path. If the submodule
  * does not exist, %NULL is returned and a GGIT_ERROR_NOTFOUND error set.
@@ -2018,7 +2018,7 @@ ggit_repository_create_blob_from_path (GgitRepository  *repository,
  * @tree: the tree of objects to commit.
  * @parents: (array length=parent_count): parent commits.
  * @parent_count: number of parent commits in @parents.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Create a new commit. If @update_ref is not %NULL, the given reference will
  * be updated to point to the newly created commit. Use "HEAD" to update the
diff --git a/libgit2-glib/ggit-tree-builder.c b/libgit2-glib/ggit-tree-builder.c
index fc461dc..bf7f6c5 100644
--- a/libgit2-glib/ggit-tree-builder.c
+++ b/libgit2-glib/ggit-tree-builder.c
@@ -171,7 +171,7 @@ ggit_tree_builder_clear (GgitTreeBuilder *builder)
 /**
  * ggit_tree_builder_write:
  * @builder: a #GgitTreeBuilder.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Write the contents of the tree builder as a tree object.
  *
@@ -207,7 +207,7 @@ ggit_tree_builder_write (GgitTreeBuilder  *builder,
  * @filename: the file name.
  * @oid: the #GgitOId of the file blob to insert.
  * @file_mode: a #GgitFileMode.
- * @error: a #GError.
+ * @error: a #GError for error reporting, or %NULL.
  *
  * Insert a file with a given blob in the tree builder. If the tree builder
  * already contains an entry for the given file, then this entry will be
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]