[libgit2-glib] Added missing punctuation for documentation of parameters



commit 67cf568389adfe15cc104eefad3a50d7d7854e49
Author: Jesse van den Kieboom <jessevdk gmail com>
Date:   Sat Jun 29 13:58:54 2013 +0200

    Added missing punctuation for documentation of parameters

 libgit2-glib/ggit-config.c                   |   20 ++++++++++----------
 libgit2-glib/ggit-index-entry-resolve-undo.c |    4 ++--
 libgit2-glib/ggit-index.c                    |    2 +-
 libgit2-glib/ggit-oid.c                      |    6 +++---
 libgit2-glib/ggit-repository.c               |    8 ++++----
 libgit2-glib/ggit-submodule.c                |    2 +-
 libgit2-glib/ggit-tree.c                     |    4 ++--
 7 files changed, 23 insertions(+), 23 deletions(-)
---
diff --git a/libgit2-glib/ggit-config.c b/libgit2-glib/ggit-config.c
index bce9070..c934bc7 100644
--- a/libgit2-glib/ggit-config.c
+++ b/libgit2-glib/ggit-config.c
@@ -91,7 +91,7 @@ ggit_config_new (void)
 
 /**
  * ggit_config_new_from_file:
- * @file: the file to load
+ * @file: the file to load.
  * @error: a #GError for error reporting, or %NULL.
  *
  * Create a new config from a single on disk file. This is a convenience
@@ -329,8 +329,8 @@ ggit_config_get_int32 (GgitConfig   *config,
 /**
  * ggit_config_set_int32:
  * @config: a #GgitConfig.
- * @name: the name of the configuration value
- * @value: the new value
+ * @name: the name of the configuration value.
+ * @value: the new value.
  * @error: a #GError for error reporting, or %NULL.
  *
  * Set a int32 value.
@@ -398,8 +398,8 @@ ggit_config_get_int64 (GgitConfig   *config,
 /**
  * ggit_config_set_int64:
  * @config: a #GgitConfig.
- * @name: the name of the configuration value
- * @value: the new value
+ * @name: the name of the configuration value.
+ * @value: the new value.
  * @error: a #GError for error reporting, or %NULL.
  *
  * Set a int64 value.
@@ -467,8 +467,8 @@ ggit_config_get_bool (GgitConfig   *config,
 /**
  * ggit_config_set_bool:
  * @config: a #GgitConfig.
- * @name: the name of the configuration value
- * @value: the new value
+ * @name: the name of the configuration value.
+ * @value: the new value.
  * @error: a #GError for error reporting, or %NULL.
  *
  * Set a boolean value.
@@ -538,7 +538,7 @@ ggit_config_get_string (GgitConfig   *config,
  * ggit_config_set_string:
  * @config: a #GgitConfig.
  * @name: the name of the configuration value.
- * @value: the new value
+ * @value: the new value.
  * @error: a #GError for error reporting, or %NULL.
  *
  * Set a new string value of a configuration.
@@ -634,7 +634,7 @@ callback_wrapper (const git_config_entry *config_entry,
  * ggit_config_foreach:
  * @config: a #GgitConfig.
  * @callback: (scope call): a #GgitConfigCallback.
- * @user_data: (allow-none): the user data for @callback
+ * @user_data: (allow-none): the user data for @callback.
  * @error: a #GError for error reporting, or %NULL.
  *
  * Call @callback for each configuration value.
@@ -763,7 +763,7 @@ ggit_config_match (GgitConfig  *config,
  * @config: a #GgitConfig.
  * @regex: a #GRegex.
  * @callback: (scope call) (closure user_data): a #GgitConfigMatchCallback.
- * @user_data: (closure): the user data for @callback
+ * @user_data: (closure): the user data for @callback.
  * @error: a #GError for error reporting, or %NULL.
  *
  * Call @callback for all configurations matching @regex.
diff --git a/libgit2-glib/ggit-index-entry-resolve-undo.c b/libgit2-glib/ggit-index-entry-resolve-undo.c
index 0d344b8..728f623 100644
--- a/libgit2-glib/ggit-index-entry-resolve-undo.c
+++ b/libgit2-glib/ggit-index-entry-resolve-undo.c
@@ -239,7 +239,7 @@ ggit_index_entries_resolve_undo_get_by_file (GgitIndexEntriesResolveUndo  *entri
 /**
  * ggit_index_entry_resolve_undo_get_mode:
  * @entry: a #GgitIndexEntryResolveUndo.
- * @stage: the stage (0, 1 or 2)
+ * @stage: the stage (0, 1 or 2).
  *
  * Get the mode of the index entry. The returned mode contains the modes from
  * stage 1, 2 and 3.
@@ -260,7 +260,7 @@ ggit_index_entry_resolve_undo_get_mode (GgitIndexEntryResolveUndo *entry,
 /**
  * ggit_index_entry_resolve_undo_get_id:
  * @entry: a #GgitIndexEntryResolveUndo.
- * @stage: the stage (0, 1 or 2)
+ * @stage: the stage (0, 1 or 2).
  *
  * Get the oid of the index entry.
  *
diff --git a/libgit2-glib/ggit-index.c b/libgit2-glib/ggit-index.c
index 185a549..59f84af 100644
--- a/libgit2-glib/ggit-index.c
+++ b/libgit2-glib/ggit-index.c
@@ -341,7 +341,7 @@ ggit_index_remove (GgitIndex  *idx,
 /**
  * ggit_index_add:
  * @idx: a #GgitIndex.
- * @entry: a #GgitIndexEntry
+ * @entry: a #GgitIndexEntry.
  * @error: a #GError for error reporting, or %NULL.
  *
  * Add a file to the index.
diff --git a/libgit2-glib/ggit-oid.c b/libgit2-glib/ggit-oid.c
index ae8d3c4..6bb98e5 100644
--- a/libgit2-glib/ggit-oid.c
+++ b/libgit2-glib/ggit-oid.c
@@ -163,7 +163,7 @@ ggit_oid_to_string (GgitOId *oid)
 
 /**
  * ggit_oid_hash:
- * @oid: a #GgitOId
+ * @oid: a #GgitOId.
  *
  * Computes a hash value for a git object identifier.
  *
@@ -194,8 +194,8 @@ ggit_oid_hash (GgitOId const *oid)
 
 /**
  * ggit_oid_equal:
- * @a: a #GgitOId
- * @b: a #GgitOId
+ * @a: a #GgitOId.
+ * @b: a #GgitOId.
  *
  * Compares two #GgitOId for equality.
  *
diff --git a/libgit2-glib/ggit-repository.c b/libgit2-glib/ggit-repository.c
index 2abe571..262d25b 100644
--- a/libgit2-glib/ggit-repository.c
+++ b/libgit2-glib/ggit-repository.c
@@ -929,8 +929,8 @@ ggit_repository_get_workdir (GgitRepository *repository)
 /**
  * ggit_repository_set_workdir:
  * @repository: a #GgitRepository.
- * @workdir: the working directory
- * @update_gitlink: create/update gitlink in workdir
+ * @workdir: the working directory.
+ * @update_gitlink: create/update gitlink in workdir.
  *
  * Sets the working directory of the repository. If @update_gitlink is set to
  * %TRUE "core.worktree" will be set in the config if workdir is not the parent
@@ -1093,7 +1093,7 @@ ggit_repository_references_foreach_name (GgitRepository             *repository,
 
 /**
  * ggit_repository_get_config:
- * @repository: a #GgitRepository
+ * @repository: a #GgitRepository.
  * @error: a #GError for error reporting, or %NULL.
  *
  * Get the config for a specific repository.
@@ -1755,7 +1755,7 @@ ggit_repository_save_stash (GgitRepository  *repository,
 /**
  * ggit_repository_drop_stash:
  * @repository: a #GgitRepository.
- * @index: the position within the stash list. 0 points to the
+ * @index: the position within the stash list. 0 points to the.
  * most recent stashed state.
  * @error: a #GError for error reporting, or %NULL.
  *
diff --git a/libgit2-glib/ggit-submodule.c b/libgit2-glib/ggit-submodule.c
index 8ad1db5..7afed55 100644
--- a/libgit2-glib/ggit-submodule.c
+++ b/libgit2-glib/ggit-submodule.c
@@ -114,7 +114,7 @@ ggit_submodule_save (GgitSubmodule  *submodule,
 
 /**
  * ggit_submodule_get_owner:
- * @submodule: a #GgitSubmodule
+ * @submodule: a #GgitSubmodule.
  *
  * Gets the containing repository for a submodule.
  *
diff --git a/libgit2-glib/ggit-tree.c b/libgit2-glib/ggit-tree.c
index 6ba1873..60f40d8 100644
--- a/libgit2-glib/ggit-tree.c
+++ b/libgit2-glib/ggit-tree.c
@@ -227,8 +227,8 @@ walk_callback_wrapper (const char           *root,
 /**
  * ggit_tree_walk:
  * @tree: a #GgitTree.
- * @mode: the walking order
- * @callback: (scope call): the callback to call for each entry
+ * @mode: the walking order.
+ * @callback: (scope call): the callback to call for each entry.
  * @user_data: (closure): user data for the callback.
  * @error: a #GError for error reporting, or %NULL.
  *


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