rugged 1.7.2 → 1.9.0

data/vendor/libgit2/include/git2/status.h

@@ -14,7 +14,7 @@
 
 /**
  * @file git2/status.h
- * @brief Git file status routines
+ * @brief Status indicates how a user has changed the working directory and index
  * @defgroup git_status Git file status routines
  * @ingroup Git
  * @{
@@ -54,11 +54,10 @@ typedef enum {
 /**
  * Function pointer to receive status on individual files
  *
- * `path` is the relative path to the file from the root of the repository.
- *
- * `status_flags` is a combination of `git_status_t` values that apply.
- *
- * `payload` is the value you passed to the foreach function as payload.
+ * @param path is the path to the file
+ * @param status_flags the `git_status_t` values for file's status
+ * @param payload the user-specified payload to the foreach function
+ * @return 0 on success, or a negative number on failure
  */
 typedef int GIT_CALLBACK(git_status_cb)(
 	const char *path, unsigned int status_flags, void *payload);
@@ -207,6 +206,7 @@ typedef enum {
 	GIT_STATUS_OPT_INCLUDE_UNREADABLE_AS_UNTRACKED  = (1u << 15)
 } git_status_opt_t;
 
+/** Default `git_status_opt_t` values */
 #define GIT_STATUS_OPT_DEFAULTS \
 	(GIT_STATUS_OPT_INCLUDE_IGNORED | \
 	GIT_STATUS_OPT_INCLUDE_UNTRACKED | \
@@ -261,7 +261,10 @@ typedef struct {
 	uint16_t          rename_threshold;
 } git_status_options;
 
+/** Current version for the `git_status_options` structure */
 #define GIT_STATUS_OPTIONS_VERSION 1
+
+/** Static constructor for `git_status_options` */
 #define GIT_STATUS_OPTIONS_INIT {GIT_STATUS_OPTIONS_VERSION}
 
 /**
@@ -449,4 +452,5 @@ GIT_EXTERN(int) git_status_should_ignore(
 
 /** @} */
 GIT_END_DECL
+
 #endif

data/vendor/libgit2/include/git2/stdint.h

@@ -1,37 +1,37 @@
-// ISO C9x  compliant stdint.h for Microsoft Visual Studio
-// Based on ISO/IEC 9899:TC2 Committee draft (May 6, 2005) WG14/N1124
-//
-//  Copyright (c) 2006-2008 Alexander Chemeris
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions are met:
-//
-//   1. Redistributions of source code must retain the above copyright notice,
-//      this list of conditions and the following disclaimer.
-//
-//   2. Redistributions in binary form must reproduce the above copyright
-//      notice, this list of conditions and the following disclaimer in the
-//      documentation and/or other materials provided with the distribution.
-//
-//   3. The name of the author may be used to endorse or promote products
-//      derived from this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
-// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
-// EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
-// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
-// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
-// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
-// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-//
-///////////////////////////////////////////////////////////////////////////////
-
-#ifdef _MSC_VER // [
-
-#ifndef _MSC_STDINT_H_ // [
+/* ISO C9x  compliant stdint.h for Microsoft Visual Studio
+ * Based on ISO/IEC 9899:TC2 Committee draft (May 6, 2005) WG14/N1124
+ *
+ *  Copyright (c) 2006-2008 Alexander Chemeris
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *   1. Redistributions of source code must retain the above copyright notice,
+ *      this list of conditions and the following disclaimer.
+ *
+ *   2. Redistributions in binary form must reproduce the above copyright
+ *      notice, this list of conditions and the following disclaimer in the
+ *      documentation and/or other materials provided with the distribution.
+ *
+ *   3. The name of the author may be used to endorse or promote products
+ *      derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+ * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+ * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+ * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ *******************************************************************************/
+
+#ifdef _MSC_VER /* [ */
+
+#ifndef _MSC_STDINT_H_ /* [ */
 #define _MSC_STDINT_H_
 
 #if _MSC_VER > 1000
@@ -40,10 +40,11 @@
 
 #include <limits.h>
 
-// For Visual Studio 6 in C++ mode and for many Visual Studio versions when
-// compiling for ARM we should wrap <wchar.h> include with 'extern "C++" {}'
-// or compiler give many errors like this:
-//   error C2733: second C linkage of overloaded function 'wmemchr' not allowed
+/* For Visual Studio 6 in C++ mode and for many Visual Studio versions when
+ * compiling for ARM we should wrap <wchar.h> include with 'extern "C++" {}'
+ * or compiler give many errors like this:
+ *   error C2733: second C linkage of overloaded function 'wmemchr' not allowed
+*/
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -52,7 +53,7 @@ extern "C" {
 }
 #endif
 
-// Define _W64 macros to mark types changing their size, like intptr_t.
+/* Define _W64 macros to mark types changing their size, like intptr_t. */
 #ifndef _W64
 #  if !defined(__midl) && (defined(_X86_) || defined(_M_IX86)) && _MSC_VER >= 1300
 #     define _W64 __w64
@@ -62,13 +63,14 @@ extern "C" {
 #endif
 
 
-// 7.18.1 Integer types
-
-// 7.18.1.1 Exact-width integer types
-
-// Visual Studio 6 and Embedded Visual C++ 4 doesn't
-// realize that, e.g. char has the same size as __int8
-// so we give up on __intX for them.
+/* 7.18.1 Integer types
+ *
+ * 7.18.1.1 Exact-width integer types
+ *
+ * Visual Studio 6 and Embedded Visual C++ 4 doesn't
+ * realize that, e.g. char has the same size as __int8
+ * so we give up on __intX for them.
+ */
 #if (_MSC_VER < 1300)
    typedef signed char       int8_t;
    typedef signed short      int16_t;
@@ -88,7 +90,7 @@ typedef signed __int64       int64_t;
 typedef unsigned __int64     uint64_t;
 
 
-// 7.18.1.2 Minimum-width integer types
+/* 7.18.1.2 Minimum-width integer types */
 typedef int8_t    int_least8_t;
 typedef int16_t   int_least16_t;
 typedef int32_t   int_least32_t;
@@ -98,7 +100,7 @@ typedef uint16_t  uint_least16_t;
 typedef uint32_t  uint_least32_t;
 typedef uint64_t  uint_least64_t;
 
-// 7.18.1.3 Fastest minimum-width integer types
+/* 7.18.1.3 Fastest minimum-width integer types */
 typedef int8_t    int_fast8_t;
 typedef int16_t   int_fast16_t;
 typedef int32_t   int_fast32_t;
@@ -108,25 +110,25 @@ typedef uint16_t  uint_fast16_t;
 typedef uint32_t  uint_fast32_t;
 typedef uint64_t  uint_fast64_t;
 
-// 7.18.1.4 Integer types capable of holding object pointers
-#ifdef _WIN64 // [
+/* 7.18.1.4 Integer types capable of holding object pointers */
+#ifdef _WIN64 /* [ */
    typedef signed __int64    intptr_t;
    typedef unsigned __int64  uintptr_t;
-#else // _WIN64 ][
+#else /* _WIN64 ][ */
    typedef _W64 signed int   intptr_t;
    typedef _W64 unsigned int uintptr_t;
-#endif // _WIN64 ]
+#endif /* _WIN64 ] */
 
-// 7.18.1.5 Greatest-width integer types
+/* 7.18.1.5 Greatest-width integer types */
 typedef int64_t   intmax_t;
 typedef uint64_t  uintmax_t;
 
 
-// 7.18.2 Limits of specified-width integer types
+/* 7.18.2 Limits of specified-width integer types */
 
-#if !defined(__cplusplus) || defined(__STDC_LIMIT_MACROS) // [   See footnote 220 at page 257 and footnote 221 at page 259
+#if !defined(__cplusplus) || defined(__STDC_LIMIT_MACROS) /* [   See footnote 220 at page 257 and footnote 221 at page 259 */
 
-// 7.18.2.1 Limits of exact-width integer types
+/* 7.18.2.1 Limits of exact-width integer types */
 #define INT8_MIN     ((int8_t)_I8_MIN)
 #define INT8_MAX     _I8_MAX
 #define INT16_MIN    ((int16_t)_I16_MIN)
@@ -140,7 +142,7 @@ typedef uint64_t  uintmax_t;
 #define UINT32_MAX   _UI32_MAX
 #define UINT64_MAX   _UI64_MAX
 
-// 7.18.2.2 Limits of minimum-width integer types
+/* 7.18.2.2 Limits of minimum-width integer types */
 #define INT_LEAST8_MIN    INT8_MIN
 #define INT_LEAST8_MAX    INT8_MAX
 #define INT_LEAST16_MIN   INT16_MIN
@@ -154,7 +156,7 @@ typedef uint64_t  uintmax_t;
 #define UINT_LEAST32_MAX  UINT32_MAX
 #define UINT_LEAST64_MAX  UINT64_MAX
 
-// 7.18.2.3 Limits of fastest minimum-width integer types
+/* 7.18.2.3 Limits of fastest minimum-width integer types */
 #define INT_FAST8_MIN    INT8_MIN
 #define INT_FAST8_MAX    INT8_MAX
 #define INT_FAST16_MIN   INT16_MIN
@@ -168,62 +170,62 @@ typedef uint64_t  uintmax_t;
 #define UINT_FAST32_MAX  UINT32_MAX
 #define UINT_FAST64_MAX  UINT64_MAX
 
-// 7.18.2.4 Limits of integer types capable of holding object pointers
-#ifdef _WIN64 // [
+/* 7.18.2.4 Limits of integer types capable of holding object pointers */
+#ifdef _WIN64 /* [ */
 #  define INTPTR_MIN   INT64_MIN
 #  define INTPTR_MAX   INT64_MAX
 #  define UINTPTR_MAX  UINT64_MAX
-#else // _WIN64 ][
+#else /* _WIN64 ][ */
 #  define INTPTR_MIN   INT32_MIN
 #  define INTPTR_MAX   INT32_MAX
 #  define UINTPTR_MAX  UINT32_MAX
-#endif // _WIN64 ]
+#endif /* _WIN64 ] */
 
-// 7.18.2.5 Limits of greatest-width integer types
+/* 7.18.2.5 Limits of greatest-width integer types */
 #define INTMAX_MIN   INT64_MIN
 #define INTMAX_MAX   INT64_MAX
 #define UINTMAX_MAX  UINT64_MAX
 
-// 7.18.3 Limits of other integer types
+/* 7.18.3 Limits of other integer types */
 
-#ifdef _WIN64 // [
+#ifdef _WIN64 /* [ */
 #  define PTRDIFF_MIN  _I64_MIN
 #  define PTRDIFF_MAX  _I64_MAX
-#else  // _WIN64 ][
+#else  /* _WIN64 ][ */
 #  define PTRDIFF_MIN  _I32_MIN
 #  define PTRDIFF_MAX  _I32_MAX
-#endif  // _WIN64 ]
+#endif  /* _WIN64 ] */
 
 #define SIG_ATOMIC_MIN  INT_MIN
 #define SIG_ATOMIC_MAX  INT_MAX
 
-#ifndef SIZE_MAX // [
-#  ifdef _WIN64 // [
+#ifndef SIZE_MAX /* [ */
+#  ifdef _WIN64 /* [ */
 #     define SIZE_MAX  _UI64_MAX
-#  else // _WIN64 ][
+#  else /* _WIN64 ][  */
 #     define SIZE_MAX  _UI32_MAX
-#  endif // _WIN64 ]
-#endif // SIZE_MAX ]
+#  endif /* _WIN64 ] */
+#endif /* SIZE_MAX ] */
 
-// WCHAR_MIN and WCHAR_MAX are also defined in <wchar.h>
-#ifndef WCHAR_MIN // [
+/* WCHAR_MIN and WCHAR_MAX are also defined in <wchar.h> */
+#ifndef WCHAR_MIN /* [ */
 #  define WCHAR_MIN  0
-#endif  // WCHAR_MIN ]
-#ifndef WCHAR_MAX // [
+#endif  /* WCHAR_MIN ] */
+#ifndef WCHAR_MAX /* [ */
 #  define WCHAR_MAX  _UI16_MAX
-#endif  // WCHAR_MAX ]
+#endif  /* WCHAR_MAX ] */
 
 #define WINT_MIN  0
 #define WINT_MAX  _UI16_MAX
 
-#endif // __STDC_LIMIT_MACROS ]
+#endif /* __STDC_LIMIT_MACROS ] */
 
 
-// 7.18.4 Limits of other integer types
+/* 7.18.4 Limits of other integer types
 
-#if !defined(__cplusplus) || defined(__STDC_CONSTANT_MACROS) // [   See footnote 224 at page 260
+#if !defined(__cplusplus) || defined(__STDC_CONSTANT_MACROS) /* [    See footnote 224 at page 260 */
 
-// 7.18.4.1 Macros for minimum-width integer constants
+/* 7.18.4.1 Macros for minimum-width integer constants */
 
 #define INT8_C(val)  val##i8
 #define INT16_C(val) val##i16
@@ -235,13 +237,13 @@ typedef uint64_t  uintmax_t;
 #define UINT32_C(val) val##ui32
 #define UINT64_C(val) val##ui64
 
-// 7.18.4.2 Macros for greatest-width integer constants
+/* 7.18.4.2 Macros for greatest-width integer constants */
 #define INTMAX_C   INT64_C
 #define UINTMAX_C  UINT64_C
 
-#endif // __STDC_CONSTANT_MACROS ]
+#endif /* __STDC_CONSTANT_MACROS ] */
 
 
-#endif // _MSC_STDINT_H_ ]
+#endif /* _MSC_STDINT_H_ ] */
 
-#endif // _MSC_VER ]
+#endif /* _MSC_VER ] */

data/vendor/libgit2/include/git2/strarray.h

@@ -11,8 +11,8 @@
 
 /**
  * @file git2/strarray.h
- * @brief Git string array routines
- * @defgroup git_strarray Git string array routines
+ * @brief An array of strings for the user to free
+ * @defgroup git_strarray An array of strings for the user to free
  * @ingroup Git
  * @{
  */
@@ -40,4 +40,3 @@ GIT_EXTERN(void) git_strarray_dispose(git_strarray *array);
 GIT_END_DECL
 
 #endif
-

data/vendor/libgit2/include/git2/submodule.h

@@ -15,7 +15,7 @@
 
 /**
  * @file git2/submodule.h
- * @brief Git submodule management utilities
+ * @brief Submodules place another repository's contents within this one
  *
  * Submodule support in libgit2 builds a list of known submodules and keeps
  * it in the repository.  The list is built from the .gitmodules file, the
@@ -88,20 +88,27 @@ typedef enum {
 	GIT_SUBMODULE_STATUS_WD_UNTRACKED      = (1u << 13)
 } git_submodule_status_t;
 
+/** Submodule source bits */
 #define GIT_SUBMODULE_STATUS__IN_FLAGS		0x000Fu
+/** Submodule index status */
 #define GIT_SUBMODULE_STATUS__INDEX_FLAGS	0x0070u
+/** Submodule working directory status */
 #define GIT_SUBMODULE_STATUS__WD_FLAGS		0x3F80u
 
+/** Whether the submodule is modified */
 #define GIT_SUBMODULE_STATUS_IS_UNMODIFIED(S) \
 	(((S) & ~GIT_SUBMODULE_STATUS__IN_FLAGS) == 0)
 
+/** Whether the submodule is modified (in the index) */
 #define GIT_SUBMODULE_STATUS_IS_INDEX_UNMODIFIED(S) \
 	(((S) & GIT_SUBMODULE_STATUS__INDEX_FLAGS) == 0)
 
+/** Whether the submodule is modified (in the working directory) */
 #define GIT_SUBMODULE_STATUS_IS_WD_UNMODIFIED(S) \
 	(((S) & (GIT_SUBMODULE_STATUS__WD_FLAGS & \
 	~GIT_SUBMODULE_STATUS_WD_UNINITIALIZED)) == 0)
 
+/** Whether the submodule working directory is dirty */
 #define GIT_SUBMODULE_STATUS_IS_WD_DIRTY(S) \
 	(((S) & (GIT_SUBMODULE_STATUS_WD_INDEX_MODIFIED | \
 	GIT_SUBMODULE_STATUS_WD_WD_MODIFIED | \
@@ -130,10 +137,8 @@ typedef struct git_submodule_update_options {
 
 	/**
 	 * These options are passed to the checkout step. To disable
-	 * checkout, set the `checkout_strategy` to
-	 * `GIT_CHECKOUT_NONE`. Generally you will want the use
-	 * GIT_CHECKOUT_SAFE to update files in the working
-	 * directory.
+	 * checkout, set the `checkout_strategy` to `GIT_CHECKOUT_NONE`
+	 * or `GIT_CHECKOUT_DRY_RUN`.
 	 */
 	git_checkout_options checkout_opts;
 
@@ -152,11 +157,15 @@ typedef struct git_submodule_update_options {
 	int allow_fetch;
 } git_submodule_update_options;
 
+/** Current version for the `git_submodule_update_options` structure */
 #define GIT_SUBMODULE_UPDATE_OPTIONS_VERSION 1
+
+/** Static constructor for `git_submodule_update_options` */
 #define GIT_SUBMODULE_UPDATE_OPTIONS_INIT \
 	{ GIT_SUBMODULE_UPDATE_OPTIONS_VERSION, \
-		{ GIT_CHECKOUT_OPTIONS_VERSION, GIT_CHECKOUT_SAFE }, \
-	GIT_FETCH_OPTIONS_INIT, 1 }
+	  GIT_CHECKOUT_OPTIONS_INIT, \
+	  GIT_FETCH_OPTIONS_INIT, \
+	  1 }
 
 /**
  * Initialize git_submodule_update_options structure
@@ -531,7 +540,8 @@ GIT_EXTERN(int) git_submodule_set_update(
  * Note that at this time, libgit2 does not honor this setting and the
  * fetch functionality current ignores submodules.
  *
- * @return 0 if fetchRecurseSubmodules is false, 1 if true
+ * @param submodule the submodule to examine
+ * @return the submodule recursion configuration
  */
 GIT_EXTERN(git_submodule_recurse_t) git_submodule_fetch_recurse_submodules(
 	git_submodule *submodule);
@@ -543,7 +553,7 @@ GIT_EXTERN(git_submodule_recurse_t) git_submodule_fetch_recurse_submodules(
  *
  * @param repo the repository to affect
  * @param name the submodule to configure
- * @param fetch_recurse_submodules Boolean value
+ * @param fetch_recurse_submodules the submodule recursion configuration
  * @return old value for fetchRecurseSubmodules
  */
 GIT_EXTERN(int) git_submodule_set_fetch_recurse_submodules(
@@ -665,4 +675,5 @@ GIT_EXTERN(int) git_submodule_location(
 
 /** @} */
 GIT_END_DECL
+
 #endif

data/vendor/libgit2/include/git2/sys/alloc.h

@@ -10,6 +10,17 @@
 
 #include "git2/common.h"
 
+/**
+ * @file git2/sys/alloc.h
+ * @brief Custom memory allocators
+ * @defgroup git_merge Git merge routines
+ * @ingroup Git
+ *
+ * Users can configure custom allocators; this is particularly
+ * interesting when running in constrained environments, when calling
+ * from another language, or during testing.
+ * @{
+ */
 GIT_BEGIN_DECL
 
 /**
@@ -62,6 +73,7 @@ int git_stdalloc_init_allocator(git_allocator *allocator);
  */
 int git_win32_crtdbg_init_allocator(git_allocator *allocator);
 
+/** @} */
 GIT_END_DECL
 
 #endif

data/vendor/libgit2/include/git2/sys/commit.h

@@ -14,7 +14,7 @@
 /**
  * @file git2/sys/commit.h
  * @brief Low-level Git commit creation
- * @defgroup git_backend Git custom backend APIs
+ * @defgroup git_commit Low-level Git commit creation
  * @ingroup Git
  * @{
  */
@@ -29,7 +29,43 @@ GIT_BEGIN_DECL
  * the `tree`, neither the `parents` list of `git_oid`s are checked for
  * validity.
  *
- * @see git_commit_create
+ * @param id Pointer in which to store the OID of the newly created commit
+ *
+ * @param repo Repository where to store the commit
+ *
+ * @param update_ref If not NULL, name of the reference that
+ *	will be updated to point to this commit. If the reference
+ *	is not direct, it will be resolved to a direct reference.
+ *	Use "HEAD" to update the HEAD of the current branch and
+ *	make it point to this commit. If the reference doesn't
+ *	exist yet, it will be created. If it does exist, the first
+ *	parent must be the tip of this branch.
+ *
+ * @param author Signature with author and author time of commit
+ *
+ * @param committer Signature with committer and * commit time of commit
+ *
+ * @param message_encoding The encoding for the message in the
+ *  commit, represented with a standard encoding name.
+ *  E.g. "UTF-8". If NULL, no encoding header is written and
+ *  UTF-8 is assumed.
+ *
+ * @param message Full message for this commit
+ *
+ * @param tree An instance of a `git_tree` object that will
+ *  be used as the tree for the commit. This tree object must
+ *  also be owned by the given `repo`.
+ *
+ * @param parent_count Number of parents for this commit
+ *
+ * @param parents Array of `parent_count` pointers to `git_commit`
+ *  objects that will be used as the parents for this commit. This
+ *  array may be NULL if `parent_count` is 0 (root commit). All the
+ *  given commits must be owned by the `repo`.
+ *
+ * @return 0 or an error code
+ *	The created commit will be written to the Object Database and
+ *	the given reference will be updated to point to it
  */
 GIT_EXTERN(int) git_commit_create_from_ids(
 	git_oid *id,
@@ -49,6 +85,10 @@ GIT_EXTERN(int) git_commit_create_from_ids(
  * This is invoked with the count of the number of parents processed so far
  * along with the user supplied payload.  This should return a git_oid of
  * the next parent or NULL if all parents have been provided.
+ *
+ * @param idx the index of the parent
+ * @param payload the user-specified payload
+ * @return the object id of the parent, or NULL if there are no further parents
  */
 typedef const git_oid * GIT_CALLBACK(git_commit_parent_callback)(size_t idx, void *payload);
 
@@ -61,7 +101,40 @@ typedef const git_oid * GIT_CALLBACK(git_commit_parent_callback)(size_t idx, voi
  * with `parent_payload` and should return `git_oid` values or NULL to
  * indicate that all parents are accounted for.
  *
- * @see git_commit_create
+ * @param id Pointer in which to store the OID of the newly created commit
+ *
+ * @param repo Repository where to store the commit
+ *
+ * @param update_ref If not NULL, name of the reference that
+ *	will be updated to point to this commit. If the reference
+ *	is not direct, it will be resolved to a direct reference.
+ *	Use "HEAD" to update the HEAD of the current branch and
+ *	make it point to this commit. If the reference doesn't
+ *	exist yet, it will be created. If it does exist, the first
+ *	parent must be the tip of this branch.
+ *
+ * @param author Signature with author and author time of commit
+ *
+ * @param committer Signature with committer and * commit time of commit
+ *
+ * @param message_encoding The encoding for the message in the
+ *  commit, represented with a standard encoding name.
+ *  E.g. "UTF-8". If NULL, no encoding header is written and
+ *  UTF-8 is assumed.
+ *
+ * @param message Full message for this commit
+ *
+ * @param tree An instance of a `git_tree` object that will
+ *  be used as the tree for the commit. This tree object must
+ *  also be owned by the given `repo`.
+ *
+ * @param parent_cb Callback to invoke to obtain parent information
+ *
+ * @param parent_payload User-specified payload to provide to the callback
+ *
+ * @return 0 or an error code
+ *	The created commit will be written to the Object Database and
+ *	the given reference will be updated to point to it
  */
 GIT_EXTERN(int) git_commit_create_from_callback(
 	git_oid *id,
@@ -77,4 +150,5 @@ GIT_EXTERN(int) git_commit_create_from_callback(
 
 /** @} */
 GIT_END_DECL
+
 #endif