v0.15.0.json

{
  "info": {
    "version": "v0.15.0",
    "commit": "3eaf34f4c602b9e155e2f4c6ae26c9250ac37d50"
  },
  "groups": {
    "blob": {
      "apis": {
        "git_blob_lookup": {
          "kind": "function",
          "name": "git_blob_lookup",
          "location": {
            "file": "blob.h",
            "line": 32,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "blob",
              "type": "git_blob **",
              "direction": "in",
              "comment": "pointer to the looked up blob"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "the repo to use when locating the blob."
            },
            {
              "name": "id",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "identity of the blob to locate."
            }
          ],
          "comment": [
            "Lookup a blob object from a repository."
          ],
          "group": "blob"
        },
        "git_blob_lookup_prefix": {
          "kind": "function",
          "name": "git_blob_lookup_prefix",
          "location": {
            "file": "blob.h",
            "line": 49,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "blob",
              "type": "git_blob **",
              "direction": "in",
              "comment": "pointer to the looked up blob"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "the repo to use when locating the blob."
            },
            {
              "name": "id",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "identity of the blob to locate."
            },
            {
              "name": "len",
              "type": "unsigned int",
              "direction": "in",
              "comment": "the length of the short identifier"
            }
          ],
          "comment": [
            "Lookup a blob object from a repository,\n given a prefix of its identifier (short id)."
          ],
          "see": [
            "git_object_lookup_prefix"
          ],
          "group": "blob"
        },
        "git_blob_close": {
          "kind": "function",
          "name": "git_blob_close",
          "location": {
            "file": "blob.h",
            "line": 66,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "blob",
              "type": "git_blob *",
              "direction": "in",
              "comment": "the blob to close"
            }
          ],
          "comment": [
            "Close an open blob",
            "This is a wrapper around git_object_close()",
            "IMPORTANT:\n It *is* necessary to call this method when you stop\n using a blob. Failure to do so will cause a memory leak."
          ],
          "group": "blob"
        },
        "git_blob_rawcontent": {
          "kind": "function",
          "name": "git_blob_rawcontent",
          "location": {
            "file": "blob.h",
            "line": 83,
            "column": 26
          },
          "returns": {
            "type": "const void *",
            "comment": "the pointer; NULL if the blob has no contents"
          },
          "params": [
            {
              "name": "blob",
              "type": "git_blob *",
              "direction": "in",
              "comment": "pointer to the blob"
            }
          ],
          "comment": [
            "Get a read-only buffer with the raw content of a blob.",
            "A pointer to the raw content of a blob is returned;\n this pointer is owned internally by the object and shall\n not be free'd. The pointer may be invalidated at a later\n time."
          ],
          "group": "blob"
        },
        "git_blob_rawsize": {
          "kind": "function",
          "name": "git_blob_rawsize",
          "location": {
            "file": "blob.h",
            "line": 91,
            "column": 20
          },
          "returns": {
            "type": "size_t",
            "comment": "size on bytes"
          },
          "params": [
            {
              "name": "blob",
              "type": "git_blob *",
              "direction": "in",
              "comment": "pointer to the blob"
            }
          ],
          "comment": [
            "Get the size in bytes of the contents of a blob"
          ],
          "group": "blob"
        },
        "git_blob_create_fromfile": {
          "kind": "function",
          "name": "git_blob_create_fromfile",
          "location": {
            "file": "blob.h",
            "line": 104,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "oid",
              "type": "git_oid *",
              "direction": "in",
              "comment": "return the id of the written blob"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "repository where the blob will be written.\n\tthis repository cannot be bare"
            },
            {
              "name": "path",
              "type": "const char *",
              "direction": "in",
              "comment": "file from which the blob will be created,\n\trelative to the repository's working dir"
            }
          ],
          "comment": [
            "Read a file from the working folder of a repository\n and write it to the Object Database as a loose blob"
          ],
          "group": "blob"
        },
        "git_blob_create_frombuffer": {
          "kind": "function",
          "name": "git_blob_create_frombuffer",
          "location": {
            "file": "blob.h",
            "line": 116,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "oid",
              "type": "git_oid *",
              "direction": "in",
              "comment": "return the oid of the written blob"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "repository where to blob will be written"
            },
            {
              "name": "buffer",
              "type": "const void *",
              "direction": "in",
              "comment": "data to be written into the blob"
            },
            {
              "name": "len",
              "type": "size_t",
              "direction": "in",
              "comment": "length of the data"
            }
          ],
          "comment": [
            "Write an in-memory buffer to the ODB as a blob"
          ],
          "group": "blob"
        },
        "git_blob": {
          "kind": "struct",
          "name": "git_blob",
          "referenceName": "struct git_blob",
          "opaque": true,
          "comment": [
            "In-memory representation of a blob object."
          ],
          "location": {
            "file": "types.h",
            "line": 105,
            "column": 25
          },
          "group": "blob",
          "parameterTo": [
            "git_blob_lookup",
            "git_blob_lookup_prefix",
            "git_blob_close",
            "git_blob_rawcontent",
            "git_blob_rawsize"
          ]
        }
      },
      "info": {
        "summary": "Git blob load and write routines"
      }
    },
    "branch": {
      "apis": {
        "git_branch": {
          "kind": "struct",
          "name": "git_branch",
          "referenceName": "struct git_branch",
          "members": [
            {
              "name": "remote",
              "type": "char *"
            },
            {
              "name": "merge",
              "type": "char *"
            }
          ],
          "location": {
            "file": "branch.h",
            "line": 10,
            "column": 8
          },
          "group": "branch"
        }
      },
      "info": {}
    },
    "commit": {
      "apis": {
        "git_commit_lookup": {
          "kind": "function",
          "name": "git_commit_lookup",
          "location": {
            "file": "commit.h",
            "line": 33,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "commit",
              "type": "git_commit **",
              "direction": "in",
              "comment": "pointer to the looked up commit"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "the repo to use when locating the commit."
            },
            {
              "name": "id",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "identity of the commit to locate. If the object is\n\t\tan annotated tag it will be peeled back to the commit."
            }
          ],
          "comment": [
            "Lookup a commit object from a repository."
          ],
          "group": "commit"
        },
        "git_commit_lookup_prefix": {
          "kind": "function",
          "name": "git_commit_lookup_prefix",
          "location": {
            "file": "commit.h",
            "line": 51,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "commit",
              "type": "git_commit **",
              "direction": "in",
              "comment": "pointer to the looked up commit"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "the repo to use when locating the commit."
            },
            {
              "name": "id",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "identity of the commit to locate. If the object is\n\t\tan annotated tag it will be peeled back to the commit."
            },
            {
              "name": "len",
              "type": "unsigned int",
              "direction": "in",
              "comment": "the length of the short identifier"
            }
          ],
          "comment": [
            "Lookup a commit object from a repository,\n given a prefix of its identifier (short id)."
          ],
          "see": [
            "git_object_lookup_prefix"
          ],
          "group": "commit"
        },
        "git_commit_close": {
          "kind": "function",
          "name": "git_commit_close",
          "location": {
            "file": "commit.h",
            "line": 68,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "commit",
              "type": "git_commit *",
              "direction": "in",
              "comment": "the commit to close"
            }
          ],
          "comment": [
            "Close an open commit",
            "This is a wrapper around git_object_close()",
            "IMPORTANT:\n It *is* necessary to call this method when you stop\n using a commit. Failure to do so will cause a memory leak."
          ],
          "group": "commit"
        },
        "git_commit_id": {
          "kind": "function",
          "name": "git_commit_id",
          "location": {
            "file": "commit.h",
            "line": 79,
            "column": 29
          },
          "returns": {
            "type": "const git_oid *",
            "comment": "object identity for the commit."
          },
          "params": [
            {
              "name": "commit",
              "type": "git_commit *",
              "direction": "in",
              "comment": "a previously loaded commit."
            }
          ],
          "comment": [
            "Get the id of a commit."
          ],
          "group": "commit"
        },
        "git_commit_message_encoding": {
          "kind": "function",
          "name": "git_commit_message_encoding",
          "location": {
            "file": "commit.h",
            "line": 91,
            "column": 26
          },
          "returns": {
            "type": "const char *",
            "comment": "NULL, or the encoding"
          },
          "params": [
            {
              "name": "commit",
              "type": "git_commit *",
              "direction": "in",
              "comment": "a previously loaded commit."
            }
          ],
          "comment": [
            "Get the encoding for the message of a commit,\n as a string representing a standard encoding name.",
            "The encoding may be NULL if the `encoding` header\n in the commit is missing; in that case UTF-8 is assumed."
          ],
          "group": "commit"
        },
        "git_commit_message": {
          "kind": "function",
          "name": "git_commit_message",
          "location": {
            "file": "commit.h",
            "line": 99,
            "column": 26
          },
          "returns": {
            "type": "const char *",
            "comment": "the message of a commit"
          },
          "params": [
            {
              "name": "commit",
              "type": "git_commit *",
              "direction": "in",
              "comment": "a previously loaded commit."
            }
          ],
          "comment": [
            "Get the full message of a commit."
          ],
          "group": "commit"
        },
        "git_commit_time": {
          "kind": "function",
          "name": "git_commit_time",
          "location": {
            "file": "commit.h",
            "line": 107,
            "column": 24
          },
          "returns": {
            "type": "git_time_t",
            "comment": "the time of a commit"
          },
          "params": [
            {
              "name": "commit",
              "type": "git_commit *",
              "direction": "in",
              "comment": "a previously loaded commit."
            }
          ],
          "comment": [
            "Get the commit time (i.e. committer time) of a commit."
          ],
          "group": "commit"
        },
        "git_commit_time_offset": {
          "kind": "function",
          "name": "git_commit_time_offset",
          "location": {
            "file": "commit.h",
            "line": 115,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "positive or negative timezone offset, in minutes from UTC"
          },
          "params": [
            {
              "name": "commit",
              "type": "git_commit *",
              "direction": "in",
              "comment": "a previously loaded commit."
            }
          ],
          "comment": [
            "Get the commit timezone offset (i.e. committer's preferred timezone) of a commit."
          ],
          "group": "commit"
        },
        "git_commit_committer": {
          "kind": "function",
          "name": "git_commit_committer",
          "location": {
            "file": "commit.h",
            "line": 123,
            "column": 35
          },
          "returns": {
            "type": "const git_signature *",
            "comment": "the committer of a commit"
          },
          "params": [
            {
              "name": "commit",
              "type": "git_commit *",
              "direction": "in",
              "comment": "a previously loaded commit."
            }
          ],
          "comment": [
            "Get the committer of a commit."
          ],
          "group": "commit"
        },
        "git_commit_author": {
          "kind": "function",
          "name": "git_commit_author",
          "location": {
            "file": "commit.h",
            "line": 131,
            "column": 35
          },
          "returns": {
            "type": "const git_signature *",
            "comment": "the author of a commit"
          },
          "params": [
            {
              "name": "commit",
              "type": "git_commit *",
              "direction": "in",
              "comment": "a previously loaded commit."
            }
          ],
          "comment": [
            "Get the author of a commit."
          ],
          "group": "commit"
        },
        "git_commit_tree": {
          "kind": "function",
          "name": "git_commit_tree",
          "location": {
            "file": "commit.h",
            "line": 140,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "tree_out",
              "type": "git_tree **",
              "direction": "in",
              "comment": "pointer where to store the tree object"
            },
            {
              "name": "commit",
              "type": "git_commit *",
              "direction": "in",
              "comment": "a previously loaded commit."
            }
          ],
          "comment": [
            "Get the tree pointed to by a commit."
          ],
          "group": "commit"
        },
        "git_commit_tree_oid": {
          "kind": "function",
          "name": "git_commit_tree_oid",
          "location": {
            "file": "commit.h",
            "line": 150,
            "column": 29
          },
          "returns": {
            "type": "const git_oid *",
            "comment": "the id of tree pointed to by commit."
          },
          "params": [
            {
              "name": "commit",
              "type": "git_commit *",
              "direction": "in",
              "comment": "a previously loaded commit."
            }
          ],
          "comment": [
            "Get the id of the tree pointed to by a commit. This differs from\n `git_commit_tree` in that no attempts are made to fetch an object\n from the ODB."
          ],
          "group": "commit"
        },
        "git_commit_parentcount": {
          "kind": "function",
          "name": "git_commit_parentcount",
          "location": {
            "file": "commit.h",
            "line": 158,
            "column": 26
          },
          "returns": {
            "type": "unsigned int",
            "comment": "integer of count of parents"
          },
          "params": [
            {
              "name": "commit",
              "type": "git_commit *",
              "direction": "in",
              "comment": "a previously loaded commit."
            }
          ],
          "comment": [
            "Get the number of parents of this commit"
          ],
          "group": "commit"
        },
        "git_commit_parent": {
          "kind": "function",
          "name": "git_commit_parent",
          "location": {
            "file": "commit.h",
            "line": 168,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "parent",
              "type": "git_commit **",
              "direction": "in",
              "comment": "Pointer where to store the parent commit"
            },
            {
              "name": "commit",
              "type": "git_commit *",
              "direction": "in",
              "comment": "a previously loaded commit."
            },
            {
              "name": "n",
              "type": "unsigned int",
              "direction": "in",
              "comment": "the position of the parent (from 0 to `parentcount`)"
            }
          ],
          "comment": [
            "Get the specified parent of the commit."
          ],
          "group": "commit"
        },
        "git_commit_parent_oid": {
          "kind": "function",
          "name": "git_commit_parent_oid",
          "location": {
            "file": "commit.h",
            "line": 179,
            "column": 29
          },
          "returns": {
            "type": "const git_oid *",
            "comment": "the id of the parent, NULL on error."
          },
          "params": [
            {
              "name": "commit",
              "type": "git_commit *",
              "direction": "in",
              "comment": "a previously loaded commit."
            },
            {
              "name": "n",
              "type": "unsigned int",
              "direction": "in",
              "comment": "the position of the parent (from 0 to `parentcount`)"
            }
          ],
          "comment": [
            "Get the oid of a specified parent for a commit. This is different from\n `git_commit_parent`, which will attempt to load the parent commit from\n the ODB."
          ],
          "group": "commit"
        },
        "git_commit_create": {
          "kind": "function",
          "name": "git_commit_create",
          "location": {
            "file": "commit.h",
            "line": 224,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code\n\tThe created commit will be written to the Object Database and\n\tthe given reference will be updated to point to it"
          },
          "params": [
            {
              "name": "oid",
              "type": "git_oid *",
              "direction": "in",
              "comment": "Pointer where to store the OID of the\n\tnewly created commit"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "Repository where to store the commit"
            },
            {
              "name": "update_ref",
              "type": "const char *",
              "direction": "in",
              "comment": "If not NULL, name of the reference that\n\twill be updated to point to this commit. If the reference\n\tis not direct, it will be resolved to a direct reference.\n\tUse \"HEAD\" to update the HEAD of the current branch and\n\tmake it point to this commit"
            },
            {
              "name": "author",
              "type": "const git_signature *",
              "direction": "in",
              "comment": "Signature representing the author and the authory\n\ttime of this commit"
            },
            {
              "name": "committer",
              "type": "const git_signature *",
              "direction": "in",
              "comment": "Signature representing the committer and the\n commit time of this commit"
            },
            {
              "name": "message_encoding",
              "type": "const char *",
              "direction": "in",
              "comment": "The encoding for the message in the\n commit, represented with a standard encoding name.\n E.g. \"UTF-8\". If NULL, no encoding header is written and\n UTF-8 is assumed."
            },
            {
              "name": "message",
              "type": "const char *",
              "direction": "in",
              "comment": "Full message for this commit"
            },
            {
              "name": "tree",
              "type": "const git_tree *",
              "direction": "in",
              "comment": "An instance of a `git_tree` object that will\n be used as the tree for the commit. This tree object must\n also be owned by the given `repo`."
            },
            {
              "name": "parent_count",
              "type": "int",
              "direction": "in",
              "comment": "Number of parents for this commit"
            },
            {
              "name": "parents",
              "type": "const git_commit **"
            }
          ],
          "comment": [
            "Create a new commit in the repository using `git_object`\n instances as parameters."
          ],
          "group": "commit"
        },
        "git_commit_create_v": {
          "kind": "function",
          "name": "git_commit_create_v",
          "location": {
            "file": "commit.h",
            "line": 249,
            "column": 17
          },
          "returns": {
            "type": "int"
          },
          "params": [
            {
              "name": "oid",
              "type": "git_oid *"
            },
            {
              "name": "repo",
              "type": "git_repository *"
            },
            {
              "name": "update_ref",
              "type": "const char *"
            },
            {
              "name": "author",
              "type": "const git_signature *"
            },
            {
              "name": "committer",
              "type": "const git_signature *"
            },
            {
              "name": "message_encoding",
              "type": "const char *"
            },
            {
              "name": "message",
              "type": "const char *"
            },
            {
              "name": "tree",
              "type": "const git_tree *"
            },
            {
              "name": "parent_count",
              "type": "int"
            }
          ],
          "comment": [
            "Create a new commit in the repository using a variable\n argument list.",
            "The parents for the commit are specified as a variable\n list of pointers to `const git_commit *`. Note that this\n is a convenience method which may not be safe to export\n for certain languages or compilers",
            "All other parameters remain the same"
          ],
          "see": [
            "git_commit_create"
          ],
          "group": "commit"
        },
        "git_commit": {
          "kind": "struct",
          "name": "git_commit",
          "referenceName": "struct git_commit",
          "opaque": true,
          "comment": [
            "Parsed representation of a commit object."
          ],
          "location": {
            "file": "types.h",
            "line": 108,
            "column": 27
          },
          "group": "commit",
          "parameterTo": [
            "git_commit_lookup",
            "git_commit_lookup_prefix",
            "git_commit_close",
            "git_commit_id",
            "git_commit_message_encoding",
            "git_commit_message",
            "git_commit_time",
            "git_commit_time_offset",
            "git_commit_committer",
            "git_commit_author",
            "git_commit_tree",
            "git_commit_tree_oid",
            "git_commit_parentcount",
            "git_commit_parent",
            "git_commit_parent_oid",
            "git_commit_create"
          ]
        }
      },
      "info": {
        "summary": "Git commit parsing, formatting routines"
      }
    },
    "common": {
      "apis": {
        "GIT_EXTERN(type)": {
          "kind": "macro",
          "name": "GIT_EXTERN(type)",
          "location": {
            "file": "common.h",
            "line": 34,
            "column": 10
          },
          "value": "extern __attribute__((visibility(\"default\"))) type",
          "comment": "Declare a public function exported for application use.",
          "group": "common"
        },
        "GIT_EXTERN_TLS(type)": {
          "kind": "macro",
          "name": "GIT_EXTERN_TLS(type)",
          "location": {
            "file": "common.h",
            "line": 46,
            "column": 10
          },
          "value": "extern __attribute__((visibility(\"default\"))) GIT_TLS type",
          "comment": "Declare a public TLS symbol exported for application use.",
          "group": "common"
        },
        "GIT_INLINE(type)": {
          "kind": "macro",
          "name": "GIT_INLINE(type)",
          "location": {
            "file": "common.h",
            "line": 55,
            "column": 10
          },
          "value": "static __inline type",
          "comment": "Declare a function as always inlined.",
          "group": "common"
        },
        "GIT_FORMAT_PRINTF(a,b)": {
          "kind": "macro",
          "name": "GIT_FORMAT_PRINTF(a,b)",
          "location": {
            "file": "common.h",
            "line": 62,
            "column": 10
          },
          "value": "__attribute__((format (printf, a, b)))",
          "comment": "Declare a function's takes printf style arguments.",
          "group": "common"
        },
        "GIT_PATH_LIST_SEPARATOR": {
          "kind": "macro",
          "name": "GIT_PATH_LIST_SEPARATOR",
          "location": {
            "file": "common.h",
            "line": 87,
            "column": 9
          },
          "value": "';'",
          "comment": "The separator used in path list strings (ie like in the PATH environment variable). A semi-colon \";\" is used on Windows, and a colon \":\" for all other systems.",
          "group": "common"
        },
        "GIT_PATH_MAX": {
          "kind": "macro",
          "name": "GIT_PATH_MAX",
          "location": {
            "file": "common.h",
            "line": 95,
            "column": 9
          },
          "value": "4096",
          "comment": "The maximum length of a git valid git path.",
          "group": "common"
        },
        "git_strarray": {
          "kind": "struct",
          "name": "git_strarray",
          "referenceName": "git_strarray",
          "members": [
            {
              "name": "strings",
              "type": "char **"
            },
            {
              "name": "count",
              "type": "size_t"
            }
          ],
          "location": {
            "file": "common.h",
            "line": 97,
            "column": 9
          },
          "group": "common",
          "parameterTo": [
            "git_strarray_free",
            "git_reference_listall",
            "git_tag_list",
            "git_tag_list_match"
          ]
        },
        "git_strarray_free": {
          "kind": "function",
          "name": "git_strarray_free",
          "location": {
            "file": "common.h",
            "line": 102,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "array",
              "type": "git_strarray *"
            }
          ],
          "group": "common"
        },
        "git_libgit2_version": {
          "kind": "function",
          "name": "git_libgit2_version",
          "location": {
            "file": "common.h",
            "line": 112,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "major",
              "type": "int *",
              "direction": "in",
              "comment": "Store the major version number"
            },
            {
              "name": "minor",
              "type": "int *",
              "direction": "in",
              "comment": "Store the minor version number"
            },
            {
              "name": "rev",
              "type": "int *",
              "direction": "in",
              "comment": "Store the revision (patch) number"
            }
          ],
          "comment": [
            "Return the version of the libgit2 library\n being currently used."
          ],
          "group": "common"
        }
      },
      "info": {
        "summary": "Git common platform definitions"
      }
    },
    "config": {
      "apis": {
        "git_config_file": {
          "kind": "struct",
          "name": "git_config_file",
          "referenceName": "struct git_config_file",
          "comment": [
            "Generic backend that implements the interface to\n access a configuration file"
          ],
          "members": [
            {
              "name": "cfg",
              "type": "struct git_config *"
            },
            {
              "name": "open",
              "type": "int (*)(struct git_config_file *)"
            },
            {
              "name": "get",
              "type": "int (*)(struct git_config_file *, const char *, const char **)"
            },
            {
              "name": "set",
              "type": "int (*)(struct git_config_file *, const char *, const char *)"
            },
            {
              "name": "foreach",
              "type": "int (*)(struct git_config_file *, int (*)(const char *, const char *, void *), void *)"
            },
            {
              "name": "free",
              "type": "void (*)(struct git_config_file *)"
            }
          ],
          "location": {
            "file": "config.h",
            "line": 26,
            "column": 8
          },
          "group": "config",
          "parameterTo": [
            "git_config_add_file"
          ]
        },
        "git_config_find_global": {
          "kind": "function",
          "name": "git_config_find_global",
          "location": {
            "file": "config.h",
            "line": 52,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS if a global configuration file has been\n\tfound. Its path will be stored in `buffer`."
          },
          "params": [
            {
              "name": "global_config_path",
              "type": "char *",
              "direction": "in",
              "comment": "Buffer of GIT_PATH_MAX length to store the path"
            }
          ],
          "comment": [
            "Locate the path to the global configuration file",
            "The user or global configuration file is usually\n located in `$HOME/.gitconfig`.",
            "This method will try to guess the full path to that\n file, if the file exists. The returned path\n may be used on any `git_config` call to load the\n global configuration file."
          ],
          "group": "config"
        },
        "git_config_find_system": {
          "kind": "function",
          "name": "git_config_find_system",
          "location": {
            "file": "config.h",
            "line": 64,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS if a system configuration file has been\n\tfound. Its path will be stored in `buffer`."
          },
          "params": [
            {
              "name": "system_config_path",
              "type": "char *",
              "direction": "in",
              "comment": "Buffer of GIT_PATH_MAX length to store the path"
            }
          ],
          "comment": [
            "Locate the path to the system configuration file",
            "If /etc/gitconfig doesn't exist, it will look for\n %PROGRAMFILES%\\Git\\etc\\gitconfig\n."
          ],
          "group": "config"
        },
        "git_config_open_global": {
          "kind": "function",
          "name": "git_config_open_global",
          "location": {
            "file": "config.h",
            "line": 75,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "out",
              "type": "git_config **",
              "direction": "in",
              "comment": "Pointer to store the config instance"
            }
          ],
          "comment": [
            "Open the global configuration file",
            "Utility wrapper that calls `git_config_find_global`\n and opens the located file, if it exists."
          ],
          "group": "config"
        },
        "git_config_file__ondisk": {
          "kind": "function",
          "name": "git_config_file__ondisk",
          "location": {
            "file": "config.h",
            "line": 88,
            "column": 17
          },
          "returns": {
            "type": "int"
          },
          "params": [
            {
              "name": "out",
              "type": "struct git_config_file **",
              "direction": "in",
              "comment": "the new backend"
            },
            {
              "name": "path",
              "type": "const char *",
              "direction": "in",
              "comment": "where the config file is located"
            }
          ],
          "comment": [
            "Create a configuration file backend for ondisk files",
            "These are the normal `.gitconfig` files that Core Git\n processes. Note that you first have to add this file to a\n configuration object before you can query it for configuration\n variables."
          ],
          "group": "config"
        },
        "git_config_new": {
          "kind": "function",
          "name": "git_config_new",
          "location": {
            "file": "config.h",
            "line": 99,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "out",
              "type": "git_config **",
              "direction": "in",
              "comment": "pointer to the new configuration"
            }
          ],
          "comment": [
            "Allocate a new configuration object",
            "This object is empty, so you have to add a file to it before you\n can do anything with it."
          ],
          "group": "config"
        },
        "git_config_add_file": {
          "kind": "function",
          "name": "git_config_add_file",
          "location": {
            "file": "config.h",
            "line": 116,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "cfg",
              "type": "git_config *",
              "direction": "in",
              "comment": "the configuration to add the file to"
            },
            {
              "name": "file",
              "type": "git_config_file *",
              "direction": "in",
              "comment": "the configuration file (backend) to add"
            },
            {
              "name": "priority",
              "type": "int",
              "direction": "in",
              "comment": "the priority the backend should have"
            }
          ],
          "comment": [
            "Add a generic config file instance to an existing config",
            "Note that the configuration object will free the file\n automatically.",
            "Further queries on this config object will access each\n of the config file instances in order (instances with\n a higher priority will be accessed first)."
          ],
          "group": "config"
        },
        "git_config_add_file_ondisk": {
          "kind": "function",
          "name": "git_config_add_file_ondisk",
          "location": {
            "file": "config.h",
            "line": 137,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "cfg",
              "type": "git_config *",
              "direction": "in",
              "comment": "the configuration to add the file to"
            },
            {
              "name": "path",
              "type": "const char *",
              "direction": "in",
              "comment": "path to the configuration file (backend) to add"
            },
            {
              "name": "priority",
              "type": "int",
              "direction": "in",
              "comment": "the priority the backend should have"
            }
          ],
          "comment": [
            "Add an on-disk config file instance to an existing config",
            "The on-disk file pointed at by `path` will be opened and\n parsed; it's expected to be a native Git config file following\n the default Git config syntax (see man git-config).",
            "Note that the configuration object will free the file\n automatically.",
            "Further queries on this config object will access each\n of the config file instances in order (instances with\n a higher priority will be accessed first)."
          ],
          "group": "config"
        },
        "git_config_open_ondisk": {
          "kind": "function",
          "name": "git_config_open_ondisk",
          "location": {
            "file": "config.h",
            "line": 152,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "cfg",
              "type": "git_config **",
              "direction": "in",
              "comment": "The configuration instance to create"
            },
            {
              "name": "path",
              "type": "const char *",
              "direction": "in",
              "comment": "Path to the on-disk file to open"
            }
          ],
          "comment": [
            "Create a new config instance containing a single on-disk file",
            "This method is a simple utility wrapper for the following sequence\n of calls:\n\t- git_config_new\n\t- git_config_add_file_ondisk"
          ],
          "group": "config"
        },
        "git_config_free": {
          "kind": "function",
          "name": "git_config_free",
          "location": {
            "file": "config.h",
            "line": 159,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "cfg",
              "type": "git_config *",
              "direction": "in",
              "comment": "the configuration to free"
            }
          ],
          "comment": [
            "Free the configuration and its associated memory and files"
          ],
          "group": "config"
        },
        "git_config_get_int32": {
          "kind": "function",
          "name": "git_config_get_int32",
          "location": {
            "file": "config.h",
            "line": 169,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "cfg",
              "type": "git_config *",
              "direction": "in",
              "comment": "where to look for the variable"
            },
            {
              "name": "name",
              "type": "const char *",
              "direction": "in",
              "comment": "the variable's name"
            },
            {
              "name": "out",
              "type": "int32_t *",
              "direction": "in",
              "comment": "pointer to the variable where the value should be stored"
            }
          ],
          "comment": [
            "Get the value of an integer config variable."
          ],
          "group": "config"
        },
        "git_config_get_int64": {
          "kind": "function",
          "name": "git_config_get_int64",
          "location": {
            "file": "config.h",
            "line": 179,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "cfg",
              "type": "git_config *",
              "direction": "in",
              "comment": "where to look for the variable"
            },
            {
              "name": "name",
              "type": "const char *",
              "direction": "in",
              "comment": "the variable's name"
            },
            {
              "name": "out",
              "type": "int64_t *",
              "direction": "in",
              "comment": "pointer to the variable where the value should be stored"
            }
          ],
          "comment": [
            "Get the value of a long integer config variable."
          ],
          "group": "config"
        },
        "git_config_get_bool": {
          "kind": "function",
          "name": "git_config_get_bool",
          "location": {
            "file": "config.h",
            "line": 192,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "cfg",
              "type": "git_config *",
              "direction": "in",
              "comment": "where to look for the variable"
            },
            {
              "name": "name",
              "type": "const char *",
              "direction": "in",
              "comment": "the variable's name"
            },
            {
              "name": "out",
              "type": "int *",
              "direction": "in",
              "comment": "pointer to the variable where the value should be stored"
            }
          ],
          "comment": [
            "Get the value of a boolean config variable.",
            "This function uses the usual C convention of 0 being false and\n anything else true."
          ],
          "group": "config"
        },
        "git_config_get_string": {
          "kind": "function",
          "name": "git_config_get_string",
          "location": {
            "file": "config.h",
            "line": 205,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "cfg",
              "type": "git_config *",
              "direction": "in",
              "comment": "where to look for the variable"
            },
            {
              "name": "name",
              "type": "const char *",
              "direction": "in",
              "comment": "the variable's name"
            },
            {
              "name": "out",
              "type": "const char **",
              "direction": "in",
              "comment": "pointer to the variable's value"
            }
          ],
          "comment": [
            "Get the value of a string config variable.",
            "The string is owned by the variable and should not be freed by the\n user."
          ],
          "group": "config"
        },
        "git_config_set_int32": {
          "kind": "function",
          "name": "git_config_set_int32",
          "location": {
            "file": "config.h",
            "line": 215,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "cfg",
              "type": "git_config *",
              "direction": "in",
              "comment": "where to look for the variable"
            },
            {
              "name": "name",
              "type": "const char *",
              "direction": "in",
              "comment": "the variable's name"
            },
            {
              "name": "value",
              "type": "int32_t",
              "direction": "in",
              "comment": "Integer value for the variable"
            }
          ],
          "comment": [
            "Set the value of an integer config variable."
          ],
          "group": "config"
        },
        "git_config_set_int64": {
          "kind": "function",
          "name": "git_config_set_int64",
          "location": {
            "file": "config.h",
            "line": 225,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "cfg",
              "type": "git_config *",
              "direction": "in",
              "comment": "where to look for the variable"
            },
            {
              "name": "name",
              "type": "const char *",
              "direction": "in",
              "comment": "the variable's name"
            },
            {
              "name": "value",
              "type": "int64_t",
              "direction": "in",
              "comment": "Long integer value for the variable"
            }
          ],
          "comment": [
            "Set the value of a long integer config variable."
          ],
          "group": "config"
        },
        "git_config_set_bool": {
          "kind": "function",
          "name": "git_config_set_bool",
          "location": {
            "file": "config.h",
            "line": 235,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "cfg",
              "type": "git_config *",
              "direction": "in",
              "comment": "where to look for the variable"
            },
            {
              "name": "name",
              "type": "const char *",
              "direction": "in",
              "comment": "the variable's name"
            },
            {
              "name": "value",
              "type": "int",
              "direction": "in",
              "comment": "the value to store"
            }
          ],
          "comment": [
            "Set the value of a boolean config variable."
          ],
          "group": "config"
        },
        "git_config_set_string": {
          "kind": "function",
          "name": "git_config_set_string",
          "location": {
            "file": "config.h",
            "line": 248,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "cfg",
              "type": "git_config *",
              "direction": "in",
              "comment": "where to look for the variable"
            },
            {
              "name": "name",
              "type": "const char *",
              "direction": "in",
              "comment": "the variable's name"
            },
            {
              "name": "value",
              "type": "const char *",
              "direction": "in",
              "comment": "the string to store."
            }
          ],
          "comment": [
            "Set the value of a string config variable.",
            "A copy of the string is made and the user is free to use it\n afterwards."
          ],
          "group": "config"
        },
        "git_config_delete": {
          "kind": "function",
          "name": "git_config_delete",
          "location": {
            "file": "config.h",
            "line": 256,
            "column": 17
          },
          "returns": {
            "type": "int"
          },
          "params": [
            {
              "name": "cfg",
              "type": "git_config *",
              "direction": "in",
              "comment": "the configuration"
            },
            {
              "name": "name",
              "type": "const char *",
              "direction": "in",
              "comment": "the variable to delete"
            }
          ],
          "comment": [
            "Delete a config variable"
          ],
          "group": "config"
        },
        "git_config_foreach": {
          "kind": "function",
          "name": "git_config_foreach",
          "location": {
            "file": "config.h",
            "line": 271,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or the return value of the callback which didn't return 0"
          },
          "params": [
            {
              "name": "cfg",
              "type": "git_config *",
              "direction": "in",
              "comment": "where to get the variables from"
            },
            {
              "name": "callback",
              "type": "int (*)(const char *, const char *, void *)",
              "direction": "in",
              "comment": "the function to call on each variable"
            },
            {
              "name": "payload",
              "type": "void *",
              "direction": "in",
              "comment": "the data to pass to the callback"
            }
          ],
          "comment": [
            "Perform an operation on each config variable.",
            "The callback receives the normalized name and value of each variable\n in the config backend, and the data pointer passed to this function.\n As soon as one of the callback functions returns something other than 0,\n this function returns that value."
          ],
          "group": "config"
        },
        "git_config": {
          "kind": "struct",
          "name": "git_config",
          "referenceName": "struct git_config",
          "opaque": true,
          "comment": [
            "Memory representation of a set of config files"
          ],
          "location": {
            "file": "types.h",
            "line": 123,
            "column": 27
          },
          "group": "config",
          "parameterTo": [
            "git_config_open_global",
            "git_config_new",
            "git_config_add_file",
            "git_config_add_file_ondisk",
            "git_config_open_ondisk",
            "git_config_free",
            "git_config_get_int32",
            "git_config_get_int64",
            "git_config_get_bool",
            "git_config_get_string",
            "git_config_set_int32",
            "git_config_set_int64",
            "git_config_set_bool",
            "git_config_set_string",
            "git_config_delete",
            "git_config_foreach",
            "git_repository_config",
            "git_repository_config_autoload"
          ]
        }
      },
      "info": {
        "summary": "Git config management routines"
      }
    },
    "errors": {
      "apis": {
        "git_error": {
          "kind": "enum",
          "name": "git_error",
          "referenceName": "git_error",
          "members": [
            {
              "name": "GIT_SUCCESS",
              "value": "0"
            },
            {
              "name": "GIT_ERROR",
              "value": "-1"
            },
            {
              "name": "GIT_ENOTOID",
              "value": "-2",
              "comment": [
                "Input was not a properly formatted Git object id."
              ]
            },
            {
              "name": "GIT_ENOTFOUND",
              "value": "-3",
              "comment": [
                "Input does not exist in the scope searched."
              ]
            },
            {
              "name": "GIT_ENOMEM",
              "value": "-4",
              "comment": [
                "Not enough space available."
              ]
            },
            {
              "name": "GIT_EOSERR",
              "value": "-5",
              "comment": [
                "Consult the OS error information."
              ]
            },
            {
              "name": "GIT_EOBJTYPE",
              "value": "-6",
              "comment": [
                "The specified object is of invalid type"
              ]
            },
            {
              "name": "GIT_ENOTAREPO",
              "value": "-7",
              "comment": [
                "The specified repository is invalid"
              ]
            },
            {
              "name": "GIT_EINVALIDTYPE",
              "value": "-8",
              "comment": [
                "The object type is invalid or doesn't match"
              ]
            },
            {
              "name": "GIT_EMISSINGOBJDATA",
              "value": "-9",
              "comment": [
                "The object cannot be written because it's missing internal data"
              ]
            },
            {
              "name": "GIT_EPACKCORRUPTED",
              "value": "-10",
              "comment": [
                "The packfile for the ODB is corrupted"
              ]
            },
            {
              "name": "GIT_EFLOCKFAIL",
              "value": "-11",
              "comment": [
                "Failed to acquire or release a file lock"
              ]
            },
            {
              "name": "GIT_EZLIB",
              "value": "-12",
              "comment": [
                "The Z library failed to inflate/deflate an object's data"
              ]
            },
            {
              "name": "GIT_EBUSY",
              "value": "-13",
              "comment": [
                "The queried object is currently busy"
              ]
            },
            {
              "name": "GIT_EBAREINDEX",
              "value": "-14",
              "comment": [
                "The index file is not backed up by an existing repository"
              ]
            },
            {
              "name": "GIT_EINVALIDREFNAME",
              "value": "-15",
              "comment": [
                "The name of the reference is not valid"
              ]
            },
            {
              "name": "GIT_EREFCORRUPTED",
              "value": "-16",
              "comment": [
                "The specified reference has its data corrupted"
              ]
            },
            {
              "name": "GIT_ETOONESTEDSYMREF",
              "value": "-17",
              "comment": [
                "The specified symbolic reference is too deeply nested"
              ]
            },
            {
              "name": "GIT_EPACKEDREFSCORRUPTED",
              "value": "-18",
              "comment": [
                "The pack-refs file is either corrupted or its format is not currently supported"
              ]
            },
            {
              "name": "GIT_EINVALIDPATH",
              "value": "-19",
              "comment": [
                "The path is invalid"
              ]
            },
            {
              "name": "GIT_EREVWALKOVER",
              "value": "-20",
              "comment": [
                "The revision walker is empty; there are no more commits left to iterate"
              ]
            },
            {
              "name": "GIT_EINVALIDREFSTATE",
              "value": "-21",
              "comment": [
                "The state of the reference is not valid"
              ]
            },
            {
              "name": "GIT_ENOTIMPLEMENTED",
              "value": "-22",
              "comment": [
                "This feature has not been implemented yet"
              ]
            },
            {
              "name": "GIT_EEXISTS",
              "value": "-23",
              "comment": [
                "A reference with this name already exists"
              ]
            },
            {
              "name": "GIT_EOVERFLOW",
              "value": "-24",
              "comment": [
                "The given integer literal is too large to be parsed"
              ]
            },
            {
              "name": "GIT_ENOTNUM",
              "value": "-25",
              "comment": [
                "The given literal is not a valid number"
              ]
            },
            {
              "name": "GIT_ESTREAM",
              "value": "-26",
              "comment": [
                "Streaming error"
              ]
            },
            {
              "name": "GIT_EINVALIDARGS",
              "value": "-27",
              "comment": [
                "invalid arguments to function"
              ]
            },
            {
              "name": "GIT_EOBJCORRUPTED",
              "value": "-28",
              "comment": [
                "The specified object has its data corrupted"
              ]
            },
            {
              "name": "GIT_EAMBIGUOUSOIDPREFIX",
              "value": "-29",
              "comment": [
                "The given short oid is ambiguous"
              ]
            },
            {
              "name": "GIT_EPASSTHROUGH",
              "value": "-30",
              "comment": [
                "Skip and passthrough the given ODB backend"
              ]
            },
            {
              "name": "GIT_ENOMATCH",
              "value": "-31",
              "comment": [
                "The path pattern and string did not match"
              ]
            },
            {
              "name": "GIT_ESHORTBUFFER",
              "value": "-32",
              "comment": [
                "The buffer is too short to satisfy the request"
              ]
            }
          ],
          "location": {
            "file": "errors.h",
            "line": 20,
            "column": 9
          },
          "group": "errors"
        },
        "git_lasterror": {
          "kind": "function",
          "name": "git_lasterror",
          "location": {
            "file": "errors.h",
            "line": 123,
            "column": 26
          },
          "returns": {
            "type": "const char *",
            "comment": "a string explaining the error"
          },
          "comment": [
            "Return a detailed error string with the latest error\n that occurred in the library."
          ],
          "group": "errors"
        },
        "git_strerror": {
          "kind": "function",
          "name": "git_strerror",
          "location": {
            "file": "errors.h",
            "line": 135,
            "column": 26
          },
          "returns": {
            "type": "const char *",
            "comment": "a string explaining the error code"
          },
          "params": [
            {
              "name": "num",
              "type": "int",
              "direction": "in",
              "comment": "The error code to explain"
            }
          ],
          "comment": [
            "strerror() for the Git library",
            "Get a string description for a given error code.\n NOTE: This method will be eventually deprecated in favor\n of the new `git_lasterror`."
          ],
          "group": "errors"
        },
        "git_clearerror": {
          "kind": "function",
          "name": "git_clearerror",
          "location": {
            "file": "errors.h",
            "line": 140,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "comment": [
            "Clear the latest library error"
          ],
          "group": "errors"
        }
      },
      "info": {
        "summary": "Git error handling routines and variables"
      }
    },
    "index": {
      "apis": {
        "GIT_IDXENTRY_NAMEMASK": {
          "kind": "macro",
          "name": "GIT_IDXENTRY_NAMEMASK",
          "location": {
            "file": "index.h",
            "line": 23,
            "column": 9
          },
          "value": "(0x0fff)",
          "comment": "",
          "group": "index"
        },
        "GIT_IDXENTRY_STAGEMASK": {
          "kind": "macro",
          "name": "GIT_IDXENTRY_STAGEMASK",
          "location": {
            "file": "index.h",
            "line": 24,
            "column": 9
          },
          "value": "(0x3000)",
          "comment": "",
          "group": "index"
        },
        "GIT_IDXENTRY_EXTENDED": {
          "kind": "macro",
          "name": "GIT_IDXENTRY_EXTENDED",
          "location": {
            "file": "index.h",
            "line": 25,
            "column": 9
          },
          "value": "(0x4000)",
          "comment": "",
          "group": "index"
        },
        "GIT_IDXENTRY_VALID": {
          "kind": "macro",
          "name": "GIT_IDXENTRY_VALID",
          "location": {
            "file": "index.h",
            "line": 26,
            "column": 9
          },
          "value": "(0x8000)",
          "comment": "",
          "group": "index"
        },
        "GIT_IDXENTRY_STAGESHIFT": {
          "kind": "macro",
          "name": "GIT_IDXENTRY_STAGESHIFT",
          "location": {
            "file": "index.h",
            "line": 27,
            "column": 9
          },
          "value": "12",
          "comment": "",
          "group": "index"
        },
        "GIT_IDXENTRY_UPDATE": {
          "kind": "macro",
          "name": "GIT_IDXENTRY_UPDATE",
          "location": {
            "file": "index.h",
            "line": 36,
            "column": 9
          },
          "value": "(1 << 0)",
          "comment": "",
          "group": "index"
        },
        "GIT_IDXENTRY_REMOVE": {
          "kind": "macro",
          "name": "GIT_IDXENTRY_REMOVE",
          "location": {
            "file": "index.h",
            "line": 37,
            "column": 9
          },
          "value": "(1 << 1)",
          "comment": "",
          "group": "index"
        },
        "GIT_IDXENTRY_UPTODATE": {
          "kind": "macro",
          "name": "GIT_IDXENTRY_UPTODATE",
          "location": {
            "file": "index.h",
            "line": 38,
            "column": 9
          },
          "value": "(1 << 2)",
          "comment": "",
          "group": "index"
        },
        "GIT_IDXENTRY_ADDED": {
          "kind": "macro",
          "name": "GIT_IDXENTRY_ADDED",
          "location": {
            "file": "index.h",
            "line": 39,
            "column": 9
          },
          "value": "(1 << 3)",
          "comment": "",
          "group": "index"
        },
        "GIT_IDXENTRY_HASHED": {
          "kind": "macro",
          "name": "GIT_IDXENTRY_HASHED",
          "location": {
            "file": "index.h",
            "line": 41,
            "column": 9
          },
          "value": "(1 << 4)",
          "comment": "",
          "group": "index"
        },
        "GIT_IDXENTRY_UNHASHED": {
          "kind": "macro",
          "name": "GIT_IDXENTRY_UNHASHED",
          "location": {
            "file": "index.h",
            "line": 42,
            "column": 9
          },
          "value": "(1 << 5)",
          "comment": "",
          "group": "index"
        },
        "GIT_IDXENTRY_WT_REMOVE": {
          "kind": "macro",
          "name": "GIT_IDXENTRY_WT_REMOVE",
          "location": {
            "file": "index.h",
            "line": 43,
            "column": 9
          },
          "value": "(1 << 6) /* remove in work directory */",
          "comment": "",
          "group": "index"
        },
        "GIT_IDXENTRY_CONFLICTED": {
          "kind": "macro",
          "name": "GIT_IDXENTRY_CONFLICTED",
          "location": {
            "file": "index.h",
            "line": 44,
            "column": 9
          },
          "value": "(1 << 7)",
          "comment": "",
          "group": "index"
        },
        "GIT_IDXENTRY_UNPACKED": {
          "kind": "macro",
          "name": "GIT_IDXENTRY_UNPACKED",
          "location": {
            "file": "index.h",
            "line": 46,
            "column": 9
          },
          "value": "(1 << 8)",
          "comment": "",
          "group": "index"
        },
        "GIT_IDXENTRY_NEW_SKIP_WORKTREE": {
          "kind": "macro",
          "name": "GIT_IDXENTRY_NEW_SKIP_WORKTREE",
          "location": {
            "file": "index.h",
            "line": 47,
            "column": 9
          },
          "value": "(1 << 9)",
          "comment": "",
          "group": "index"
        },
        "GIT_IDXENTRY_INTENT_TO_ADD": {
          "kind": "macro",
          "name": "GIT_IDXENTRY_INTENT_TO_ADD",
          "location": {
            "file": "index.h",
            "line": 52,
            "column": 9
          },
          "value": "(1 << 13)",
          "comment": "",
          "group": "index"
        },
        "GIT_IDXENTRY_SKIP_WORKTREE": {
          "kind": "macro",
          "name": "GIT_IDXENTRY_SKIP_WORKTREE",
          "location": {
            "file": "index.h",
            "line": 53,
            "column": 9
          },
          "value": "(1 << 14)",
          "comment": "",
          "group": "index"
        },
        "GIT_IDXENTRY_EXTENDED2": {
          "kind": "macro",
          "name": "GIT_IDXENTRY_EXTENDED2",
          "location": {
            "file": "index.h",
            "line": 55,
            "column": 9
          },
          "value": "(1 << 15)",
          "comment": "",
          "group": "index"
        },
        "GIT_IDXENTRY_EXTENDED_FLAGS": {
          "kind": "macro",
          "name": "GIT_IDXENTRY_EXTENDED_FLAGS",
          "location": {
            "file": "index.h",
            "line": 57,
            "column": 9
          },
          "value": "(GIT_IDXENTRY_INTENT_TO_ADD | GIT_IDXENTRY_SKIP_WORKTREE)",
          "comment": "",
          "group": "index"
        },
        "git_index_time": {
          "kind": "struct",
          "name": "git_index_time",
          "referenceName": "git_index_time",
          "comment": [
            "Time used in a git index entry"
          ],
          "members": [
            {
              "name": "seconds",
              "type": "git_time_t",
              "referenceType": "int64_t"
            },
            {
              "name": "nanoseconds",
              "type": "unsigned int"
            }
          ],
          "location": {
            "file": "index.h",
            "line": 60,
            "column": 9
          },
          "group": "index"
        },
        "git_index_entry": {
          "kind": "struct",
          "name": "git_index_entry",
          "referenceName": "git_index_entry",
          "comment": [
            "Memory representation of a file entry in the index."
          ],
          "members": [
            {
              "name": "ctime",
              "type": "git_index_time",
              "referenceType": "struct git_index_time"
            },
            {
              "name": "mtime",
              "type": "git_index_time",
              "referenceType": "struct git_index_time"
            },
            {
              "name": "dev",
              "type": "unsigned int"
            },
            {
              "name": "ino",
              "type": "unsigned int"
            },
            {
              "name": "mode",
              "type": "unsigned int"
            },
            {
              "name": "uid",
              "type": "unsigned int"
            },
            {
              "name": "gid",
              "type": "unsigned int"
            },
            {
              "name": "file_size",
              "type": "git_off_t",
              "referenceType": "int64_t"
            },
            {
              "name": "oid",
              "type": "git_oid",
              "referenceType": "struct _git_oid"
            },
            {
              "name": "flags",
              "type": "unsigned short"
            },
            {
              "name": "flags_extended",
              "type": "unsigned short"
            },
            {
              "name": "path",
              "type": "char *"
            }
          ],
          "location": {
            "file": "index.h",
            "line": 67,
            "column": 16
          },
          "group": "index",
          "returnedBy": [
            "git_index_get"
          ],
          "parameterTo": [
            "git_index_add2",
            "git_index_append2",
            "git_index_entry_stage"
          ]
        },
        "git_index_entry_unmerged": {
          "kind": "struct",
          "name": "git_index_entry_unmerged",
          "referenceName": "git_index_entry_unmerged",
          "comment": [
            "Representation of an unmerged file entry in the index."
          ],
          "members": [
            {
              "name": "mode",
              "type": "unsigned int[3]"
            },
            {
              "name": "oid",
              "type": "git_oid[3]"
            },
            {
              "name": "path",
              "type": "char *"
            }
          ],
          "location": {
            "file": "index.h",
            "line": 87,
            "column": 16
          },
          "group": "index",
          "returnedBy": [
            "git_index_get_unmerged_bypath",
            "git_index_get_unmerged_byindex"
          ]
        },
        "git_index_open": {
          "kind": "function",
          "name": "git_index_open",
          "location": {
            "file": "index.h",
            "line": 111,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "index",
              "type": "git_index **",
              "direction": "in",
              "comment": "the pointer for the new index"
            },
            {
              "name": "index_path",
              "type": "const char *",
              "direction": "in",
              "comment": "the path to the index file in disk"
            }
          ],
          "comment": [
            "Create a new bare Git index object as a memory representation\n of the Git index file in 'index_path', without a repository\n to back it.",
            "Since there is no ODB or working directory behind this index,\n any Index methods which rely on these (e.g. index_add) will\n fail with the GIT_EBAREINDEX error code.",
            "If you need to access the index of an actual repository,\n use the `git_repository_index` wrapper.",
            "The index must be freed once it's no longer in use."
          ],
          "group": "index"
        },
        "git_index_clear": {
          "kind": "function",
          "name": "git_index_clear",
          "location": {
            "file": "index.h",
            "line": 120,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "index",
              "type": "git_index *",
              "direction": "in",
              "comment": "an existing index object"
            }
          ],
          "comment": [
            "Clear the contents (all the entries) of an index object.\n This clears the index object in memory; changes must be manually\n written to disk for them to take effect."
          ],
          "group": "index"
        },
        "git_index_free": {
          "kind": "function",
          "name": "git_index_free",
          "location": {
            "file": "index.h",
            "line": 127,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "index",
              "type": "git_index *",
              "direction": "in",
              "comment": "an existing index object"
            }
          ],
          "comment": [
            "Free an existing index object."
          ],
          "group": "index"
        },
        "git_index_read": {
          "kind": "function",
          "name": "git_index_read",
          "location": {
            "file": "index.h",
            "line": 136,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "index",
              "type": "git_index *",
              "direction": "in",
              "comment": "an existing index object"
            }
          ],
          "comment": [
            "Update the contents of an existing index object in memory\n by reading from the hard disk."
          ],
          "group": "index"
        },
        "git_index_write": {
          "kind": "function",
          "name": "git_index_write",
          "location": {
            "file": "index.h",
            "line": 145,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "index",
              "type": "git_index *",
              "direction": "in",
              "comment": "an existing index object"
            }
          ],
          "comment": [
            "Write an existing index object from memory back to disk\n using an atomic file lock."
          ],
          "group": "index"
        },
        "git_index_find": {
          "kind": "function",
          "name": "git_index_find",
          "location": {
            "file": "index.h",
            "line": 155,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "an index >= 0 if found, -1 otherwise"
          },
          "params": [
            {
              "name": "index",
              "type": "git_index *",
              "direction": "in",
              "comment": "an existing index object"
            },
            {
              "name": "path",
              "type": "const char *",
              "direction": "in",
              "comment": "path to search"
            }
          ],
          "comment": [
            "Find the first index of any entries which point to given\n path in the Git index."
          ],
          "group": "index"
        },
        "git_index_uniq": {
          "kind": "function",
          "name": "git_index_uniq",
          "location": {
            "file": "index.h",
            "line": 162,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "index",
              "type": "git_index *",
              "direction": "in",
              "comment": "an existing index object"
            }
          ],
          "comment": [
            "Remove all entries with equal path except last added"
          ],
          "group": "index"
        },
        "git_index_add": {
          "kind": "function",
          "name": "git_index_add",
          "location": {
            "file": "index.h",
            "line": 177,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "index",
              "type": "git_index *",
              "direction": "in",
              "comment": "an existing index object"
            },
            {
              "name": "path",
              "type": "const char *",
              "direction": "in",
              "comment": "filename to add"
            },
            {
              "name": "stage",
              "type": "int",
              "direction": "in",
              "comment": "stage for the entry"
            }
          ],
          "comment": [
            "Add or update an index entry from a file in disk",
            "The file `path` must be relative to the repository's\n working folder and must be readable.",
            "This method will fail in bare index instances."
          ],
          "group": "index"
        },
        "git_index_add2": {
          "kind": "function",
          "name": "git_index_add2",
          "location": {
            "file": "index.h",
            "line": 189,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "index",
              "type": "git_index *",
              "direction": "in",
              "comment": "an existing index object"
            },
            {
              "name": "source_entry",
              "type": "const git_index_entry *",
              "direction": "in",
              "comment": "new entry object"
            }
          ],
          "comment": [
            "Add or update an index entry from an in-memory struct",
            "A full copy (including the 'path' string) of the given\n 'source_entry' will be inserted on the index."
          ],
          "group": "index"
        },
        "git_index_append": {
          "kind": "function",
          "name": "git_index_append",
          "location": {
            "file": "index.h",
            "line": 208,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "index",
              "type": "git_index *",
              "direction": "in",
              "comment": "an existing index object"
            },
            {
              "name": "path",
              "type": "const char *",
              "direction": "in",
              "comment": "filename to add"
            },
            {
              "name": "stage",
              "type": "int",
              "direction": "in",
              "comment": "stage for the entry"
            }
          ],
          "comment": [
            "Add (append) an index entry from a file in disk",
            "A new entry will always be inserted into the index;\n if the index already contains an entry for such\n path, the old entry will **not** be replaced.",
            "The file `path` must be relative to the repository's\n working folder and must be readable.",
            "This method will fail in bare index instances."
          ],
          "group": "index"
        },
        "git_index_append2": {
          "kind": "function",
          "name": "git_index_append2",
          "location": {
            "file": "index.h",
            "line": 225,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "index",
              "type": "git_index *",
              "direction": "in",
              "comment": "an existing index object"
            },
            {
              "name": "source_entry",
              "type": "const git_index_entry *",
              "direction": "in",
              "comment": "new entry object"
            }
          ],
          "comment": [
            "Add (append) an index entry from an in-memory struct",
            "A new entry will always be inserted into the index;\n if the index already contains an entry for the path\n in the `entry` struct, the old entry will **not** be\n replaced.",
            "A full copy (including the 'path' string) of the given\n 'source_entry' will be inserted on the index."
          ],
          "group": "index"
        },
        "git_index_remove": {
          "kind": "function",
          "name": "git_index_remove",
          "location": {
            "file": "index.h",
            "line": 234,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "index",
              "type": "git_index *",
              "direction": "in",
              "comment": "an existing index object"
            },
            {
              "name": "position",
              "type": "int",
              "direction": "in",
              "comment": "position of the entry to remove"
            }
          ],
          "comment": [
            "Remove an entry from the index"
          ],
          "group": "index"
        },
        "git_index_get": {
          "kind": "function",
          "name": "git_index_get",
          "location": {
            "file": "index.h",
            "line": 249,
            "column": 31
          },
          "returns": {
            "type": "git_index_entry *",
            "comment": "a pointer to the entry; NULL if out of bounds"
          },
          "params": [
            {
              "name": "index",
              "type": "git_index *",
              "direction": "in",
              "comment": "an existing index object"
            },
            {
              "name": "n",
              "type": "unsigned int",
              "direction": "in",
              "comment": "the position of the entry"
            }
          ],
          "comment": [
            "Get a pointer to one of the entries in the index",
            "This entry can be modified, and the changes will be written\n back to disk on the next write() call.",
            "The entry should not be freed by the caller."
          ],
          "group": "index"
        },
        "git_index_entrycount": {
          "kind": "function",
          "name": "git_index_entrycount",
          "location": {
            "file": "index.h",
            "line": 257,
            "column": 26
          },
          "returns": {
            "type": "unsigned int",
            "comment": "integer of count of current entries"
          },
          "params": [
            {
              "name": "index",
              "type": "git_index *",
              "direction": "in",
              "comment": "an existing index object"
            }
          ],
          "comment": [
            "Get the count of entries currently in the index"
          ],
          "group": "index"
        },
        "git_index_entrycount_unmerged": {
          "kind": "function",
          "name": "git_index_entrycount_unmerged",
          "location": {
            "file": "index.h",
            "line": 265,
            "column": 26
          },
          "returns": {
            "type": "unsigned int",
            "comment": "integer of count of current unmerged entries"
          },
          "params": [
            {
              "name": "index",
              "type": "git_index *",
              "direction": "in",
              "comment": "an existing index object"
            }
          ],
          "comment": [
            "Get the count of unmerged entries currently in the index"
          ],
          "group": "index"
        },
        "git_index_get_unmerged_bypath": {
          "kind": "function",
          "name": "git_index_get_unmerged_bypath",
          "location": {
            "file": "index.h",
            "line": 277,
            "column": 46
          },
          "returns": {
            "type": "const git_index_entry_unmerged *",
            "comment": "the unmerged entry; NULL if not found"
          },
          "params": [
            {
              "name": "index",
              "type": "git_index *",
              "direction": "in",
              "comment": "an existing index object"
            },
            {
              "name": "path",
              "type": "const char *",
              "direction": "in",
              "comment": "path to search"
            }
          ],
          "comment": [
            "Get an unmerged entry from the index.",
            "The returned entry is read-only and should not be modified\n of freed by the caller."
          ],
          "group": "index"
        },
        "git_index_get_unmerged_byindex": {
          "kind": "function",
          "name": "git_index_get_unmerged_byindex",
          "location": {
            "file": "index.h",
            "line": 289,
            "column": 46
          },
          "returns": {
            "type": "const git_index_entry_unmerged *",
            "comment": "a pointer to the unmerged entry; NULL if out of bounds"
          },
          "params": [
            {
              "name": "index",
              "type": "git_index *",
              "direction": "in",
              "comment": "an existing index object"
            },
            {
              "name": "n",
              "type": "unsigned int",
              "direction": "in",
              "comment": "the position of the entry"
            }
          ],
          "comment": [
            "Get an unmerged entry from the index.",
            "The returned entry is read-only and should not be modified\n of freed by the caller."
          ],
          "group": "index"
        },
        "git_index_entry_stage": {
          "kind": "function",
          "name": "git_index_entry_stage",
          "location": {
            "file": "index.h",
            "line": 302,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "the stage number"
          },
          "params": [
            {
              "name": "entry",
              "type": "const git_index_entry *",
              "direction": "in",
              "comment": "The entry"
            }
          ],
          "comment": [
            "Return the stage number from a git index entry",
            "This entry is calculated from the entrie's flag\n attribute like this:",
            "(entry->flags \n&\n GIT_IDXENTRY_STAGEMASK) >> GIT_IDXENTRY_STAGESHIFT"
          ],
          "group": "index"
        },
        "git_index": {
          "kind": "struct",
          "name": "git_index",
          "referenceName": "struct git_index",
          "opaque": true,
          "comment": [
            "Memory representation of an index file."
          ],
          "location": {
            "file": "types.h",
            "line": 120,
            "column": 26
          },
          "group": "index",
          "parameterTo": [
            "git_index_open",
            "git_index_clear",
            "git_index_free",
            "git_index_read",
            "git_index_write",
            "git_index_find",
            "git_index_uniq",
            "git_index_add",
            "git_index_add2",
            "git_index_append",
            "git_index_append2",
            "git_index_remove",
            "git_index_get",
            "git_index_entrycount",
            "git_index_entrycount_unmerged",
            "git_index_get_unmerged_bypath",
            "git_index_get_unmerged_byindex",
            "git_repository_index",
            "git_tree_create_fromindex"
          ]
        }
      },
      "info": {
        "summary": "Git index parsing and manipulation routines"
      }
    },
    "indexer": {
      "apis": {
        "git_indexer_stats": {
          "kind": "struct",
          "name": "git_indexer_stats",
          "referenceName": "git_indexer_stats",
          "comment": [
            "This is passed as the first argument to the callback to allow the\n user to see the progress."
          ],
          "members": [
            {
              "name": "total",
              "type": "unsigned int"
            },
            {
              "name": "processed",
              "type": "unsigned int"
            }
          ],
          "location": {
            "file": "indexer.h",
            "line": 19,
            "column": 16
          },
          "group": "indexer",
          "parameterTo": [
            "git_indexer_run"
          ]
        },
        "git_indexer": {
          "kind": "struct",
          "name": "git_indexer",
          "referenceName": "struct git_indexer",
          "opaque": true,
          "location": {
            "file": "indexer.h",
            "line": 25,
            "column": 28
          },
          "group": "indexer",
          "parameterTo": [
            "git_indexer_new",
            "git_indexer_run",
            "git_indexer_write",
            "git_indexer_hash",
            "git_indexer_free"
          ]
        },
        "git_indexer_new": {
          "kind": "function",
          "name": "git_indexer_new",
          "location": {
            "file": "indexer.h",
            "line": 33,
            "column": 17
          },
          "returns": {
            "type": "int"
          },
          "params": [
            {
              "name": "out",
              "type": "git_indexer **",
              "direction": "in",
              "comment": "where to store the indexer instance"
            },
            {
              "name": "packname",
              "type": "const char *",
              "direction": "in",
              "comment": "the absolute filename of the packfile to index"
            }
          ],
          "comment": [
            "Create a new indexer instance"
          ],
          "group": "indexer"
        },
        "git_indexer_run": {
          "kind": "function",
          "name": "git_indexer_run",
          "location": {
            "file": "indexer.h",
            "line": 45,
            "column": 17
          },
          "returns": {
            "type": "int"
          },
          "params": [
            {
              "name": "idx",
              "type": "git_indexer *",
              "direction": "in",
              "comment": "the indexer instance"
            },
            {
              "name": "stats",
              "type": "git_indexer_stats *",
              "direction": "in",
              "comment": "storage for the running state"
            }
          ],
          "comment": [
            "Iterate over the objects in the packfile and extract the information",
            "Indexing a packfile can be very expensive so this function is\n expected to be run in a worker thread and the stats used to provide\n feedback the user."
          ],
          "group": "indexer"
        },
        "git_indexer_write": {
          "kind": "function",
          "name": "git_indexer_write",
          "location": {
            "file": "indexer.h",
            "line": 55,
            "column": 17
          },
          "returns": {
            "type": "int"
          },
          "params": [
            {
              "name": "idx",
              "type": "git_indexer *",
              "direction": "in",
              "comment": "the indexer instance"
            }
          ],
          "comment": [
            "Write the index file to disk.",
            "The file will be stored as pack-$hash.idx in the same directory as\n the packfile."
          ],
          "group": "indexer"
        },
        "git_indexer_hash": {
          "kind": "function",
          "name": "git_indexer_hash",
          "location": {
            "file": "indexer.h",
            "line": 65,
            "column": 29
          },
          "returns": {
            "type": "const git_oid *"
          },
          "params": [
            {
              "name": "idx",
              "type": "git_indexer *",
              "direction": "in",
              "comment": "the indexer instance"
            }
          ],
          "comment": [
            "Get the packfile's hash",
            "A packfile's name is derived from the sorted hashing of all object\n names. This is only correct after the index has been written to disk."
          ],
          "group": "indexer"
        },
        "git_indexer_free": {
          "kind": "function",
          "name": "git_indexer_free",
          "location": {
            "file": "indexer.h",
            "line": 72,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "idx",
              "type": "git_indexer *",
              "direction": "in",
              "comment": "the indexer to free"
            }
          ],
          "comment": [
            "Free the indexer and its resources"
          ],
          "group": "indexer"
        }
      },
      "info": {}
    },
    "net": {
      "apis": {
        "GIT_DEFAULT_PORT": {
          "kind": "macro",
          "name": "GIT_DEFAULT_PORT",
          "location": {
            "file": "net.h",
            "line": 22,
            "column": 9
          },
          "value": "\"9418\"",
          "comment": "",
          "group": "net"
        },
        "GIT_DIR_FETCH": {
          "kind": "macro",
          "name": "GIT_DIR_FETCH",
          "location": {
            "file": "net.h",
            "line": 30,
            "column": 9
          },
          "value": "0",
          "comment": "",
          "group": "net"
        },
        "GIT_DIR_PUSH": {
          "kind": "macro",
          "name": "GIT_DIR_PUSH",
          "location": {
            "file": "net.h",
            "line": 31,
            "column": 9
          },
          "value": "1",
          "comment": "",
          "group": "net"
        },
        "git_remote_head": {
          "kind": "struct",
          "name": "git_remote_head",
          "referenceName": "struct git_remote_head",
          "comment": [
            "Remote head description, given out on `ls` calls."
          ],
          "members": [
            {
              "name": "local",
              "type": "int"
            },
            {
              "name": "oid",
              "type": "git_oid",
              "referenceType": "struct _git_oid"
            },
            {
              "name": "loid",
              "type": "git_oid",
              "referenceType": "struct _git_oid"
            },
            {
              "name": "name",
              "type": "char *"
            }
          ],
          "location": {
            "file": "net.h",
            "line": 36,
            "column": 8
          },
          "group": "net"
        },
        "git_headarray": {
          "kind": "struct",
          "name": "git_headarray",
          "referenceName": "struct git_headarray",
          "comment": [
            "Array of remote heads"
          ],
          "members": [
            {
              "name": "len",
              "type": "unsigned int"
            },
            {
              "name": "heads",
              "type": "struct git_remote_head **"
            }
          ],
          "location": {
            "file": "net.h",
            "line": 46,
            "column": 8
          },
          "group": "net",
          "parameterTo": [
            "git_remote_ls"
          ]
        }
      },
      "info": {
        "summary": "Git networking declarations"
      }
    },
    "object": {
      "apis": {
        "git_object_lookup": {
          "kind": "function",
          "name": "git_object_lookup",
          "location": {
            "file": "object.h",
            "line": 41,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "a reference to the object"
          },
          "params": [
            {
              "name": "object",
              "type": "git_object **",
              "direction": "in",
              "comment": "pointer to the looked-up object"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "the repository to look up the object"
            },
            {
              "name": "id",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "the unique identifier for the object"
            },
            {
              "name": "type",
              "type": "git_otype",
              "direction": "in",
              "comment": "the type of the object",
              "referenceType": "enum git_otype"
            }
          ],
          "comment": [
            "Lookup a reference to one of the objects in a repostory.",
            "The generated reference is owned by the repository and\n should be closed with the `git_object_close` method\n instead of free'd manually.",
            "The 'type' parameter must match the type of the object\n in the odb; the method will fail otherwise.\n The special value 'GIT_OBJ_ANY' may be passed to let\n the method guess the object's type."
          ],
          "group": "object"
        },
        "git_object_lookup_prefix": {
          "kind": "function",
          "name": "git_object_lookup_prefix",
          "location": {
            "file": "object.h",
            "line": 74,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "object_out",
              "type": "git_object **",
              "direction": "in",
              "comment": "pointer where to store the looked-up object"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "the repository to look up the object"
            },
            {
              "name": "id",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "a short identifier for the object"
            },
            {
              "name": "len",
              "type": "unsigned int",
              "direction": "in",
              "comment": "the length of the short identifier"
            },
            {
              "name": "type",
              "type": "git_otype",
              "direction": "in",
              "comment": "the type of the object",
              "referenceType": "enum git_otype"
            }
          ],
          "comment": [
            "Lookup a reference to one of the objects in a repostory,\n given a prefix of its identifier (short id).",
            "The object obtained will be so that its identifier\n matches the first 'len' hexadecimal characters\n (packets of 4 bits) of the given 'id'.\n 'len' must be at least GIT_OID_MINPREFIXLEN, and\n long enough to identify a unique object matching\n the prefix; otherwise the method will fail.",
            "The generated reference is owned by the repository and\n should be closed with the `git_object_close` method\n instead of free'd manually.",
            "The 'type' parameter must match the type of the object\n in the odb; the method will fail otherwise.\n The special value 'GIT_OBJ_ANY' may be passed to let\n the method guess the object's type."
          ],
          "group": "object"
        },
        "git_object_id": {
          "kind": "function",
          "name": "git_object_id",
          "location": {
            "file": "object.h",
            "line": 87,
            "column": 29
          },
          "returns": {
            "type": "const git_oid *",
            "comment": "the SHA1 id"
          },
          "params": [
            {
              "name": "obj",
              "type": "const git_object *",
              "direction": "in",
              "comment": "the repository object"
            }
          ],
          "comment": [
            "Get the id (SHA1) of a repository object"
          ],
          "group": "object"
        },
        "git_object_type": {
          "kind": "function",
          "name": "git_object_type",
          "location": {
            "file": "object.h",
            "line": 95,
            "column": 23
          },
          "returns": {
            "type": "git_otype",
            "comment": "the object's type"
          },
          "params": [
            {
              "name": "obj",
              "type": "const git_object *",
              "direction": "in",
              "comment": "the repository object"
            }
          ],
          "comment": [
            "Get the object type of an object"
          ],
          "group": "object"
        },
        "git_object_owner": {
          "kind": "function",
          "name": "git_object_owner",
          "location": {
            "file": "object.h",
            "line": 109,
            "column": 30
          },
          "returns": {
            "type": "git_repository *",
            "comment": "the repository who owns this object"
          },
          "params": [
            {
              "name": "obj",
              "type": "const git_object *",
              "direction": "in",
              "comment": "the object"
            }
          ],
          "comment": [
            "Get the repository that owns this object",
            "Freeing or calling `git_repository_close` on the\n returned pointer will invalidate the actual object.",
            "Any other operation may be run on the repository without\n affecting the object."
          ],
          "group": "object"
        },
        "git_object_close": {
          "kind": "function",
          "name": "git_object_close",
          "location": {
            "file": "object.h",
            "line": 126,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "object",
              "type": "git_object *",
              "direction": "in",
              "comment": "the object to close"
            }
          ],
          "comment": [
            "Close an open object",
            "This method instructs the library to close an existing\n object; note that git_objects are owned and cached by the repository\n so the object may or may not be freed after this library call,\n depending on how agressive is the caching mechanism used\n by the repository.",
            "IMPORTANT:\n It *is* necessary to call this method when you stop using\n an object. Failure to do so will cause a memory leak."
          ],
          "group": "object"
        },
        "git_object_type2string": {
          "kind": "function",
          "name": "git_object_type2string",
          "location": {
            "file": "object.h",
            "line": 137,
            "column": 26
          },
          "returns": {
            "type": "const char *",
            "comment": "the corresponding string representation."
          },
          "params": [
            {
              "name": "type",
              "type": "git_otype",
              "direction": "in",
              "comment": "object type to convert.",
              "referenceType": "enum git_otype"
            }
          ],
          "comment": [
            "Convert an object type to it's string representation.",
            "The result is a pointer to a string in static memory and\n should not be free()'ed."
          ],
          "group": "object"
        },
        "git_object_string2type": {
          "kind": "function",
          "name": "git_object_string2type",
          "location": {
            "file": "object.h",
            "line": 145,
            "column": 23
          },
          "returns": {
            "type": "git_otype",
            "comment": "the corresponding git_otype."
          },
          "params": [
            {
              "name": "str",
              "type": "const char *",
              "direction": "in",
              "comment": "the string to convert."
            }
          ],
          "comment": [
            "Convert a string object type representation to it's git_otype."
          ],
          "group": "object"
        },
        "git_object_typeisloose": {
          "kind": "function",
          "name": "git_object_typeisloose",
          "location": {
            "file": "object.h",
            "line": 154,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "true if the type represents a valid loose object type,\n false otherwise."
          },
          "params": [
            {
              "name": "type",
              "type": "git_otype",
              "direction": "in",
              "comment": "object type to test.",
              "referenceType": "enum git_otype"
            }
          ],
          "comment": [
            "Determine if the given git_otype is a valid loose object type."
          ],
          "group": "object"
        },
        "git_object__size": {
          "kind": "function",
          "name": "git_object__size",
          "location": {
            "file": "object.h",
            "line": 168,
            "column": 20
          },
          "returns": {
            "type": "size_t",
            "comment": "size in bytes of the object"
          },
          "params": [
            {
              "name": "type",
              "type": "git_otype",
              "direction": "in",
              "comment": "object type to get its size",
              "referenceType": "enum git_otype"
            }
          ],
          "comment": [
            "Get the size in bytes for the structure which\n acts as an in-memory representation of any given\n object type.",
            "For all the core types, this would the equivalent\n of calling `sizeof(git_commit)` if the core types\n were not opaque on the external API."
          ],
          "group": "object"
        },
        "git_object": {
          "kind": "struct",
          "name": "git_object",
          "referenceName": "struct git_object",
          "opaque": true,
          "comment": [
            "Representation of a generic object in a repository"
          ],
          "location": {
            "file": "types.h",
            "line": 96,
            "column": 27
          },
          "group": "object",
          "parameterTo": [
            "git_object_lookup",
            "git_object_lookup_prefix",
            "git_object_id",
            "git_object_type",
            "git_object_owner",
            "git_object_close",
            "git_tag_target",
            "git_tag_create",
            "git_tag_create_lightweight",
            "git_tree_entry_2object"
          ]
        }
      },
      "info": {
        "summary": "Git revision object management routines"
      }
    },
    "odb": {
      "apis": {
        "git_odb_new": {
          "kind": "function",
          "name": "git_odb_new",
          "location": {
            "file": "odb.h",
            "line": 34,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "out",
              "type": "git_odb **",
              "direction": "in",
              "comment": "location to store the database pointer, if opened.\n\t\t\tSet to NULL if the open failed."
            }
          ],
          "comment": [
            "Create a new object database with no backends.",
            "Before the ODB can be used for read/writing, a custom database\n backend must be manually added using `git_odb_add_backend()`"
          ],
          "group": "odb"
        },
        "git_odb_open": {
          "kind": "function",
          "name": "git_odb_open",
          "location": {
            "file": "odb.h",
            "line": 52,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "out",
              "type": "git_odb **",
              "direction": "in",
              "comment": "location to store the database pointer, if opened.\n\t\t\tSet to NULL if the open failed."
            },
            {
              "name": "objects_dir",
              "type": "const char *",
              "direction": "in",
              "comment": "path of the backends' \"objects\" directory."
            }
          ],
          "comment": [
            "Create a new object database and automatically add\n the two default backends:",
            "- git_odb_backend_loose: read and write loose object files\n\t\tfrom disk, assuming `objects_dir` as the Objects folder",
            "- git_odb_backend_pack: read objects from packfiles,\n\t\tassuming `objects_dir` as the Objects folder which\n\t\tcontains a 'pack/' folder with the corresponding data"
          ],
          "group": "odb"
        },
        "git_odb_add_backend": {
          "kind": "function",
          "name": "git_odb_add_backend",
          "location": {
            "file": "odb.h",
            "line": 67,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "0 on sucess; error code otherwise"
          },
          "params": [
            {
              "name": "odb",
              "type": "git_odb *",
              "direction": "in",
              "comment": "database to add the backend to"
            },
            {
              "name": "backend",
              "type": "git_odb_backend *",
              "direction": "in",
              "comment": "pointer to a git_odb_backend instance"
            },
            {
              "name": "priority",
              "type": "int",
              "direction": "in",
              "comment": "Value for ordering the backends queue"
            }
          ],
          "comment": [
            "Add a custom backend to an existing Object DB",
            "The backends are checked in relative ordering, based on the\n value of the `priority` parameter.",
            "Read \n<odb\n_backends.h> for more information."
          ],
          "group": "odb"
        },
        "git_odb_add_alternate": {
          "kind": "function",
          "name": "git_odb_add_alternate",
          "location": {
            "file": "odb.h",
            "line": 88,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "0 on sucess; error code otherwise"
          },
          "params": [
            {
              "name": "odb",
              "type": "git_odb *",
              "direction": "in",
              "comment": "database to add the backend to"
            },
            {
              "name": "backend",
              "type": "git_odb_backend *",
              "direction": "in",
              "comment": "pointer to a git_odb_backend instance"
            },
            {
              "name": "priority",
              "type": "int",
              "direction": "in",
              "comment": "Value for ordering the backends queue"
            }
          ],
          "comment": [
            "Add a custom backend to an existing Object DB; this\n backend will work as an alternate.",
            "Alternate backends are always checked for objects *after*\n all the main backends have been exhausted.",
            "The backends are checked in relative ordering, based on the\n value of the `priority` parameter.",
            "Writing is disabled on alternate backends.",
            "Read \n<odb\n_backends.h> for more information."
          ],
          "group": "odb"
        },
        "git_odb_close": {
          "kind": "function",
          "name": "git_odb_close",
          "location": {
            "file": "odb.h",
            "line": 95,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "db",
              "type": "git_odb *",
              "direction": "in",
              "comment": "database pointer to close. If NULL no action is taken."
            }
          ],
          "comment": [
            "Close an open object database."
          ],
          "group": "odb"
        },
        "git_odb_read": {
          "kind": "function",
          "name": "git_odb_read",
          "location": {
            "file": "odb.h",
            "line": 114,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "- GIT_SUCCESS if the object was read;\n - GIT_ENOTFOUND if the object is not in the database."
          },
          "params": [
            {
              "name": "out",
              "type": "git_odb_object **",
              "direction": "in",
              "comment": "pointer where to store the read object"
            },
            {
              "name": "db",
              "type": "git_odb *",
              "direction": "in",
              "comment": "database to search for the object in."
            },
            {
              "name": "id",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "identity of the object to read."
            }
          ],
          "comment": [
            "Read an object from the database.",
            "This method queries all available ODB backends\n trying to read the given OID.",
            "The returned object is reference counted and\n internally cached, so it should be closed\n by the user once it's no longer in use."
          ],
          "group": "odb"
        },
        "git_odb_read_prefix": {
          "kind": "function",
          "name": "git_odb_read_prefix",
          "location": {
            "file": "odb.h",
            "line": 142,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS if the object was read;\n\tGIT_ENOTFOUND if the object is not in the database.\n\tGIT_EAMBIGUOUS if the prefix is ambiguous (several objects match the prefix)"
          },
          "params": [
            {
              "name": "out",
              "type": "git_odb_object **",
              "direction": "in",
              "comment": "pointer where to store the read object"
            },
            {
              "name": "db",
              "type": "git_odb *",
              "direction": "in",
              "comment": "database to search for the object in."
            },
            {
              "name": "short_id",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "a prefix of the id of the object to read."
            },
            {
              "name": "len",
              "type": "unsigned int",
              "direction": "in",
              "comment": "the length of the prefix"
            }
          ],
          "comment": [
            "Read an object from the database, given a prefix\n of its identifier.",
            "This method queries all available ODB backends\n trying to match the 'len' first hexadecimal\n characters of the 'short_id'.\n The remaining (GIT_OID_HEXSZ-len)*4 bits of\n 'short_id' must be 0s.\n 'len' must be at least GIT_OID_MINPREFIXLEN,\n and the prefix must be long enough to identify\n a unique object in all the backends; the\n method will fail otherwise.",
            "The returned object is reference counted and\n internally cached, so it should be closed\n by the user once it's no longer in use."
          ],
          "group": "odb"
        },
        "git_odb_read_header": {
          "kind": "function",
          "name": "git_odb_read_header",
          "location": {
            "file": "odb.h",
            "line": 162,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "- GIT_SUCCESS if the object was read;\n - GIT_ENOTFOUND if the object is not in the database."
          },
          "params": [
            {
              "name": "len_p",
              "type": "size_t *",
              "direction": "in",
              "comment": "pointer where to store the length"
            },
            {
              "name": "type_p",
              "type": "git_otype *",
              "direction": "in",
              "comment": "pointer where to store the type"
            },
            {
              "name": "db",
              "type": "git_odb *",
              "direction": "in",
              "comment": "database to search for the object in."
            },
            {
              "name": "id",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "identity of the object to read."
            }
          ],
          "comment": [
            "Read the header of an object from the database, without\n reading its full contents.",
            "The header includes the length and the type of an object.",
            "Note that most backends do not support reading only the header\n of an object, so the whole object will be read and then the\n header will be returned."
          ],
          "group": "odb"
        },
        "git_odb_exists": {
          "kind": "function",
          "name": "git_odb_exists",
          "location": {
            "file": "odb.h",
            "line": 173,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "- 1, if the object was found\n - 0, otherwise"
          },
          "params": [
            {
              "name": "db",
              "type": "git_odb *",
              "direction": "in",
              "comment": "database to be searched for the given object."
            },
            {
              "name": "id",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "the object to search for."
            }
          ],
          "comment": [
            "Determine if the given object can be found in the object database."
          ],
          "group": "odb"
        },
        "git_odb_write": {
          "kind": "function",
          "name": "git_odb_write",
          "location": {
            "file": "odb.h",
            "line": 193,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "oid",
              "type": "git_oid *",
              "direction": "in",
              "comment": "pointer to store the OID result of the write"
            },
            {
              "name": "odb",
              "type": "git_odb *",
              "direction": "in",
              "comment": "object database where to store the object"
            },
            {
              "name": "data",
              "type": "const void *",
              "direction": "in",
              "comment": "buffer with the data to storr"
            },
            {
              "name": "len",
              "type": "size_t",
              "direction": "in",
              "comment": "size of the buffer"
            },
            {
              "name": "type",
              "type": "git_otype",
              "direction": "in",
              "comment": "type of the data to store",
              "referenceType": "enum git_otype"
            }
          ],
          "comment": [
            "Write an object directly into the ODB",
            "This method writes a full object straight into the ODB.\n For most cases, it is preferred to write objects through a write\n stream, which is both faster and less memory intensive, specially\n for big objects.",
            "This method is provided for compatibility with custom backends\n which are not able to support streaming writes"
          ],
          "group": "odb"
        },
        "git_odb_open_wstream": {
          "kind": "function",
          "name": "git_odb_open_wstream",
          "location": {
            "file": "odb.h",
            "line": 222,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "0 if the stream was created; error code otherwise"
          },
          "params": [
            {
              "name": "stream",
              "type": "git_odb_stream **",
              "direction": "in",
              "comment": "pointer where to store the stream"
            },
            {
              "name": "db",
              "type": "git_odb *",
              "direction": "in",
              "comment": "object database where the stream will write"
            },
            {
              "name": "size",
              "type": "size_t",
              "direction": "in",
              "comment": "final size of the object that will be written"
            },
            {
              "name": "type",
              "type": "git_otype",
              "direction": "in",
              "comment": "type of the object that will be written",
              "referenceType": "enum git_otype"
            }
          ],
          "comment": [
            "Open a stream to write an object into the ODB",
            "The type and final length of the object must be specified\n when opening the stream.",
            "The returned stream will be of type `GIT_STREAM_WRONLY` and\n will have the following methods:",
            "- stream->write: write `n` bytes into the stream\n\t\t- stream->finalize_write: close the stream and store the object in\n\t\t\tthe odb\n\t\t- stream->free: free the stream",
            "The streaming write won't be effective until `stream->finalize_write`\n is called and returns without an error",
            "The stream must always be free'd or will leak memory."
          ],
          "see": [
            "git_odb_stream"
          ],
          "group": "odb"
        },
        "git_odb_open_rstream": {
          "kind": "function",
          "name": "git_odb_open_rstream",
          "location": {
            "file": "odb.h",
            "line": 248,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "0 if the stream was created; error code otherwise"
          },
          "params": [
            {
              "name": "stream",
              "type": "git_odb_stream **",
              "direction": "in",
              "comment": "pointer where to store the stream"
            },
            {
              "name": "db",
              "type": "git_odb *",
              "direction": "in",
              "comment": "object database where the stream will read from"
            },
            {
              "name": "oid",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "oid of the object the stream will read from"
            }
          ],
          "comment": [
            "Open a stream to read an object from the ODB",
            "Note that most backends do *not* support streaming reads\n because they store their objects as compressed/delta'ed blobs.",
            "It's recommended to use `git_odb_read` instead, which is\n assured to work on all backends.",
            "The returned stream will be of type `GIT_STREAM_RDONLY` and\n will have the following methods:",
            "- stream->read: read `n` bytes from the stream\n\t\t- stream->free: free the stream",
            "The stream must always be free'd or will leak memory."
          ],
          "see": [
            "git_odb_stream"
          ],
          "group": "odb"
        },
        "git_odb_hash": {
          "kind": "function",
          "name": "git_odb_hash",
          "location": {
            "file": "odb.h",
            "line": 262,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "id",
              "type": "git_oid *",
              "direction": "in",
              "comment": "the resulting object-ID."
            },
            {
              "name": "data",
              "type": "const void *",
              "direction": "in",
              "comment": "data to hash"
            },
            {
              "name": "len",
              "type": "size_t",
              "direction": "in",
              "comment": "size of the data"
            },
            {
              "name": "type",
              "type": "git_otype",
              "direction": "in",
              "comment": "of the data to hash",
              "referenceType": "enum git_otype"
            }
          ],
          "comment": [
            "Determine the object-ID (sha1 hash) of a data buffer",
            "The resulting SHA-1 OID will the itentifier for the data\n buffer as if the data buffer it were to written to the ODB."
          ],
          "group": "odb"
        },
        "git_odb_hashfile": {
          "kind": "function",
          "name": "git_odb_hashfile",
          "location": {
            "file": "odb.h",
            "line": 275,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "out",
              "type": "git_oid *",
              "direction": "in",
              "comment": "oid structure the result is written into."
            },
            {
              "name": "path",
              "type": "const char *",
              "direction": "in",
              "comment": "file to read and determine object id for"
            },
            {
              "name": "type",
              "type": "git_otype",
              "direction": "in",
              "comment": "the type of the object that will be hashed",
              "referenceType": "enum git_otype"
            }
          ],
          "comment": [
            "Read a file from disk and fill a git_oid with the object id\n that the file would have if it were written to the Object\n Database as an object of the given type. Similar functionality\n to git.git's `git hash-object` without the `-w` flag."
          ],
          "group": "odb"
        },
        "git_odb_object_close": {
          "kind": "function",
          "name": "git_odb_object_close",
          "location": {
            "file": "odb.h",
            "line": 285,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "object",
              "type": "git_odb_object *",
              "direction": "in",
              "comment": "object to close"
            }
          ],
          "comment": [
            "Close an ODB object",
            "This method must always be called once a `git_odb_object` is no\n longer needed, otherwise memory will leak."
          ],
          "group": "odb"
        },
        "git_odb_object_id": {
          "kind": "function",
          "name": "git_odb_object_id",
          "location": {
            "file": "odb.h",
            "line": 295,
            "column": 29
          },
          "returns": {
            "type": "const git_oid *",
            "comment": "a pointer to the OID"
          },
          "params": [
            {
              "name": "object",
              "type": "git_odb_object *",
              "direction": "in",
              "comment": "the object"
            }
          ],
          "comment": [
            "Return the OID of an ODB object",
            "This is the OID from which the object was read from"
          ],
          "group": "odb"
        },
        "git_odb_object_data": {
          "kind": "function",
          "name": "git_odb_object_data",
          "location": {
            "file": "odb.h",
            "line": 308,
            "column": 26
          },
          "returns": {
            "type": "const void *",
            "comment": "a pointer to the data"
          },
          "params": [
            {
              "name": "object",
              "type": "git_odb_object *",
              "direction": "in",
              "comment": "the object"
            }
          ],
          "comment": [
            "Return the data of an ODB object",
            "This is the uncompressed, raw data as read from the ODB,\n without the leading header.",
            "This pointer is owned by the object and shall not be free'd."
          ],
          "group": "odb"
        },
        "git_odb_object_size": {
          "kind": "function",
          "name": "git_odb_object_size",
          "location": {
            "file": "odb.h",
            "line": 319,
            "column": 20
          },
          "returns": {
            "type": "size_t",
            "comment": "the size"
          },
          "params": [
            {
              "name": "object",
              "type": "git_odb_object *",
              "direction": "in",
              "comment": "the object"
            }
          ],
          "comment": [
            "Return the size of an ODB object",
            "This is the real size of the `data` buffer, not the\n actual size of the object."
          ],
          "group": "odb"
        },
        "git_odb_object_type": {
          "kind": "function",
          "name": "git_odb_object_type",
          "location": {
            "file": "odb.h",
            "line": 327,
            "column": 23
          },
          "returns": {
            "type": "git_otype",
            "comment": "the type"
          },
          "params": [
            {
              "name": "object",
              "type": "git_odb_object *",
              "direction": "in",
              "comment": "the object"
            }
          ],
          "comment": [
            "Return the type of an ODB object"
          ],
          "group": "odb"
        },
        "git_odb": {
          "kind": "struct",
          "name": "git_odb",
          "referenceName": "struct git_odb",
          "opaque": true,
          "comment": [
            "An open object database handle."
          ],
          "location": {
            "file": "types.h",
            "line": 78,
            "column": 24
          },
          "group": "odb",
          "returnedBy": [
            "git_repository_database"
          ],
          "parameterTo": [
            "git_odb_new",
            "git_odb_open",
            "git_odb_add_backend",
            "git_odb_add_alternate",
            "git_odb_close",
            "git_odb_read",
            "git_odb_read_prefix",
            "git_odb_read_header",
            "git_odb_exists",
            "git_odb_write",
            "git_odb_open_wstream",
            "git_odb_open_rstream",
            "git_repository_open3"
          ]
        },
        "git_odb_object": {
          "kind": "struct",
          "name": "git_odb_object",
          "referenceName": "struct git_odb_object",
          "opaque": true,
          "comment": [
            "An object read from the ODB"
          ],
          "location": {
            "file": "types.h",
            "line": 84,
            "column": 31
          },
          "group": "odb",
          "parameterTo": [
            "git_odb_read",
            "git_odb_read_prefix",
            "git_odb_object_close",
            "git_odb_object_id",
            "git_odb_object_data",
            "git_odb_object_size",
            "git_odb_object_type"
          ]
        }
      },
      "info": {
        "summary": "Git object database routines"
      }
    },
    "odb_backend": {
      "apis": {
        "git_odb_backend": {
          "kind": "struct",
          "name": "git_odb_backend",
          "referenceName": "struct git_odb_backend",
          "comment": [
            "An instance for a custom backend"
          ],
          "members": [
            {
              "name": "odb",
              "type": "git_odb *"
            },
            {
              "name": "read",
              "type": "int (*)(void **, size_t *, git_otype *, struct git_odb_backend *, const git_oid *)"
            },
            {
              "name": "read_prefix",
              "type": "int (*)(git_oid *, void **, size_t *, git_otype *, struct git_odb_backend *, const git_oid *, unsigned int)"
            },
            {
              "name": "read_header",
              "type": "int (*)(size_t *, git_otype *, struct git_odb_backend *, const git_oid *)"
            },
            {
              "name": "write",
              "type": "int (*)(git_oid *, struct git_odb_backend *, const void *, size_t, git_otype)"
            },
            {
              "name": "writestream",
              "type": "int (*)(struct git_odb_stream **, struct git_odb_backend *, size_t, git_otype)"
            },
            {
              "name": "readstream",
              "type": "int (*)(struct git_odb_stream **, struct git_odb_backend *, const git_oid *)"
            },
            {
              "name": "exists",
              "type": "int (*)(struct git_odb_backend *, const git_oid *)"
            },
            {
              "name": "free",
              "type": "void (*)(struct git_odb_backend *)"
            }
          ],
          "location": {
            "file": "odb_backend.h",
            "line": 26,
            "column": 8
          },
          "group": "odb_backend",
          "parameterTo": [
            "git_odb_add_backend",
            "git_odb_add_alternate",
            "git_odb_backend_pack",
            "git_odb_backend_loose"
          ]
        },
        "git_odb_stream": {
          "kind": "struct",
          "name": "git_odb_stream",
          "referenceName": "struct git_odb_stream",
          "comment": [
            "A stream to read/write from a backend"
          ],
          "members": [
            {
              "name": "backend",
              "type": "struct git_odb_backend *"
            },
            {
              "name": "mode",
              "type": "int"
            },
            {
              "name": "read",
              "type": "int (*)(struct git_odb_stream *, char *, size_t)"
            },
            {
              "name": "write",
              "type": "int (*)(struct git_odb_stream *, const char *, size_t)"
            },
            {
              "name": "finalize_write",
              "type": "int (*)(git_oid *, struct git_odb_stream *)"
            },
            {
              "name": "free",
              "type": "void (*)(struct git_odb_stream *)"
            }
          ],
          "location": {
            "file": "odb_backend.h",
            "line": 78,
            "column": 8
          },
          "group": "odb_backend",
          "parameterTo": [
            "git_odb_open_wstream",
            "git_odb_open_rstream"
          ]
        },
        "git_odb_streammode": {
          "kind": "enum",
          "name": "git_odb_streammode",
          "referenceName": "git_odb_streammode",
          "members": [
            {
              "name": "GIT_STREAM_RDONLY",
              "value": "2"
            },
            {
              "name": "GIT_STREAM_WRONLY",
              "value": "4"
            },
            {
              "name": "GIT_STREAM_RW",
              "value": "6"
            }
          ],
          "comment": [
            "Streaming mode"
          ],
          "location": {
            "file": "odb_backend.h",
            "line": 89,
            "column": 9
          },
          "group": "odb_backend"
        },
        "git_odb_backend_pack": {
          "kind": "function",
          "name": "git_odb_backend_pack",
          "location": {
            "file": "odb_backend.h",
            "line": 95,
            "column": 17
          },
          "returns": {
            "type": "int"
          },
          "params": [
            {
              "name": "backend_out",
              "type": "git_odb_backend **"
            },
            {
              "name": "objects_dir",
              "type": "const char *"
            }
          ],
          "group": "odb_backend"
        },
        "git_odb_backend_loose": {
          "kind": "function",
          "name": "git_odb_backend_loose",
          "location": {
            "file": "odb_backend.h",
            "line": 96,
            "column": 17
          },
          "returns": {
            "type": "int"
          },
          "params": [
            {
              "name": "backend_out",
              "type": "git_odb_backend **"
            },
            {
              "name": "objects_dir",
              "type": "const char *"
            },
            {
              "name": "compression_level",
              "type": "int"
            },
            {
              "name": "do_fsync",
              "type": "int"
            }
          ],
          "group": "odb_backend"
        }
      },
      "info": {
        "summary": "Git custom backend functions"
      }
    },
    "oid": {
      "apis": {
        "GIT_OID_RAWSZ": {
          "kind": "macro",
          "name": "GIT_OID_RAWSZ",
          "location": {
            "file": "oid.h",
            "line": 23,
            "column": 9
          },
          "value": "20",
          "comment": "Size (in bytes) of a raw/binary oid",
          "group": "oid"
        },
        "GIT_OID_HEXSZ": {
          "kind": "macro",
          "name": "GIT_OID_HEXSZ",
          "location": {
            "file": "oid.h",
            "line": 26,
            "column": 9
          },
          "value": "(GIT_OID_RAWSZ * 2)",
          "comment": "Size (in bytes) of a hex formatted oid",
          "group": "oid"
        },
        "GIT_OID_MINPREFIXLEN": {
          "kind": "macro",
          "name": "GIT_OID_MINPREFIXLEN",
          "location": {
            "file": "oid.h",
            "line": 30,
            "column": 9
          },
          "value": "4",
          "comment": "Minimum length (in number of hex characters, i.e. packets of 4 bits) of an oid prefix",
          "group": "oid"
        },
        "git_oid": {
          "kind": "struct",
          "name": "git_oid",
          "referenceName": "struct _git_oid",
          "opaque": true,
          "comment": [
            "Unique identity of any object (commit, tree, blob, tag)."
          ],
          "location": {
            "file": "oid.h",
            "line": 33,
            "column": 25
          },
          "group": "oid",
          "returnedBy": [
            "git_commit_id",
            "git_commit_tree_oid",
            "git_commit_parent_oid",
            "git_indexer_hash",
            "git_object_id",
            "git_odb_object_id",
            "git_reflog_entry_oidold",
            "git_reflog_entry_oidnew",
            "git_reference_oid",
            "git_tag_id",
            "git_tag_target_oid",
            "git_tree_id",
            "git_tree_entry_id"
          ],
          "parameterTo": [
            "git_blob_lookup",
            "git_blob_lookup_prefix",
            "git_blob_create_fromfile",
            "git_blob_create_frombuffer",
            "git_commit_lookup",
            "git_commit_lookup_prefix",
            "git_commit_create",
            "git_commit_create_v",
            "git_object_lookup",
            "git_object_lookup_prefix",
            "git_odb_read",
            "git_odb_read_prefix",
            "git_odb_read_header",
            "git_odb_exists",
            "git_odb_write",
            "git_odb_open_rstream",
            "git_odb_hash",
            "git_odb_hashfile",
            "git_oid_fromstr",
            "git_oid_fromstrn",
            "git_oid_fromraw",
            "git_oid_fmt",
            "git_oid_pathfmt",
            "git_oid_allocfmt",
            "git_oid_to_string",
            "git_oid_cpy",
            "git_oid_cmp",
            "git_oid_ncmp",
            "git_reflog_write",
            "git_reference_create_oid",
            "git_reference_set_oid",
            "git_revwalk_push",
            "git_revwalk_hide",
            "git_revwalk_next",
            "git_tag_lookup",
            "git_tag_lookup_prefix",
            "git_tag_create",
            "git_tag_create_frombuffer",
            "git_tag_create_lightweight",
            "git_tree_lookup",
            "git_tree_lookup_prefix",
            "git_tree_create_fromindex",
            "git_treebuilder_insert",
            "git_treebuilder_write"
          ]
        },
        "_git_oid": {
          "kind": "struct",
          "name": "_git_oid",
          "referenceName": "struct _git_oid",
          "members": [
            {
              "name": "id",
              "type": "unsigned char[20]",
              "comment": [
                "raw binary formatted id"
              ]
            }
          ],
          "location": {
            "file": "oid.h",
            "line": 34,
            "column": 8
          },
          "group": "oid"
        },
        "git_oid_fromstr": {
          "kind": "function",
          "name": "git_oid_fromstr",
          "location": {
            "file": "oid.h",
            "line": 48,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "out",
              "type": "git_oid *",
              "direction": "in",
              "comment": "oid structure the result is written into."
            },
            {
              "name": "str",
              "type": "const char *",
              "direction": "in",
              "comment": "input hex string; must be pointing at the start of\n\t\tthe hex sequence and have at least the number of bytes\n\t\tneeded for an oid encoded in hex (40 bytes)."
            }
          ],
          "comment": [
            "Parse a hex formatted object id into a git_oid."
          ],
          "group": "oid"
        },
        "git_oid_fromstrn": {
          "kind": "function",
          "name": "git_oid_fromstrn",
          "location": {
            "file": "oid.h",
            "line": 61,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "out",
              "type": "git_oid *",
              "direction": "in",
              "comment": "oid structure the result is written into."
            },
            {
              "name": "str",
              "type": "const char *",
              "direction": "in",
              "comment": "input hex string of at least size `length`"
            },
            {
              "name": "length",
              "type": "size_t",
              "direction": "in",
              "comment": "length of the input string"
            }
          ],
          "comment": [
            "Parse N characters of a hex formatted object id into a git_oid",
            "If N is odd, N-1 characters will be parsed instead.\n The remaining space in the git_oid will be set to zero."
          ],
          "group": "oid"
        },
        "git_oid_fromraw": {
          "kind": "function",
          "name": "git_oid_fromraw",
          "location": {
            "file": "oid.h",
            "line": 69,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "out",
              "type": "git_oid *",
              "direction": "in",
              "comment": "oid structure the result is written into."
            },
            {
              "name": "raw",
              "type": "const unsigned char *",
              "direction": "in",
              "comment": "the raw input bytes to be copied."
            }
          ],
          "comment": [
            "Copy an already raw oid into a git_oid structure."
          ],
          "group": "oid"
        },
        "git_oid_fmt": {
          "kind": "function",
          "name": "git_oid_fmt",
          "location": {
            "file": "oid.h",
            "line": 81,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "str",
              "type": "char *",
              "direction": "in",
              "comment": "output hex string; must be pointing at the start of\n\t\tthe hex sequence and have at least the number of bytes\n\t\tneeded for an oid encoded in hex (40 bytes). Only the\n\t\toid digits are written; a '\n\\\n0' terminator must be added\n\t\tby the caller if it is required."
            },
            {
              "name": "oid",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "oid structure to format."
            }
          ],
          "comment": [
            "Format a git_oid into a hex string."
          ],
          "group": "oid"
        },
        "git_oid_pathfmt": {
          "kind": "function",
          "name": "git_oid_pathfmt",
          "location": {
            "file": "oid.h",
            "line": 96,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "str",
              "type": "char *",
              "direction": "in",
              "comment": "output hex string; must be pointing at the start of\n\t\tthe hex sequence and have at least the number of bytes\n\t\tneeded for an oid encoded in hex (41 bytes). Only the\n\t\toid digits are written; a '\n\\\n0' terminator must be added\n\t\tby the caller if it is required."
            },
            {
              "name": "oid",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "oid structure to format."
            }
          ],
          "comment": [
            "Format a git_oid into a loose-object path string.",
            "The resulting string is \"aa/...\", where \"aa\" is the first two\n hex digitis of the oid and \"...\" is the remaining 38 digits."
          ],
          "group": "oid"
        },
        "git_oid_allocfmt": {
          "kind": "function",
          "name": "git_oid_allocfmt",
          "location": {
            "file": "oid.h",
            "line": 105,
            "column": 20
          },
          "returns": {
            "type": "char *",
            "comment": "the c-string; NULL if memory is exhausted. Caller must\n\t\t\tdeallocate the string with free()."
          },
          "params": [
            {
              "name": "oid",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "the oid structure to format"
            }
          ],
          "comment": [
            "Format a git_oid into a newly allocated c-string."
          ],
          "group": "oid"
        },
        "git_oid_to_string": {
          "kind": "function",
          "name": "git_oid_to_string",
          "location": {
            "file": "oid.h",
            "line": 122,
            "column": 20
          },
          "returns": {
            "type": "char *",
            "comment": "the out buffer pointer, assuming no input parameter\n\t\t\terrors, otherwise a pointer to an empty string."
          },
          "params": [
            {
              "name": "out",
              "type": "char *",
              "direction": "in",
              "comment": "the buffer into which the oid string is output."
            },
            {
              "name": "n",
              "type": "size_t",
              "direction": "in",
              "comment": "the size of the out buffer."
            },
            {
              "name": "oid",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "the oid structure to format."
            }
          ],
          "comment": [
            "Format a git_oid into a buffer as a hex format c-string.",
            "If the buffer is smaller than GIT_OID_HEXSZ+1, then the resulting\n oid c-string will be truncated to n-1 characters. If there are\n any input parameter errors (out == NULL, n == 0, oid == NULL),\n then a pointer to an empty string is returned, so that the return\n value can always be printed."
          ],
          "group": "oid"
        },
        "git_oid_cpy": {
          "kind": "function",
          "name": "git_oid_cpy",
          "location": {
            "file": "oid.h",
            "line": 130,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "out",
              "type": "git_oid *",
              "direction": "in",
              "comment": "oid structure the result is written into."
            },
            {
              "name": "src",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "oid structure to copy from."
            }
          ],
          "comment": [
            "Copy an oid from one structure to another."
          ],
          "group": "oid"
        },
        "git_oid_cmp": {
          "kind": "function",
          "name": "git_oid_cmp",
          "location": {
            "file": "oid.h",
            "line": 139,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "<\n0, 0, >0 if a \n<\n b, a == b, a > b."
          },
          "params": [
            {
              "name": "a",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "first oid structure."
            },
            {
              "name": "b",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "second oid structure."
            }
          ],
          "comment": [
            "Compare two oid structures."
          ],
          "group": "oid"
        },
        "git_oid_ncmp": {
          "kind": "function",
          "name": "git_oid_ncmp",
          "location": {
            "file": "oid.h",
            "line": 150,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "0 in case of a match"
          },
          "params": [
            {
              "name": "a",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "first oid structure."
            },
            {
              "name": "b",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "second oid structure."
            },
            {
              "name": "len",
              "type": "unsigned int",
              "direction": "in",
              "comment": "the number of hex chars to compare"
            }
          ],
          "comment": [
            "Compare the first 'len' hexadecimal characters (packets of 4 bits)\n of two oid structures."
          ],
          "group": "oid"
        },
        "git_oid_shorten": {
          "kind": "struct",
          "name": "git_oid_shorten",
          "referenceName": "struct git_oid_shorten",
          "opaque": true,
          "comment": [
            "OID Shortener object"
          ],
          "location": {
            "file": "oid.h",
            "line": 155,
            "column": 32
          },
          "group": "oid",
          "returnedBy": [
            "git_oid_shorten_new"
          ],
          "parameterTo": [
            "git_oid_shorten_add",
            "git_oid_shorten_free"
          ]
        },
        "git_oid_shorten_new": {
          "kind": "function",
          "name": "git_oid_shorten_new",
          "location": {
            "file": "oid.h",
            "line": 171,
            "column": 18
          },
          "returns": {
            "type": "git_oid_shorten *",
            "comment": "a `git_oid_shorten` instance, NULL if OOM"
          },
          "params": [
            {
              "name": "min_length",
              "type": "size_t",
              "direction": "in",
              "comment": "The minimal length for all identifiers,\n\t\twhich will be used even if shorter OIDs would still\n\t\tbe unique."
            }
          ],
          "comment": [
            "Create a new OID shortener.",
            "The OID shortener is used to process a list of OIDs\n in text form and return the shortest length that would\n uniquely identify all of them.",
            "E.g. look at the result of `git log --abbrev`."
          ],
          "group": "oid"
        },
        "git_oid_shorten_add": {
          "kind": "function",
          "name": "git_oid_shorten_add",
          "location": {
            "file": "oid.h",
            "line": 197,
            "column": 5
          },
          "returns": {
            "type": "int",
            "comment": "the minimal length to uniquely identify all OIDs\n\t\tadded so far to the set; or an error code (\n<\n0) if an\n\t\terror occurs."
          },
          "params": [
            {
              "name": "os",
              "type": "git_oid_shorten *",
              "direction": "in",
              "comment": "a `git_oid_shorten` instance"
            },
            {
              "name": "text_oid",
              "type": "const char *",
              "direction": "in",
              "comment": "an OID in text form"
            }
          ],
          "comment": [
            "Add a new OID to set of shortened OIDs and calculate\n the minimal length to uniquely identify all the OIDs in\n the set.",
            "The OID is expected to be a 40-char hexadecimal string.\n The OID is owned by the user and will not be modified\n or freed.",
            "For performance reasons, there is a hard-limit of how many\n OIDs can be added to a single set (around ~22000, assuming\n a mostly randomized distribution), which should be enough\n for any kind of program, and keeps the algorithm fast and\n memory-efficient.",
            "Attempting to add more than those OIDs will result in a\n GIT_ENOMEM error"
          ],
          "group": "oid"
        },
        "git_oid_shorten_free": {
          "kind": "function",
          "name": "git_oid_shorten_free",
          "location": {
            "file": "oid.h",
            "line": 204,
            "column": 6
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "os",
              "type": "git_oid_shorten *",
              "direction": "in",
              "comment": "a `git_oid_shorten` instance"
            }
          ],
          "comment": [
            "Free an OID shortener instance"
          ],
          "group": "oid"
        }
      },
      "info": {
        "summary": "Git object id routines"
      }
    },
    "reflog": {
      "apis": {
        "git_reflog_read": {
          "kind": "function",
          "name": "git_reflog_read",
          "location": {
            "file": "reflog.h",
            "line": 33,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "reflog",
              "type": "git_reflog **",
              "direction": "in",
              "comment": "pointer to reflog"
            },
            {
              "name": "ref",
              "type": "git_reference *",
              "direction": "in",
              "comment": "reference to read the reflog for"
            }
          ],
          "comment": [
            "Read the reflog for the given reference",
            "The reflog must be freed manually by using\n git_reflog_free()."
          ],
          "group": "reflog"
        },
        "git_reflog_write": {
          "kind": "function",
          "name": "git_reflog_write",
          "location": {
            "file": "reflog.h",
            "line": 51,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "ref",
              "type": "git_reference *",
              "direction": "in",
              "comment": "the changed reference"
            },
            {
              "name": "oid_old",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "the OID the reference was pointing to"
            },
            {
              "name": "committer",
              "type": "const git_signature *",
              "direction": "in",
              "comment": "the signature of the committer"
            },
            {
              "name": "msg",
              "type": "const char *",
              "direction": "in",
              "comment": "the reflog message"
            }
          ],
          "comment": [
            "Write a new reflog for the given reference",
            "If there is no reflog file for the given\n reference yet, it will be created.",
            "`oid_old` may be NULL in case it's a new reference.",
            "`msg` is optional and can be NULL."
          ],
          "group": "reflog"
        },
        "git_reflog_entrycount": {
          "kind": "function",
          "name": "git_reflog_entrycount",
          "location": {
            "file": "reflog.h",
            "line": 59,
            "column": 26
          },
          "returns": {
            "type": "unsigned int",
            "comment": "the number of log entries"
          },
          "params": [
            {
              "name": "reflog",
              "type": "git_reflog *",
              "direction": "in",
              "comment": "the previously loaded reflog"
            }
          ],
          "comment": [
            "Get the number of log entries in a reflog"
          ],
          "group": "reflog"
        },
        "git_reflog_entry_byindex": {
          "kind": "function",
          "name": "git_reflog_entry_byindex",
          "location": {
            "file": "reflog.h",
            "line": 68,
            "column": 38
          },
          "returns": {
            "type": "const git_reflog_entry *",
            "comment": "the entry; NULL if not found"
          },
          "params": [
            {
              "name": "reflog",
              "type": "git_reflog *",
              "direction": "in",
              "comment": "a previously loaded reflog"
            },
            {
              "name": "idx",
              "type": "unsigned int",
              "direction": "in",
              "comment": "the position to lookup"
            }
          ],
          "comment": [
            "Lookup an entry by its index"
          ],
          "group": "reflog"
        },
        "git_reflog_entry_oidold": {
          "kind": "function",
          "name": "git_reflog_entry_oidold",
          "location": {
            "file": "reflog.h",
            "line": 76,
            "column": 29
          },
          "returns": {
            "type": "const git_oid *",
            "comment": "the old oid"
          },
          "params": [
            {
              "name": "entry",
              "type": "const git_reflog_entry *",
              "direction": "in",
              "comment": "a reflog entry"
            }
          ],
          "comment": [
            "Get the old oid"
          ],
          "group": "reflog"
        },
        "git_reflog_entry_oidnew": {
          "kind": "function",
          "name": "git_reflog_entry_oidnew",
          "location": {
            "file": "reflog.h",
            "line": 84,
            "column": 29
          },
          "returns": {
            "type": "const git_oid *",
            "comment": "the new oid at this time"
          },
          "params": [
            {
              "name": "entry",
              "type": "const git_reflog_entry *",
              "direction": "in",
              "comment": "a reflog entry"
            }
          ],
          "comment": [
            "Get the new oid"
          ],
          "group": "reflog"
        },
        "git_reflog_entry_committer": {
          "kind": "function",
          "name": "git_reflog_entry_committer",
          "location": {
            "file": "reflog.h",
            "line": 92,
            "column": 29
          },
          "returns": {
            "type": "git_signature *",
            "comment": "the committer"
          },
          "params": [
            {
              "name": "entry",
              "type": "const git_reflog_entry *",
              "direction": "in",
              "comment": "a reflog entry"
            }
          ],
          "comment": [
            "Get the committer of this entry"
          ],
          "group": "reflog"
        },
        "git_reflog_entry_msg": {
          "kind": "function",
          "name": "git_reflog_entry_msg",
          "location": {
            "file": "reflog.h",
            "line": 100,
            "column": 20
          },
          "returns": {
            "type": "char *",
            "comment": "the log msg"
          },
          "params": [
            {
              "name": "entry",
              "type": "const git_reflog_entry *",
              "direction": "in",
              "comment": "a reflog entry"
            }
          ],
          "comment": [
            "Get the log msg"
          ],
          "group": "reflog"
        },
        "git_reflog_free": {
          "kind": "function",
          "name": "git_reflog_free",
          "location": {
            "file": "reflog.h",
            "line": 107,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "reflog",
              "type": "git_reflog *",
              "direction": "in",
              "comment": "reflog to free"
            }
          ],
          "comment": [
            "Free the reflog"
          ],
          "group": "reflog"
        },
        "git_reflog_entry": {
          "kind": "struct",
          "name": "git_reflog_entry",
          "referenceName": "struct git_reflog_entry",
          "opaque": true,
          "comment": [
            "Representation of a reference log entry"
          ],
          "location": {
            "file": "types.h",
            "line": 129,
            "column": 33
          },
          "group": "reflog",
          "returnedBy": [
            "git_reflog_entry_byindex"
          ],
          "parameterTo": [
            "git_reflog_entry_oidold",
            "git_reflog_entry_oidnew",
            "git_reflog_entry_committer",
            "git_reflog_entry_msg"
          ]
        },
        "git_reflog": {
          "kind": "struct",
          "name": "git_reflog",
          "referenceName": "struct git_reflog",
          "opaque": true,
          "comment": [
            "Representation of a reference log"
          ],
          "location": {
            "file": "types.h",
            "line": 132,
            "column": 27
          },
          "group": "reflog",
          "parameterTo": [
            "git_reflog_read",
            "git_reflog_entrycount",
            "git_reflog_entry_byindex",
            "git_reflog_free"
          ]
        }
      },
      "info": {
        "summary": "Git reflog management routines"
      }
    },
    "refs": {
      "apis": {
        "git_reference_lookup": {
          "kind": "function",
          "name": "git_reference_lookup",
          "location": {
            "file": "refs.h",
            "line": 34,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "reference_out",
              "type": "git_reference **",
              "direction": "in",
              "comment": "pointer to the looked-up reference"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "the repository to look up the reference"
            },
            {
              "name": "name",
              "type": "const char *",
              "direction": "in",
              "comment": "the long name for the reference (e.g. HEAD, ref/heads/master, refs/tags/v0.1.0, ...)"
            }
          ],
          "comment": [
            "Lookup a reference by its name in a repository.",
            "The generated reference is owned by the repository and\n should not be freed by the user."
          ],
          "group": "refs"
        },
        "git_reference_create_symbolic": {
          "kind": "function",
          "name": "git_reference_create_symbolic",
          "location": {
            "file": "refs.h",
            "line": 55,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "ref_out",
              "type": "git_reference **",
              "direction": "in",
              "comment": "Pointer to the newly created reference"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "Repository where that reference will live"
            },
            {
              "name": "name",
              "type": "const char *",
              "direction": "in",
              "comment": "The name of the reference"
            },
            {
              "name": "target",
              "type": "const char *",
              "direction": "in",
              "comment": "The target of the reference"
            },
            {
              "name": "force",
              "type": "int",
              "direction": "in",
              "comment": "Overwrite existing references"
            }
          ],
          "comment": [
            "Create a new symbolic reference.",
            "The reference will be created in the repository and written\n to the disk.",
            "This reference is owned by the repository and shall not\n be free'd by the user.",
            "If `force` is true and there already exists a reference\n with the same name, it will be overwritten."
          ],
          "group": "refs"
        },
        "git_reference_create_oid": {
          "kind": "function",
          "name": "git_reference_create_oid",
          "location": {
            "file": "refs.h",
            "line": 76,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "ref_out",
              "type": "git_reference **",
              "direction": "in",
              "comment": "Pointer to the newly created reference"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "Repository where that reference will live"
            },
            {
              "name": "name",
              "type": "const char *",
              "direction": "in",
              "comment": "The name of the reference"
            },
            {
              "name": "id",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "The object id pointed to by the reference."
            },
            {
              "name": "force",
              "type": "int",
              "direction": "in",
              "comment": "Overwrite existing references"
            }
          ],
          "comment": [
            "Create a new object id reference.",
            "The reference will be created in the repository and written\n to the disk.",
            "This reference is owned by the repository and shall not\n be free'd by the user.",
            "If `force` is true and there already exists a reference\n with the same name, it will be overwritten."
          ],
          "group": "refs"
        },
        "git_reference_oid": {
          "kind": "function",
          "name": "git_reference_oid",
          "location": {
            "file": "refs.h",
            "line": 86,
            "column": 29
          },
          "returns": {
            "type": "const git_oid *",
            "comment": "a pointer to the oid if available, NULL otherwise"
          },
          "params": [
            {
              "name": "ref",
              "type": "git_reference *",
              "direction": "in",
              "comment": "The reference"
            }
          ],
          "comment": [
            "Get the OID pointed to by a reference.",
            "Only available if the reference is direct (i.e. not symbolic)"
          ],
          "group": "refs"
        },
        "git_reference_target": {
          "kind": "function",
          "name": "git_reference_target",
          "location": {
            "file": "refs.h",
            "line": 96,
            "column": 26
          },
          "returns": {
            "type": "const char *",
            "comment": "a pointer to the name if available, NULL otherwise"
          },
          "params": [
            {
              "name": "ref",
              "type": "git_reference *",
              "direction": "in",
              "comment": "The reference"
            }
          ],
          "comment": [
            "Get full name to the reference pointed by this reference",
            "Only available if the reference is symbolic"
          ],
          "group": "refs"
        },
        "git_reference_type": {
          "kind": "function",
          "name": "git_reference_type",
          "location": {
            "file": "refs.h",
            "line": 106,
            "column": 23
          },
          "returns": {
            "type": "git_rtype",
            "comment": "the type"
          },
          "params": [
            {
              "name": "ref",
              "type": "git_reference *",
              "direction": "in",
              "comment": "The reference"
            }
          ],
          "comment": [
            "Get the type of a reference",
            "Either direct (GIT_REF_OID) or symbolic (GIT_REF_SYMBOLIC)"
          ],
          "group": "refs"
        },
        "git_reference_name": {
          "kind": "function",
          "name": "git_reference_name",
          "location": {
            "file": "refs.h",
            "line": 114,
            "column": 26
          },
          "returns": {
            "type": "const char *",
            "comment": "the full name for the ref"
          },
          "params": [
            {
              "name": "ref",
              "type": "git_reference *",
              "direction": "in",
              "comment": "The reference"
            }
          ],
          "comment": [
            "Get the full name of a reference"
          ],
          "group": "refs"
        },
        "git_reference_resolve": {
          "kind": "function",
          "name": "git_reference_resolve",
          "location": {
            "file": "refs.h",
            "line": 129,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "resolved_ref",
              "type": "git_reference **",
              "direction": "in",
              "comment": "Pointer to the peeled reference"
            },
            {
              "name": "ref",
              "type": "git_reference *",
              "direction": "in",
              "comment": "The reference"
            }
          ],
          "comment": [
            "Resolve a symbolic reference",
            "Thie method iteratively peels a symbolic reference\n until it resolves to a direct reference to an OID.",
            "If a direct reference is passed as an argument,\n that reference is returned immediately"
          ],
          "group": "refs"
        },
        "git_reference_owner": {
          "kind": "function",
          "name": "git_reference_owner",
          "location": {
            "file": "refs.h",
            "line": 137,
            "column": 30
          },
          "returns": {
            "type": "git_repository *",
            "comment": "a pointer to the repo"
          },
          "params": [
            {
              "name": "ref",
              "type": "git_reference *",
              "direction": "in",
              "comment": "The reference"
            }
          ],
          "comment": [
            "Get the repository where a reference resides"
          ],
          "group": "refs"
        },
        "git_reference_set_target": {
          "kind": "function",
          "name": "git_reference_set_target",
          "location": {
            "file": "refs.h",
            "line": 152,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "ref",
              "type": "git_reference *",
              "direction": "in",
              "comment": "The reference"
            },
            {
              "name": "target",
              "type": "const char *",
              "direction": "in",
              "comment": "The new target for the reference"
            }
          ],
          "comment": [
            "Set the symbolic target of a reference.",
            "The reference must be a symbolic reference, otherwise\n this method will fail.",
            "The reference will be automatically updated in\n memory and on disk."
          ],
          "group": "refs"
        },
        "git_reference_set_oid": {
          "kind": "function",
          "name": "git_reference_set_oid",
          "location": {
            "file": "refs.h",
            "line": 167,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "ref",
              "type": "git_reference *",
              "direction": "in",
              "comment": "The reference"
            },
            {
              "name": "id",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "The new target OID for the reference"
            }
          ],
          "comment": [
            "Set the OID target of a reference.",
            "The reference must be a direct reference, otherwise\n this method will fail.",
            "The reference will be automatically updated in\n memory and on disk."
          ],
          "group": "refs"
        },
        "git_reference_rename": {
          "kind": "function",
          "name": "git_reference_rename",
          "location": {
            "file": "refs.h",
            "line": 180,
            "column": 17
          },
          "returns": {
            "type": "int"
          },
          "params": [
            {
              "name": "ref",
              "type": "git_reference *"
            },
            {
              "name": "new_name",
              "type": "const char *"
            },
            {
              "name": "force",
              "type": "int"
            }
          ],
          "comment": [
            "Rename an existing reference",
            "This method works for both direct and symbolic references.\n The new name will be checked for validity and may be\n modified into a normalized form.",
            "The refernece will be immediately renamed in-memory\n and on disk."
          ],
          "group": "refs"
        },
        "git_reference_delete": {
          "kind": "function",
          "name": "git_reference_delete",
          "location": {
            "file": "refs.h",
            "line": 191,
            "column": 17
          },
          "returns": {
            "type": "int"
          },
          "params": [
            {
              "name": "ref",
              "type": "git_reference *"
            }
          ],
          "comment": [
            "Delete an existing reference",
            "This method works for both direct and symbolic references.",
            "The reference will be immediately removed on disk and from\n memory. The given reference pointer will no longer be valid."
          ],
          "group": "refs"
        },
        "git_reference_packall": {
          "kind": "function",
          "name": "git_reference_packall",
          "location": {
            "file": "refs.h",
            "line": 209,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "Repository where the loose refs will be packed"
            }
          ],
          "comment": [
            "Pack all the loose references in the repository",
            "This method will load into the cache all the loose\n references on the repository and update the\n `packed-refs` file with them.",
            "Once the `packed-refs` file has been written properly,\n the loose references will be removed from disk.",
            "WARNING: calling this method may invalidate any existing\n references previously loaded on the cache."
          ],
          "group": "refs"
        },
        "git_reference_listall": {
          "kind": "function",
          "name": "git_reference_listall",
          "location": {
            "file": "refs.h",
            "line": 232,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "array",
              "type": "git_strarray *",
              "direction": "in",
              "comment": "Pointer to a git_strarray structure where\n\t\tthe reference names will be stored"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "Repository where to find the refs"
            },
            {
              "name": "list_flags",
              "type": "unsigned int",
              "direction": "in",
              "comment": "Filtering flags for the reference\n\t\tlisting."
            }
          ],
          "comment": [
            "Fill a list with all the references that can be found\n in a repository.",
            "The listed references may be filtered by type, or using\n a bitwise OR of several types. Use the magic value\n `GIT_REF_LISTALL` to obtain all references, including\n packed ones.",
            "The string array will be filled with the names of all\n references; these values are owned by the user and\n should be free'd manually when no longer needed, using\n `git_strarray_free`."
          ],
          "group": "refs"
        },
        "git_reference_foreach": {
          "kind": "function",
          "name": "git_reference_foreach",
          "location": {
            "file": "refs.h",
            "line": 254,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "Repository where to find the refs"
            },
            {
              "name": "list_flags",
              "type": "unsigned int",
              "direction": "in",
              "comment": "Filtering flags for the reference\n\t\tlisting."
            },
            {
              "name": "callback",
              "type": "int (*)(const char *, void *)",
              "direction": "in",
              "comment": "Function which will be called for every listed ref"
            },
            {
              "name": "payload",
              "type": "void *",
              "direction": "in",
              "comment": "Additional data to pass to the callback"
            }
          ],
          "comment": [
            "Perform an operation on each reference in the repository",
            "The processed references may be filtered by type, or using\n a bitwise OR of several types. Use the magic value\n `GIT_REF_LISTALL` to obtain all references, including\n packed ones.",
            "The `callback` function will be called for each of the references\n in the repository, and will receive the name of the reference and\n the `payload` value passed to this method."
          ],
          "group": "refs"
        },
        "git_reference": {
          "kind": "struct",
          "name": "git_reference",
          "referenceName": "struct git_reference",
          "opaque": true,
          "comment": [
            "In-memory representation of a reference."
          ],
          "location": {
            "file": "types.h",
            "line": 148,
            "column": 30
          },
          "group": "refs",
          "parameterTo": [
            "git_reflog_read",
            "git_reflog_write",
            "git_reference_lookup",
            "git_reference_create_symbolic",
            "git_reference_create_oid",
            "git_reference_oid",
            "git_reference_target",
            "git_reference_type",
            "git_reference_name",
            "git_reference_resolve",
            "git_reference_owner",
            "git_reference_set_target",
            "git_reference_set_oid",
            "git_reference_rename",
            "git_reference_delete",
            "git_repository_head"
          ]
        }
      },
      "info": {
        "summary": "Git reference management routines"
      }
    },
    "refspec": {
      "apis": {
        "git_refspec_src": {
          "kind": "function",
          "name": "git_refspec_src",
          "location": {
            "file": "refspec.h",
            "line": 27,
            "column": 13
          },
          "returns": {
            "type": "const char *",
            "comment": "the refspec's source specifier"
          },
          "params": [
            {
              "name": "refspec",
              "type": "const git_refspec *",
              "direction": "in",
              "comment": "the refspec"
            }
          ],
          "comment": [
            "Get the source specifier"
          ],
          "group": "refspec"
        },
        "git_refspec_dst": {
          "kind": "function",
          "name": "git_refspec_dst",
          "location": {
            "file": "refspec.h",
            "line": 35,
            "column": 13
          },
          "returns": {
            "type": "const char *",
            "comment": "the refspec's destination specifier"
          },
          "params": [
            {
              "name": "refspec",
              "type": "const git_refspec *",
              "direction": "in",
              "comment": "the refspec"
            }
          ],
          "comment": [
            "Get the destination specifier"
          ],
          "group": "refspec"
        },
        "git_refspec_src_match": {
          "kind": "function",
          "name": "git_refspec_src_match",
          "location": {
            "file": "refspec.h",
            "line": 45,
            "column": 5
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS on successful match; GIT_ENOMACH on match\n failure or an error code on other failure"
          },
          "params": [
            {
              "name": "refspec",
              "type": "const git_refspec *",
              "direction": "in",
              "comment": "the refspec"
            },
            {
              "name": "refname",
              "type": "const char *",
              "direction": "in",
              "comment": "the name of the reference to check"
            }
          ],
          "comment": [
            "Match a refspec's source descriptor with a reference name"
          ],
          "group": "refspec"
        },
        "git_refspec_transform": {
          "kind": "function",
          "name": "git_refspec_transform",
          "location": {
            "file": "refspec.h",
            "line": 56,
            "column": 5
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS, GIT_ESHORTBUFFER or another error"
          },
          "params": [
            {
              "name": "out",
              "type": "char *",
              "direction": "in",
              "comment": "where to store the target name"
            },
            {
              "name": "outlen",
              "type": "size_t",
              "direction": "in",
              "comment": "the size ouf the `out` buffer"
            },
            {
              "name": "spec",
              "type": "const git_refspec *",
              "direction": "in",
              "comment": "the refspec"
            },
            {
              "name": "name",
              "type": "const char *",
              "direction": "in",
              "comment": "the name of the reference to transform"
            }
          ],
          "comment": [
            "Transform a reference to its target following the refspec's rules"
          ],
          "group": "refspec"
        },
        "git_refspec": {
          "kind": "struct",
          "name": "git_refspec",
          "referenceName": "struct git_refspec",
          "opaque": true,
          "location": {
            "file": "types.h",
            "line": 161,
            "column": 28
          },
          "group": "refspec",
          "returnedBy": [
            "git_remote_fetchspec",
            "git_remote_pushspec"
          ],
          "parameterTo": [
            "git_refspec_src",
            "git_refspec_dst",
            "git_refspec_src_match",
            "git_refspec_transform"
          ]
        }
      },
      "info": {
        "summary": "Git refspec attributes"
      }
    },
    "remote": {
      "apis": {
        "git_remote_new": {
          "kind": "function",
          "name": "git_remote_new",
          "location": {
            "file": "remote.h",
            "line": 40,
            "column": 5
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "out",
              "type": "git_remote **",
              "direction": "in",
              "comment": "pointer to the new remote object"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "the associtated repository"
            },
            {
              "name": "url",
              "type": "const char *",
              "direction": "in",
              "comment": "the remote repository's URL"
            }
          ],
          "comment": [
            "Create a new unnamed remote",
            "Useful when you don't want to store the remote"
          ],
          "group": "remote"
        },
        "git_remote_get": {
          "kind": "function",
          "name": "git_remote_get",
          "location": {
            "file": "remote.h",
            "line": 50,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "out",
              "type": "struct git_remote **",
              "direction": "in",
              "comment": "pointer to the new remote object"
            },
            {
              "name": "cfg",
              "type": "struct git_config *",
              "direction": "in",
              "comment": "the repository's configuration"
            },
            {
              "name": "name",
              "type": "const char *",
              "direction": "in",
              "comment": "the remote's name"
            }
          ],
          "comment": [
            "Get the information for a particular remote"
          ],
          "group": "remote"
        },
        "git_remote_name": {
          "kind": "function",
          "name": "git_remote_name",
          "location": {
            "file": "remote.h",
            "line": 58,
            "column": 26
          },
          "returns": {
            "type": "const char *",
            "comment": "a pointer to the name"
          },
          "params": [
            {
              "name": "remote",
              "type": "struct git_remote *",
              "direction": "in",
              "comment": "the remote"
            }
          ],
          "comment": [
            "Get the remote's name"
          ],
          "group": "remote"
        },
        "git_remote_url": {
          "kind": "function",
          "name": "git_remote_url",
          "location": {
            "file": "remote.h",
            "line": 66,
            "column": 26
          },
          "returns": {
            "type": "const char *",
            "comment": "a pointer to the url"
          },
          "params": [
            {
              "name": "remote",
              "type": "struct git_remote *",
              "direction": "in",
              "comment": "the remote"
            }
          ],
          "comment": [
            "Get the remote's url"
          ],
          "group": "remote"
        },
        "git_remote_fetchspec": {
          "kind": "function",
          "name": "git_remote_fetchspec",
          "location": {
            "file": "remote.h",
            "line": 74,
            "column": 33
          },
          "returns": {
            "type": "const git_refspec *",
            "comment": "a pointer to the fetch refspec or NULL if it doesn't exist"
          },
          "params": [
            {
              "name": "remote",
              "type": "struct git_remote *",
              "direction": "in",
              "comment": "the remote"
            }
          ],
          "comment": [
            "Get the fetch refspec"
          ],
          "group": "remote"
        },
        "git_remote_pushspec": {
          "kind": "function",
          "name": "git_remote_pushspec",
          "location": {
            "file": "remote.h",
            "line": 83,
            "column": 33
          },
          "returns": {
            "type": "const git_refspec *",
            "comment": "a pointer to the push refspec or NULL if it doesn't exist"
          },
          "params": [
            {
              "name": "remote",
              "type": "struct git_remote *",
              "direction": "in",
              "comment": "the remote"
            }
          ],
          "comment": [
            "Get the push refspec"
          ],
          "group": "remote"
        },
        "git_remote_connect": {
          "kind": "function",
          "name": "git_remote_connect",
          "location": {
            "file": "remote.h",
            "line": 96,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "remote",
              "type": "struct git_remote *",
              "direction": "in",
              "comment": "the remote to connect to"
            },
            {
              "name": "direction",
              "type": "int",
              "direction": "in",
              "comment": "whether you want to receive or send data"
            }
          ],
          "comment": [
            "Open a connection to a remote",
            "The transport is selected based on the URL. The direction argument\n is due to a limitation of the git protocol (over TCP or SSH) which\n starts up a specific binary which can only do the one or the other."
          ],
          "group": "remote"
        },
        "git_remote_ls": {
          "kind": "function",
          "name": "git_remote_ls",
          "location": {
            "file": "remote.h",
            "line": 107,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "remote",
              "type": "git_remote *",
              "direction": "in",
              "comment": "the remote"
            },
            {
              "name": "refs",
              "type": "git_headarray *",
              "direction": "in",
              "comment": "where to store the refs"
            }
          ],
          "comment": [
            "Get a list of refs at the remote",
            "The remote (or more exactly its transport) must be connected."
          ],
          "group": "remote"
        },
        "git_remote_negotiate": {
          "kind": "function",
          "name": "git_remote_negotiate",
          "location": {
            "file": "remote.h",
            "line": 115,
            "column": 17
          },
          "returns": {
            "type": "int"
          },
          "params": [
            {
              "name": "remote",
              "type": "git_remote *",
              "direction": "in",
              "comment": "the remote you want to negotiate with"
            }
          ],
          "comment": [
            "Negotiate what data needs to be exchanged to synchroize the remtoe\n and local references"
          ],
          "group": "remote"
        },
        "git_remote_download": {
          "kind": "function",
          "name": "git_remote_download",
          "location": {
            "file": "remote.h",
            "line": 129,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "filename",
              "type": "char **",
              "direction": "in",
              "comment": "where to store the temproray filename"
            },
            {
              "name": "remote",
              "type": "git_remote *",
              "direction": "in",
              "comment": "the remote to download from"
            }
          ],
          "comment": [
            "Download the packfile",
            "The packfile is downloaded with a temporary filename, as it's final\n name is not known yet. If there was no packfile needed (all the\n objects were available locally), filename will be NULL and the\n function will return success."
          ],
          "group": "remote"
        },
        "git_remote_free": {
          "kind": "function",
          "name": "git_remote_free",
          "location": {
            "file": "remote.h",
            "line": 136,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "remote",
              "type": "struct git_remote *",
              "direction": "in",
              "comment": "the remote to free"
            }
          ],
          "comment": [
            "Free the memory associated with a remote"
          ],
          "group": "remote"
        },
        "git_remote_update_tips": {
          "kind": "function",
          "name": "git_remote_update_tips",
          "location": {
            "file": "remote.h",
            "line": 146,
            "column": 17
          },
          "returns": {
            "type": "int"
          },
          "params": [
            {
              "name": "remote",
              "type": "struct git_remote *",
              "direction": "in",
              "comment": "the remote to update"
            }
          ],
          "comment": [
            "Update the tips to the new state",
            "Make sure that you only call this once you've successfully indexed\n or expanded the packfile."
          ],
          "group": "remote"
        },
        "git_remote": {
          "kind": "struct",
          "name": "git_remote",
          "referenceName": "struct git_remote",
          "opaque": true,
          "location": {
            "file": "types.h",
            "line": 162,
            "column": 27
          },
          "group": "remote",
          "parameterTo": [
            "git_remote_new",
            "git_remote_ls",
            "git_remote_negotiate",
            "git_remote_download"
          ]
        }
      },
      "info": {
        "summary": "Git remote management functions"
      }
    },
    "repository": {
      "apis": {
        "git_repository_open": {
          "kind": "function",
          "name": "git_repository_open",
          "location": {
            "file": "repository.h",
            "line": 46,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "repository",
              "type": "git_repository **",
              "direction": "in",
              "comment": "pointer to the repo which will be opened"
            },
            {
              "name": "path",
              "type": "const char *",
              "direction": "in",
              "comment": "the path to the repository"
            }
          ],
          "comment": [
            "Open a git repository.",
            "The 'path' argument must point to an existing git repository\n folder, e.g.",
            "/path/to/my_repo/.git/\t(normal repository)\n\t\t\t\t\t\t\tobjects/\n\t\t\t\t\t\t\tindex\n\t\t\t\t\t\t\tHEAD",
            "/path/to/bare_repo/\t\t(bare repository)\n\t\t\t\t\t\tobjects/\n\t\t\t\t\t\tindex\n\t\t\t\t\t\tHEAD",
            "The method will automatically detect if 'path' is a normal\n\tor bare repository or fail is 'path' is neither."
          ],
          "group": "repository"
        },
        "git_repository_open2": {
          "kind": "function",
          "name": "git_repository_open2",
          "location": {
            "file": "repository.h",
            "line": 75,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "repository",
              "type": "git_repository **",
              "direction": "in",
              "comment": "pointer to the repo which will be opened"
            },
            {
              "name": "git_dir",
              "type": "const char *",
              "direction": "in",
              "comment": "The full path to the repository folder\n\t\te.g. a '.git' folder for live repos, any folder for bare\n\t\tEquivalent to $GIT_DIR.\n\t\tCannot be NULL."
            },
            {
              "name": "git_object_directory",
              "type": "const char *",
              "direction": "in",
              "comment": "The full path to the ODB folder.\n\t\tthe folder where all the loose and packed objects are stored\n\t\tEquivalent to $GIT_OBJECT_DIRECTORY.\n\t\tIf NULL, \"$GIT_DIR/objects/\" is assumed."
            },
            {
              "name": "git_index_file",
              "type": "const char *",
              "direction": "in",
              "comment": "The full path to the index (dircache) file\n\t\tEquivalent to $GIT_INDEX_FILE.\n\t\tIf NULL, \"$GIT_DIR/index\" is assumed."
            },
            {
              "name": "git_work_tree",
              "type": "const char *",
              "direction": "in",
              "comment": "The full path to the working tree of the repository,\n\t\tif the repository is not bare.\n\t\tEquivalent to $GIT_WORK_TREE.\n\t\tIf NULL, the repository is assumed to be bare."
            }
          ],
          "comment": [
            "Open a git repository by manually specifying all its paths"
          ],
          "group": "repository"
        },
        "git_repository_open3": {
          "kind": "function",
          "name": "git_repository_open3",
          "location": {
            "file": "repository.h",
            "line": 111,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "repository",
              "type": "git_repository **",
              "direction": "in",
              "comment": "pointer to the repo which will be opened"
            },
            {
              "name": "git_dir",
              "type": "const char *",
              "direction": "in",
              "comment": "The full path to the repository folder\n\t\te.g. a '.git' folder for live repos, any folder for bare\n\t\tEquivalent to $GIT_DIR.\n\t\tCannot be NULL."
            },
            {
              "name": "object_database",
              "type": "git_odb *",
              "direction": "in",
              "comment": "A pointer to a git_odb created \n&\n initialized\n\t\tby the user (e.g. with custom backends). This object database\n\t\twill be owned by the repository and will be automatically free'd.\n\t\tIt should not be manually free'd by the user, or this\n\t\tgit_repository object will become invalid."
            },
            {
              "name": "git_index_file",
              "type": "const char *",
              "direction": "in",
              "comment": "The full path to the index (dircache) file\n\t\tEquivalent to $GIT_INDEX_FILE.\n\t\tIf NULL, \"$GIT_DIR/index\" is assumed."
            },
            {
              "name": "git_work_tree",
              "type": "const char *",
              "direction": "in",
              "comment": "The full path to the working tree of the repository,\n\t\tif the repository is not bare.\n\t\tEquivalent to $GIT_WORK_TREE.\n\t\tIf NULL, the repository is assumed to be bare."
            }
          ],
          "comment": [
            "Open a git repository by manually specifying its paths and\n the object database it will use."
          ],
          "group": "repository"
        },
        "git_repository_discover": {
          "kind": "function",
          "name": "git_repository_discover",
          "location": {
            "file": "repository.h",
            "line": 143,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "repository_path",
              "type": "char *",
              "direction": "in",
              "comment": "The user allocated buffer which will contain the found path."
            },
            {
              "name": "size",
              "type": "size_t",
              "direction": "in",
              "comment": "repository_path size"
            },
            {
              "name": "start_path",
              "type": "const char *",
              "direction": "in",
              "comment": "The base path where the lookup starts."
            },
            {
              "name": "across_fs",
              "type": "int",
              "direction": "in",
              "comment": "If true, then the lookup will not stop when a filesystem device change\n is detected while exploring parent directories."
            },
            {
              "name": "ceiling_dirs",
              "type": "const char *",
              "direction": "in",
              "comment": "A GIT_PATH_LIST_SEPARATOR separated list of absolute symbolic link\n free paths. The lookup will stop when any of this paths is reached. Note that the\n lookup always performs on start_path no matter start_path appears in ceiling_dirs\n ceiling_dirs might be NULL (which is equivalent to an empty string)"
            }
          ],
          "comment": [
            "Look for a git repository and copy its path in the given buffer. The lookup start\n from base_path and walk across parent directories if nothing has been found. The\n lookup ends when the first repository is found, or when reaching a directory\n referenced in ceiling_dirs or when the filesystem changes (in case across_fs\n is true).",
            "The method will automatically detect if the repository is bare (if there is\n a repository)."
          ],
          "group": "repository"
        },
        "git_repository_database": {
          "kind": "function",
          "name": "git_repository_database",
          "location": {
            "file": "repository.h",
            "line": 151,
            "column": 23
          },
          "returns": {
            "type": "git_odb *",
            "comment": "a pointer to the object db"
          },
          "params": [
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "a repository object"
            }
          ],
          "comment": [
            "Get the object database behind a Git repository"
          ],
          "group": "repository"
        },
        "git_repository_index": {
          "kind": "function",
          "name": "git_repository_index",
          "location": {
            "file": "repository.h",
            "line": 171,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "index",
              "type": "git_index **",
              "direction": "in",
              "comment": "Pointer where to store the index"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "a repository object"
            }
          ],
          "comment": [
            "Open the Index file of a Git repository",
            "This returns a new and unique `git_index` object representing the\n active index for the repository.",
            "This method may be called more than once (e.g. on different threads).",
            "Each returned `git_index` object is independent and suffers no race\n conditions: synchronization is done at the FS level.",
            "Each returned `git_index` object must be manually freed by the user,\n using `git_index_free`."
          ],
          "group": "repository"
        },
        "git_repository_free": {
          "kind": "function",
          "name": "git_repository_free",
          "location": {
            "file": "repository.h",
            "line": 184,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "repository handle to close. If NULL nothing occurs."
            }
          ],
          "comment": [
            "Free a previously allocated repository",
            "Note that after a repository is free'd, all the objects it has spawned\n will still exist until they are manually closed by the user\n with `git_object_close`, but accessing any of the attributes of\n an object without a backing repository will result in undefined\n behavior"
          ],
          "group": "repository"
        },
        "git_repository_init": {
          "kind": "function",
          "name": "git_repository_init",
          "location": {
            "file": "repository.h",
            "line": 201,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "repo_out",
              "type": "git_repository **",
              "direction": "in",
              "comment": "pointer to the repo which will be created or reinitialized"
            },
            {
              "name": "path",
              "type": "const char *",
              "direction": "in",
              "comment": "the path to the repository"
            },
            {
              "name": "is_bare",
              "type": "unsigned int",
              "direction": "in",
              "comment": "if true, a Git repository without a working directory is created\n\t\tat the pointed path. If false, provided path will be considered as the working\n\t\tdirectory into which the .git directory will be created."
            }
          ],
          "comment": [
            "Creates a new Git repository in the given folder.",
            "TODO:\n\t- Reinit the repository\n\t- Create config files"
          ],
          "group": "repository"
        },
        "git_repository_head": {
          "kind": "function",
          "name": "git_repository_head",
          "location": {
            "file": "repository.h",
            "line": 211,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "0 on success; error code otherwise"
          },
          "params": [
            {
              "name": "head_out",
              "type": "git_reference **",
              "direction": "in",
              "comment": "pointer to the reference which will be retrieved"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "a repository object"
            }
          ],
          "comment": [
            "Retrieve and resolve the reference pointed at by HEAD."
          ],
          "group": "repository"
        },
        "git_repository_head_detached": {
          "kind": "function",
          "name": "git_repository_head_detached",
          "location": {
            "file": "repository.h",
            "line": 223,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "1 if HEAD is detached, 0 if i'ts not; error code if there\n was an error."
          },
          "params": [
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "Repo to test"
            }
          ],
          "comment": [
            "Check if a repository's HEAD is detached",
            "A repository's HEAD is detached when it points directly to a commit\n instead of a branch."
          ],
          "group": "repository"
        },
        "git_repository_head_orphan": {
          "kind": "function",
          "name": "git_repository_head_orphan",
          "location": {
            "file": "repository.h",
            "line": 235,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "1 if the current branch is an orphan, 0 if it's not; error\n code if therewas an error"
          },
          "params": [
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "Repo to test"
            }
          ],
          "comment": [
            "Check if the current branch is an orphan",
            "An orphan branch is one named from HEAD but which doesn't exist in\n the refs namespace, because it doesn't have any commit to point to."
          ],
          "group": "repository"
        },
        "git_repository_is_empty": {
          "kind": "function",
          "name": "git_repository_is_empty",
          "location": {
            "file": "repository.h",
            "line": 247,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "1 if the repository is empty, 0 if it isn't, error code\n if the repository is corrupted"
          },
          "params": [
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "Repo to test"
            }
          ],
          "comment": [
            "Check if a repository is empty",
            "An empty repository has just been initialized and contains\n no commits."
          ],
          "group": "repository"
        },
        "git_repository_pathid": {
          "kind": "enum",
          "name": "git_repository_pathid",
          "referenceName": "git_repository_pathid",
          "members": [
            {
              "name": "GIT_REPO_PATH"
            },
            {
              "name": "GIT_REPO_PATH_INDEX"
            },
            {
              "name": "GIT_REPO_PATH_ODB"
            },
            {
              "name": "GIT_REPO_PATH_WORKDIR"
            }
          ],
          "comment": [
            "Internal path identifiers for a repository"
          ],
          "location": {
            "file": "repository.h",
            "line": 252,
            "column": 9
          },
          "group": "repository",
          "parameterTo": [
            "git_repository_path"
          ]
        },
        "git_repository_path": {
          "kind": "function",
          "name": "git_repository_path",
          "location": {
            "file": "repository.h",
            "line": 274,
            "column": 26
          },
          "returns": {
            "type": "const char *",
            "comment": "absolute path of the requested id"
          },
          "params": [
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "a repository object"
            },
            {
              "name": "id",
              "type": "git_repository_pathid",
              "direction": "in",
              "comment": "The ID of the path to return",
              "referenceType": "enum git_repository_pathid"
            }
          ],
          "comment": [
            "Get one of the paths to the repository",
            "Possible values for `id`:",
            "GIT_REPO_PATH: return the path to the repository\n\tGIT_REPO_PATH_INDEX: return the path to the index\n\tGIT_REPO_PATH_ODB: return the path to the ODB\n\tGIT_REPO_PATH_WORKDIR: return the path to the working\n\t\tdirectory"
          ],
          "group": "repository"
        },
        "git_repository_is_bare": {
          "kind": "function",
          "name": "git_repository_is_bare",
          "location": {
            "file": "repository.h",
            "line": 282,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "1 if the repository is empty, 0 otherwise."
          },
          "params": [
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "Repo to test"
            }
          ],
          "comment": [
            "Check if a repository is bare"
          ],
          "group": "repository"
        },
        "git_repository_config": {
          "kind": "function",
          "name": "git_repository_config",
          "location": {
            "file": "repository.h",
            "line": 312,
            "column": 17
          },
          "returns": {
            "type": "int"
          },
          "params": [
            {
              "name": "out",
              "type": "git_config **",
              "direction": "in",
              "comment": "the repository's configuration"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "the repository for which to get the config"
            },
            {
              "name": "global_config_path",
              "type": "const char *"
            },
            {
              "name": "system_config_path",
              "type": "const char *",
              "direction": "in",
              "comment": "Path to the global config file"
            }
          ],
          "comment": [
            "Retrieve the relevant configuration for a repository",
            "If either the `global_config_path` or `system_config_path`\n variables are not NULL, the given config files will be also\n included in the configuration set. The global configuration file is\n located in $HOME/.gitconfig. On most UNIX systems, the system\n config file file may be found on `$sysconfdir/gitconfig`.",
            "The resulting `git_config` instance will query the files in the following\n order:",
            "- Repository configuration file\n\t- Global configuration file\n\t- System configuration file",
            "The method will fail if any of the given config files can't be\n found or accessed.",
            "The returned `git_config` instance is owned by the caller and must\n be manually free'd once it's no longer on use."
          ],
          "group": "repository"
        },
        "git_repository_config_autoload": {
          "kind": "function",
          "name": "git_repository_config_autoload",
          "location": {
            "file": "repository.h",
            "line": 328,
            "column": 17
          },
          "returns": {
            "type": "int"
          },
          "params": [
            {
              "name": "out",
              "type": "git_config **",
              "direction": "in",
              "comment": "the repository's configuration"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "the repository for which to get the config"
            }
          ],
          "comment": [
            "Automatically load the configuration files",
            "A wrapper around `git_repository_config` that tries to guess where\n the global and system config files are located. No error is\n reported if either of these files are missing at the guessed\n locations."
          ],
          "group": "repository"
        },
        "git_repository": {
          "kind": "struct",
          "name": "git_repository",
          "referenceName": "struct git_repository",
          "opaque": true,
          "comment": [
            "Representation of an existing git repository,\n including all its object contents"
          ],
          "location": {
            "file": "types.h",
            "line": 93,
            "column": 31
          },
          "group": "repository",
          "returnedBy": [
            "git_object_owner",
            "git_reference_owner",
            "git_revwalk_repository"
          ],
          "parameterTo": [
            "git_blob_lookup",
            "git_blob_lookup_prefix",
            "git_blob_create_fromfile",
            "git_blob_create_frombuffer",
            "git_commit_lookup",
            "git_commit_lookup_prefix",
            "git_commit_create",
            "git_commit_create_v",
            "git_object_lookup",
            "git_object_lookup_prefix",
            "git_reference_lookup",
            "git_reference_create_symbolic",
            "git_reference_create_oid",
            "git_reference_packall",
            "git_reference_listall",
            "git_reference_foreach",
            "git_remote_new",
            "git_repository_open",
            "git_repository_open2",
            "git_repository_open3",
            "git_repository_database",
            "git_repository_index",
            "git_repository_free",
            "git_repository_init",
            "git_repository_head",
            "git_repository_head_detached",
            "git_repository_head_orphan",
            "git_repository_is_empty",
            "git_repository_path",
            "git_repository_is_bare",
            "git_repository_config",
            "git_repository_config_autoload",
            "git_revwalk_new",
            "git_status_foreach",
            "git_status_file",
            "git_tag_lookup",
            "git_tag_lookup_prefix",
            "git_tag_create",
            "git_tag_create_frombuffer",
            "git_tag_create_lightweight",
            "git_tag_delete",
            "git_tag_list",
            "git_tag_list_match",
            "git_tree_lookup",
            "git_tree_lookup_prefix",
            "git_tree_entry_2object",
            "git_treebuilder_write"
          ]
        }
      },
      "info": {
        "summary": "Git repository management routines"
      }
    },
    "revwalk": {
      "apis": {
        "GIT_SORT_NONE": {
          "kind": "macro",
          "name": "GIT_SORT_NONE",
          "location": {
            "file": "revwalk.h",
            "line": 29,
            "column": 9
          },
          "value": "(0)",
          "comment": "Sort the repository contents in no particular ordering; this sorting is arbitrary, implementation-specific and subject to change at any time. This is the default sorting for new walkers.",
          "group": "revwalk"
        },
        "GIT_SORT_TOPOLOGICAL": {
          "kind": "macro",
          "name": "GIT_SORT_TOPOLOGICAL",
          "location": {
            "file": "revwalk.h",
            "line": 36,
            "column": 9
          },
          "value": "(1 << 0)",
          "comment": "Sort the repository contents in topological order (parents before children); this sorting mode can be combined with time sorting.",
          "group": "revwalk"
        },
        "GIT_SORT_TIME": {
          "kind": "macro",
          "name": "GIT_SORT_TIME",
          "location": {
            "file": "revwalk.h",
            "line": 43,
            "column": 9
          },
          "value": "(1 << 1)",
          "comment": "Sort the repository contents by commit time; this sorting mode can be combined with topological sorting.",
          "group": "revwalk"
        },
        "GIT_SORT_REVERSE": {
          "kind": "macro",
          "name": "GIT_SORT_REVERSE",
          "location": {
            "file": "revwalk.h",
            "line": 50,
            "column": 9
          },
          "value": "(1 << 2)",
          "comment": "Iterate through the repository contents in reverse order; this sorting mode can be combined with any of the above.",
          "group": "revwalk"
        },
        "git_revwalk_new": {
          "kind": "function",
          "name": "git_revwalk_new",
          "location": {
            "file": "revwalk.h",
            "line": 70,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "walker",
              "type": "git_revwalk **",
              "direction": "in",
              "comment": "pointer to the new revision walker"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "the repo to walk through"
            }
          ],
          "comment": [
            "Allocate a new revision walker to iterate through a repo.",
            "This revision walker uses a custom memory pool and an internal\n commit cache, so it is relatively expensive to allocate.",
            "For maximum performance, this revision walker should be\n reused for different walks.",
            "This revision walker is *not* thread safe: it may only be\n used to walk a repository on a single thread; however,\n it is possible to have several revision walkers in\n several different threads walking the same repository."
          ],
          "group": "revwalk"
        },
        "git_revwalk_reset": {
          "kind": "function",
          "name": "git_revwalk_reset",
          "location": {
            "file": "revwalk.h",
            "line": 85,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "walker",
              "type": "git_revwalk *",
              "direction": "in",
              "comment": "handle to reset."
            }
          ],
          "comment": [
            "Reset the revision walker for reuse.",
            "This will clear all the pushed and hidden commits, and\n leave the walker in a blank state (just like at\n creation) ready to receive new commit pushes and\n start a new walk.",
            "The revision walk is automatically reset when a walk\n is over."
          ],
          "group": "revwalk"
        },
        "git_revwalk_push": {
          "kind": "function",
          "name": "git_revwalk_push",
          "location": {
            "file": "revwalk.h",
            "line": 102,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "walk",
              "type": "git_revwalk *",
              "direction": "in",
              "comment": "the walker being used for the traversal."
            },
            {
              "name": "oid",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "the oid of the commit to start from."
            }
          ],
          "comment": [
            "Mark a commit to start traversal from.",
            "The given OID must belong to a commit on the walked\n repository.",
            "The given commit will be used as one of the roots\n when starting the revision walk. At least one commit\n must be pushed the repository before a walk can\n be started."
          ],
          "group": "revwalk"
        },
        "git_revwalk_hide": {
          "kind": "function",
          "name": "git_revwalk_hide",
          "location": {
            "file": "revwalk.h",
            "line": 118,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "walk",
              "type": "git_revwalk *",
              "direction": "in",
              "comment": "the walker being used for the traversal."
            },
            {
              "name": "oid",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "the oid of commit that will be ignored during the traversal"
            }
          ],
          "comment": [
            "Mark a commit (and its ancestors) uninteresting for the output.",
            "The given OID must belong to a commit on the walked\n repository.",
            "The resolved commit and all its parents will be hidden from the\n output on the revision walk."
          ],
          "group": "revwalk"
        },
        "git_revwalk_next": {
          "kind": "function",
          "name": "git_revwalk_next",
          "location": {
            "file": "revwalk.h",
            "line": 138,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS if the next commit was found;\n\tGIT_EREVWALKOVER if there are no commits left to iterate"
          },
          "params": [
            {
              "name": "oid",
              "type": "git_oid *",
              "direction": "in",
              "comment": "Pointer where to store the oid of the next commit"
            },
            {
              "name": "walk",
              "type": "git_revwalk *",
              "direction": "in",
              "comment": "the walker to pop the commit from."
            }
          ],
          "comment": [
            "Get the next commit from the revision walk.",
            "The initial call to this method is *not* blocking when\n iterating through a repo with a time-sorting mode.",
            "Iterating with Topological or inverted modes makes the initial\n call blocking to preprocess the commit list, but this block should be\n mostly unnoticeable on most repositories (topological preprocessing\n times at 0.3s on the git.git repo).",
            "The revision walker is reset when the walk is over."
          ],
          "group": "revwalk"
        },
        "git_revwalk_sorting": {
          "kind": "function",
          "name": "git_revwalk_sorting",
          "location": {
            "file": "revwalk.h",
            "line": 149,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "walk",
              "type": "git_revwalk *",
              "direction": "in",
              "comment": "the walker being used for the traversal."
            },
            {
              "name": "sort_mode",
              "type": "unsigned int",
              "direction": "in",
              "comment": "combination of GIT_SORT_XXX flags"
            }
          ],
          "comment": [
            "Change the sorting mode when iterating through the\n repository's contents.",
            "Changing the sorting mode resets the walker."
          ],
          "group": "revwalk"
        },
        "git_revwalk_free": {
          "kind": "function",
          "name": "git_revwalk_free",
          "location": {
            "file": "revwalk.h",
            "line": 156,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "walk",
              "type": "git_revwalk *",
              "direction": "in",
              "comment": "traversal handle to close. If NULL nothing occurs."
            }
          ],
          "comment": [
            "Free a revision walker previously allocated."
          ],
          "group": "revwalk"
        },
        "git_revwalk_repository": {
          "kind": "function",
          "name": "git_revwalk_repository",
          "location": {
            "file": "revwalk.h",
            "line": 165,
            "column": 30
          },
          "returns": {
            "type": "git_repository *",
            "comment": "the repository being walked"
          },
          "params": [
            {
              "name": "walk",
              "type": "git_revwalk *",
              "direction": "in",
              "comment": "the revision walker"
            }
          ],
          "comment": [
            "Return the repository on which this walker\n is operating."
          ],
          "group": "revwalk"
        },
        "git_revwalk": {
          "kind": "struct",
          "name": "git_revwalk",
          "referenceName": "struct git_revwalk",
          "opaque": true,
          "comment": [
            "Representation of an in-progress walk through the commits in a repo"
          ],
          "location": {
            "file": "types.h",
            "line": 99,
            "column": 28
          },
          "group": "revwalk",
          "parameterTo": [
            "git_revwalk_new",
            "git_revwalk_reset",
            "git_revwalk_push",
            "git_revwalk_hide",
            "git_revwalk_next",
            "git_revwalk_sorting",
            "git_revwalk_free",
            "git_revwalk_repository"
          ]
        }
      },
      "info": {
        "summary": "Git revision traversal routines"
      }
    },
    "signature": {
      "apis": {
        "git_signature_new": {
          "kind": "function",
          "name": "git_signature_new",
          "location": {
            "file": "signature.h",
            "line": 33,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "sig_out",
              "type": "git_signature **",
              "direction": "in",
              "comment": "new signature, in case of error NULL"
            },
            {
              "name": "name",
              "type": "const char *",
              "direction": "in",
              "comment": "name of the person"
            },
            {
              "name": "email",
              "type": "const char *",
              "direction": "in",
              "comment": "email of the person"
            },
            {
              "name": "time",
              "type": "git_time_t",
              "direction": "in",
              "comment": "time when the action happened",
              "referenceType": "int64_t"
            },
            {
              "name": "offset",
              "type": "int",
              "direction": "in",
              "comment": "timezone offset in minutes for the time"
            }
          ],
          "comment": [
            "Create a new action signature. The signature must be freed\n manually or using git_signature_free"
          ],
          "group": "signature"
        },
        "git_signature_now": {
          "kind": "function",
          "name": "git_signature_now",
          "location": {
            "file": "signature.h",
            "line": 44,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "sig_out",
              "type": "git_signature **",
              "direction": "in",
              "comment": "new signature, in case of error NULL"
            },
            {
              "name": "name",
              "type": "const char *",
              "direction": "in",
              "comment": "name of the person"
            },
            {
              "name": "email",
              "type": "const char *",
              "direction": "in",
              "comment": "email of the person"
            }
          ],
          "comment": [
            "Create a new action signature with a timestamp of 'now'. The\n signature must be freed manually or using git_signature_free"
          ],
          "group": "signature"
        },
        "git_signature_dup": {
          "kind": "function",
          "name": "git_signature_dup",
          "location": {
            "file": "signature.h",
            "line": 54,
            "column": 29
          },
          "returns": {
            "type": "git_signature *",
            "comment": "a copy of sig, NULL on out of memory"
          },
          "params": [
            {
              "name": "sig",
              "type": "const git_signature *",
              "direction": "in",
              "comment": "signature to duplicated"
            }
          ],
          "comment": [
            "Create a copy of an existing signature.",
            "All internal strings are also duplicated."
          ],
          "group": "signature"
        },
        "git_signature_free": {
          "kind": "function",
          "name": "git_signature_free",
          "location": {
            "file": "signature.h",
            "line": 61,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "sig",
              "type": "git_signature *",
              "direction": "in",
              "comment": "signature to free"
            }
          ],
          "comment": [
            "Free an existing signature"
          ],
          "group": "signature"
        },
        "git_signature": {
          "kind": "struct",
          "name": "git_signature",
          "referenceName": "git_signature",
          "comment": [
            "An action signature (e.g. for committers, taggers, etc)"
          ],
          "members": [
            {
              "name": "name",
              "type": "char *"
            },
            {
              "name": "email",
              "type": "char *",
              "comment": [
                "full name of the author"
              ]
            },
            {
              "name": "when",
              "type": "git_time",
              "comment": [
                "email of the author"
              ],
              "referenceType": "struct git_time"
            }
          ],
          "location": {
            "file": "types.h",
            "line": 141,
            "column": 16
          },
          "group": "signature",
          "returnedBy": [
            "git_commit_committer",
            "git_commit_author",
            "git_reflog_entry_committer",
            "git_signature_dup",
            "git_tag_tagger"
          ],
          "parameterTo": [
            "git_commit_create",
            "git_commit_create_v",
            "git_reflog_write",
            "git_signature_new",
            "git_signature_now",
            "git_signature_dup",
            "git_signature_free",
            "git_tag_create"
          ]
        }
      },
      "info": {
        "summary": "Git signature creation"
      }
    },
    "status": {
      "apis": {
        "GIT_STATUS_CURRENT": {
          "kind": "macro",
          "name": "GIT_STATUS_CURRENT",
          "location": {
            "file": "status.h",
            "line": 22,
            "column": 9
          },
          "value": "0",
          "comment": "",
          "group": "status"
        },
        "GIT_STATUS_INDEX_NEW": {
          "kind": "macro",
          "name": "GIT_STATUS_INDEX_NEW",
          "location": {
            "file": "status.h",
            "line": 24,
            "column": 9
          },
          "value": "(1 << 0)",
          "comment": "Flags for index status",
          "group": "status"
        },
        "GIT_STATUS_INDEX_MODIFIED": {
          "kind": "macro",
          "name": "GIT_STATUS_INDEX_MODIFIED",
          "location": {
            "file": "status.h",
            "line": 25,
            "column": 9
          },
          "value": "(1 << 1)",
          "comment": "",
          "group": "status"
        },
        "GIT_STATUS_INDEX_DELETED": {
          "kind": "macro",
          "name": "GIT_STATUS_INDEX_DELETED",
          "location": {
            "file": "status.h",
            "line": 26,
            "column": 9
          },
          "value": "(1 << 2)",
          "comment": "",
          "group": "status"
        },
        "GIT_STATUS_WT_NEW": {
          "kind": "macro",
          "name": "GIT_STATUS_WT_NEW",
          "location": {
            "file": "status.h",
            "line": 29,
            "column": 9
          },
          "value": "(1 << 3)",
          "comment": "Flags for worktree status",
          "group": "status"
        },
        "GIT_STATUS_WT_MODIFIED": {
          "kind": "macro",
          "name": "GIT_STATUS_WT_MODIFIED",
          "location": {
            "file": "status.h",
            "line": 30,
            "column": 9
          },
          "value": "(1 << 4)",
          "comment": "",
          "group": "status"
        },
        "GIT_STATUS_WT_DELETED": {
          "kind": "macro",
          "name": "GIT_STATUS_WT_DELETED",
          "location": {
            "file": "status.h",
            "line": 31,
            "column": 9
          },
          "value": "(1 << 5)",
          "comment": "",
          "group": "status"
        },
        "GIT_STATUS_IGNORED": {
          "kind": "macro",
          "name": "GIT_STATUS_IGNORED",
          "location": {
            "file": "status.h",
            "line": 34,
            "column": 9
          },
          "value": "(1 << 6)",
          "comment": "",
          "group": "status"
        },
        "git_status_foreach": {
          "kind": "function",
          "name": "git_status_foreach",
          "location": {
            "file": "status.h",
            "line": 47,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or the return value of the callback which did not return GIT_SUCCESS"
          },
          "params": [
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "a repository object"
            },
            {
              "name": "callback",
              "type": "int (*)(const char *, unsigned int, void *)",
              "direction": "in",
              "comment": "the function to call on each file"
            },
            {
              "name": "payload",
              "type": "void *"
            }
          ],
          "comment": [
            "Gather file statuses and run a callback for each one.",
            "The callback is passed the path of the file, the status and the data pointer\n passed to this function. If the callback returns something other than\n GIT_SUCCESS, this function will return that value."
          ],
          "group": "status"
        },
        "git_status_file": {
          "kind": "function",
          "name": "git_status_file",
          "location": {
            "file": "status.h",
            "line": 59,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_EINVALIDPATH when `path` points at a folder, GIT_ENOTFOUND when\n\t\tthe file doesn't exist in any of HEAD, the index or the worktree,\n\t\tGIT_SUCCESS otherwise"
          },
          "params": [
            {
              "name": "status_flags",
              "type": "unsigned int *",
              "direction": "in",
              "comment": "the status value"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "a repository object"
            },
            {
              "name": "path",
              "type": "const char *",
              "direction": "in",
              "comment": "the file to retrieve status for, rooted at the repo's workdir"
            }
          ],
          "comment": [
            "Get file status for a single file"
          ],
          "group": "status"
        }
      },
      "info": {
        "summary": "Git file status routines"
      }
    },
    "tag": {
      "apis": {
        "git_tag_lookup": {
          "kind": "function",
          "name": "git_tag_lookup",
          "location": {
            "file": "tag.h",
            "line": 32,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "tag",
              "type": "git_tag **",
              "direction": "in",
              "comment": "pointer to the looked up tag"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "the repo to use when locating the tag."
            },
            {
              "name": "id",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "identity of the tag to locate."
            }
          ],
          "comment": [
            "Lookup a tag object from the repository."
          ],
          "group": "tag"
        },
        "git_tag_lookup_prefix": {
          "kind": "function",
          "name": "git_tag_lookup_prefix",
          "location": {
            "file": "tag.h",
            "line": 49,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "tag",
              "type": "git_tag **",
              "direction": "in",
              "comment": "pointer to the looked up tag"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "the repo to use when locating the tag."
            },
            {
              "name": "id",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "identity of the tag to locate."
            },
            {
              "name": "len",
              "type": "unsigned int",
              "direction": "in",
              "comment": "the length of the short identifier"
            }
          ],
          "comment": [
            "Lookup a tag object from the repository,\n given a prefix of its identifier (short id)."
          ],
          "see": [
            "git_object_lookup_prefix"
          ],
          "group": "tag"
        },
        "git_tag_close": {
          "kind": "function",
          "name": "git_tag_close",
          "location": {
            "file": "tag.h",
            "line": 66,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "tag",
              "type": "git_tag *",
              "direction": "in",
              "comment": "the tag to close"
            }
          ],
          "comment": [
            "Close an open tag",
            "This is a wrapper around git_object_close()",
            "IMPORTANT:\n It *is* necessary to call this method when you stop\n using a tag. Failure to do so will cause a memory leak."
          ],
          "group": "tag"
        },
        "git_tag_id": {
          "kind": "function",
          "name": "git_tag_id",
          "location": {
            "file": "tag.h",
            "line": 78,
            "column": 29
          },
          "returns": {
            "type": "const git_oid *",
            "comment": "object identity for the tag."
          },
          "params": [
            {
              "name": "tag",
              "type": "git_tag *",
              "direction": "in",
              "comment": "a previously loaded tag."
            }
          ],
          "comment": [
            "Get the id of a tag."
          ],
          "group": "tag"
        },
        "git_tag_target": {
          "kind": "function",
          "name": "git_tag_target",
          "location": {
            "file": "tag.h",
            "line": 90,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "target",
              "type": "git_object **",
              "direction": "in",
              "comment": "pointer where to store the target"
            },
            {
              "name": "tag",
              "type": "git_tag *",
              "direction": "in",
              "comment": "a previously loaded tag."
            }
          ],
          "comment": [
            "Get the tagged object of a tag",
            "This method performs a repository lookup for the\n given object and returns it"
          ],
          "group": "tag"
        },
        "git_tag_target_oid": {
          "kind": "function",
          "name": "git_tag_target_oid",
          "location": {
            "file": "tag.h",
            "line": 98,
            "column": 29
          },
          "returns": {
            "type": "const git_oid *",
            "comment": "pointer to the OID"
          },
          "params": [
            {
              "name": "tag",
              "type": "git_tag *",
              "direction": "in",
              "comment": "a previously loaded tag."
            }
          ],
          "comment": [
            "Get the OID of the tagged object of a tag"
          ],
          "group": "tag"
        },
        "git_tag_type": {
          "kind": "function",
          "name": "git_tag_type",
          "location": {
            "file": "tag.h",
            "line": 106,
            "column": 23
          },
          "returns": {
            "type": "git_otype",
            "comment": "type of the tagged object"
          },
          "params": [
            {
              "name": "tag",
              "type": "git_tag *",
              "direction": "in",
              "comment": "a previously loaded tag."
            }
          ],
          "comment": [
            "Get the type of a tag's tagged object"
          ],
          "group": "tag"
        },
        "git_tag_name": {
          "kind": "function",
          "name": "git_tag_name",
          "location": {
            "file": "tag.h",
            "line": 114,
            "column": 26
          },
          "returns": {
            "type": "const char *",
            "comment": "name of the tag"
          },
          "params": [
            {
              "name": "tag",
              "type": "git_tag *",
              "direction": "in",
              "comment": "a previously loaded tag."
            }
          ],
          "comment": [
            "Get the name of a tag"
          ],
          "group": "tag"
        },
        "git_tag_tagger": {
          "kind": "function",
          "name": "git_tag_tagger",
          "location": {
            "file": "tag.h",
            "line": 122,
            "column": 35
          },
          "returns": {
            "type": "const git_signature *",
            "comment": "reference to the tag's author"
          },
          "params": [
            {
              "name": "tag",
              "type": "git_tag *",
              "direction": "in",
              "comment": "a previously loaded tag."
            }
          ],
          "comment": [
            "Get the tagger (author) of a tag"
          ],
          "group": "tag"
        },
        "git_tag_message": {
          "kind": "function",
          "name": "git_tag_message",
          "location": {
            "file": "tag.h",
            "line": 130,
            "column": 26
          },
          "returns": {
            "type": "const char *",
            "comment": "message of the tag"
          },
          "params": [
            {
              "name": "tag",
              "type": "git_tag *",
              "direction": "in",
              "comment": "a previously loaded tag."
            }
          ],
          "comment": [
            "Get the message of a tag"
          ],
          "group": "tag"
        },
        "git_tag_create": {
          "kind": "function",
          "name": "git_tag_create",
          "location": {
            "file": "tag.h",
            "line": 165,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code\n\tA tag object is written to the ODB, and a proper reference\n\tis written in the /refs/tags folder, pointing to it"
          },
          "params": [
            {
              "name": "oid",
              "type": "git_oid *",
              "direction": "in",
              "comment": "Pointer where to store the OID of the\n newly created tag. If the tag already exists, this parameter\n will be the oid of the existing tag, and the function will\n return a GIT_EEXISTS error code."
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "Repository where to store the tag"
            },
            {
              "name": "tag_name",
              "type": "const char *",
              "direction": "in",
              "comment": "Name for the tag; this name is validated\n for consistency. It should also not conflict with an\n already existing tag name"
            },
            {
              "name": "target",
              "type": "const git_object *",
              "direction": "in",
              "comment": "Object to which this tag points. This object\n must belong to the given `repo`."
            },
            {
              "name": "tagger",
              "type": "const git_signature *",
              "direction": "in",
              "comment": "Signature of the tagger for this tag, and\n of the tagging time"
            },
            {
              "name": "message",
              "type": "const char *",
              "direction": "in",
              "comment": "Full message for this tag"
            },
            {
              "name": "force",
              "type": "int",
              "direction": "in",
              "comment": "Overwrite existing references"
            }
          ],
          "comment": [
            "Create a new tag in the repository from an object",
            "A new reference will also be created pointing to\n this tag object. If `force` is true and a reference\n already exists with the given name, it'll be replaced."
          ],
          "group": "tag"
        },
        "git_tag_create_frombuffer": {
          "kind": "function",
          "name": "git_tag_create_frombuffer",
          "location": {
            "file": "tag.h",
            "line": 183,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "0 on sucess; error code otherwise"
          },
          "params": [
            {
              "name": "oid",
              "type": "git_oid *",
              "direction": "in",
              "comment": "Pointer where to store the OID of the newly created tag"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "Repository where to store the tag"
            },
            {
              "name": "buffer",
              "type": "const char *",
              "direction": "in",
              "comment": "Raw tag data"
            },
            {
              "name": "force",
              "type": "int",
              "direction": "in",
              "comment": "Overwrite existing tags"
            }
          ],
          "comment": [
            "Create a new tag in the repository from a buffer"
          ],
          "group": "tag"
        },
        "git_tag_create_lightweight": {
          "kind": "function",
          "name": "git_tag_create_lightweight",
          "location": {
            "file": "tag.h",
            "line": 216,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code\n\tA proper reference is written in the /refs/tags folder,\n pointing to the provided target object"
          },
          "params": [
            {
              "name": "oid",
              "type": "git_oid *",
              "direction": "in",
              "comment": "Pointer where to store the OID of the provided\n target object. If the tag already exists, this parameter\n will be filled with the oid of the existing pointed object\n and the function will return a GIT_EEXISTS error code."
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "Repository where to store the lightweight tag"
            },
            {
              "name": "tag_name",
              "type": "const char *",
              "direction": "in",
              "comment": "Name for the tag; this name is validated\n for consistency. It should also not conflict with an\n already existing tag name"
            },
            {
              "name": "target",
              "type": "const git_object *",
              "direction": "in",
              "comment": "Object to which this tag points. This object\n must belong to the given `repo`."
            },
            {
              "name": "force",
              "type": "int",
              "direction": "in",
              "comment": "Overwrite existing references"
            }
          ],
          "comment": [
            "Create a new lightweight tag pointing at a target object",
            "A new direct reference will be created pointing to\n this target object. If `force` is true and a reference\n already exists with the given name, it'll be replaced."
          ],
          "group": "tag"
        },
        "git_tag_delete": {
          "kind": "function",
          "name": "git_tag_delete",
          "location": {
            "file": "tag.h",
            "line": 233,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "Repository where lives the tag"
            },
            {
              "name": "tag_name",
              "type": "const char *",
              "direction": "in",
              "comment": "Name of the tag to be deleted;\n this name is validated for consistency."
            }
          ],
          "comment": [
            "Delete an existing tag reference."
          ],
          "group": "tag"
        },
        "git_tag_list": {
          "kind": "function",
          "name": "git_tag_list",
          "location": {
            "file": "tag.h",
            "line": 250,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "tag_names",
              "type": "git_strarray *",
              "direction": "in",
              "comment": "Pointer to a git_strarray structure where\n\t\tthe tag names will be stored"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "Repository where to find the tags"
            }
          ],
          "comment": [
            "Fill a list with all the tags in the Repository",
            "The string array will be filled with the names of the\n matching tags; these values are owned by the user and\n should be free'd manually when no longer needed, using\n `git_strarray_free`."
          ],
          "group": "tag"
        },
        "git_tag_list_match": {
          "kind": "function",
          "name": "git_tag_list_match",
          "location": {
            "file": "tag.h",
            "line": 272,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "tag_names",
              "type": "git_strarray *",
              "direction": "in",
              "comment": "Pointer to a git_strarray structure where\n\t\tthe tag names will be stored"
            },
            {
              "name": "pattern",
              "type": "const char *",
              "direction": "in",
              "comment": "Standard fnmatch pattern"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "Repository where to find the tags"
            }
          ],
          "comment": [
            "Fill a list with all the tags in the Repository\n which name match a defined pattern",
            "If an empty pattern is provided, all the tags\n will be returned.",
            "The string array will be filled with the names of the\n matching tags; these values are owned by the user and\n should be free'd manually when no longer needed, using\n `git_strarray_free`."
          ],
          "group": "tag"
        },
        "git_tag": {
          "kind": "struct",
          "name": "git_tag",
          "referenceName": "struct git_tag",
          "opaque": true,
          "comment": [
            "Parsed representation of a tag object."
          ],
          "location": {
            "file": "types.h",
            "line": 102,
            "column": 24
          },
          "group": "tag",
          "parameterTo": [
            "git_tag_lookup",
            "git_tag_lookup_prefix",
            "git_tag_close",
            "git_tag_id",
            "git_tag_target",
            "git_tag_target_oid",
            "git_tag_type",
            "git_tag_name",
            "git_tag_tagger",
            "git_tag_message"
          ]
        }
      },
      "info": {
        "summary": "Git tag parsing routines"
      }
    },
    "thread-utils": {
      "apis": {
        "GIT_HAS_TLS": {
          "kind": "macro",
          "name": "GIT_HAS_TLS",
          "location": {
            "file": "thread-utils.h",
            "line": 17,
            "column": 10
          },
          "value": "1",
          "comment": "",
          "group": "thread-utils"
        },
        "GIT_TLS": {
          "kind": "macro",
          "name": "GIT_TLS",
          "location": {
            "file": "thread-utils.h",
            "line": 22,
            "column": 11
          },
          "value": "",
          "comment": "",
          "group": "thread-utils"
        }
      },
      "info": {}
    },
    "transport": {
      "apis": {
        "git_transport_new": {
          "kind": "function",
          "name": "git_transport_new",
          "location": {
            "file": "transport.h",
            "line": 28,
            "column": 17
          },
          "returns": {
            "type": "int"
          },
          "params": [
            {
              "name": "transport",
              "type": "git_transport **"
            },
            {
              "name": "url",
              "type": "const char *",
              "direction": "in",
              "comment": "the url of the repo"
            }
          ],
          "comment": [
            "Get the appropriate transport for an URL."
          ],
          "group": "transport"
        },
        "git_transport": {
          "kind": "struct",
          "name": "git_transport",
          "referenceName": "struct git_transport",
          "opaque": true,
          "comment": [
            "A transport to use"
          ],
          "location": {
            "file": "types.h",
            "line": 165,
            "column": 30
          },
          "group": "transport",
          "parameterTo": [
            "git_transport_new",
            "git_transport_cb"
          ]
        },
        "git_transport_cb": {
          "kind": "callback",
          "name": "git_transport_cb",
          "type": "int (*)(git_transport **)",
          "location": {
            "file": "types.h",
            "line": 167,
            "column": 15
          },
          "params": [
            {
              "type": "git_transport **"
            }
          ],
          "group": "transport",
          "typedef": true
        }
      },
      "info": {
        "summary": "Git protocol transport abstraction"
      }
    },
    "tree": {
      "apis": {
        "git_tree_lookup": {
          "kind": "function",
          "name": "git_tree_lookup",
          "location": {
            "file": "tree.h",
            "line": 32,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "tree",
              "type": "git_tree **",
              "direction": "in",
              "comment": "pointer to the looked up tree"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "the repo to use when locating the tree."
            },
            {
              "name": "id",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "identity of the tree to locate."
            }
          ],
          "comment": [
            "Lookup a tree object from the repository."
          ],
          "group": "tree"
        },
        "git_tree_lookup_prefix": {
          "kind": "function",
          "name": "git_tree_lookup_prefix",
          "location": {
            "file": "tree.h",
            "line": 49,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "tree",
              "type": "git_tree **",
              "direction": "in",
              "comment": "pointer to the looked up tree"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "the repo to use when locating the tree."
            },
            {
              "name": "id",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "identity of the tree to locate."
            },
            {
              "name": "len",
              "type": "unsigned int",
              "direction": "in",
              "comment": "the length of the short identifier"
            }
          ],
          "comment": [
            "Lookup a tree object from the repository,\n given a prefix of its identifier (short id)."
          ],
          "see": [
            "git_object_lookup_prefix"
          ],
          "group": "tree"
        },
        "git_tree_close": {
          "kind": "function",
          "name": "git_tree_close",
          "location": {
            "file": "tree.h",
            "line": 66,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "tree",
              "type": "git_tree *",
              "direction": "in",
              "comment": "the tree to close"
            }
          ],
          "comment": [
            "Close an open tree",
            "This is a wrapper around git_object_close()",
            "IMPORTANT:\n It *is* necessary to call this method when you stop\n using a tree. Failure to do so will cause a memory leak."
          ],
          "group": "tree"
        },
        "git_tree_id": {
          "kind": "function",
          "name": "git_tree_id",
          "location": {
            "file": "tree.h",
            "line": 78,
            "column": 29
          },
          "returns": {
            "type": "const git_oid *",
            "comment": "object identity for the tree."
          },
          "params": [
            {
              "name": "tree",
              "type": "git_tree *",
              "direction": "in",
              "comment": "a previously loaded tree."
            }
          ],
          "comment": [
            "Get the id of a tree."
          ],
          "group": "tree"
        },
        "git_tree_entrycount": {
          "kind": "function",
          "name": "git_tree_entrycount",
          "location": {
            "file": "tree.h",
            "line": 86,
            "column": 26
          },
          "returns": {
            "type": "unsigned int",
            "comment": "the number of entries in the tree"
          },
          "params": [
            {
              "name": "tree",
              "type": "git_tree *",
              "direction": "in",
              "comment": "a previously loaded tree."
            }
          ],
          "comment": [
            "Get the number of entries listed in a tree"
          ],
          "group": "tree"
        },
        "git_tree_entry_byname": {
          "kind": "function",
          "name": "git_tree_entry_byname",
          "location": {
            "file": "tree.h",
            "line": 95,
            "column": 36
          },
          "returns": {
            "type": "const git_tree_entry *",
            "comment": "the tree entry; NULL if not found"
          },
          "params": [
            {
              "name": "tree",
              "type": "git_tree *",
              "direction": "in",
              "comment": "a previously loaded tree."
            },
            {
              "name": "filename",
              "type": "const char *",
              "direction": "in",
              "comment": "the filename of the desired entry"
            }
          ],
          "comment": [
            "Lookup a tree entry by its filename"
          ],
          "group": "tree"
        },
        "git_tree_entry_byindex": {
          "kind": "function",
          "name": "git_tree_entry_byindex",
          "location": {
            "file": "tree.h",
            "line": 104,
            "column": 36
          },
          "returns": {
            "type": "const git_tree_entry *",
            "comment": "the tree entry; NULL if not found"
          },
          "params": [
            {
              "name": "tree",
              "type": "git_tree *",
              "direction": "in",
              "comment": "a previously loaded tree."
            },
            {
              "name": "idx",
              "type": "unsigned int",
              "direction": "in",
              "comment": "the position in the entry list"
            }
          ],
          "comment": [
            "Lookup a tree entry by its position in the tree"
          ],
          "group": "tree"
        },
        "git_tree_entry_attributes": {
          "kind": "function",
          "name": "git_tree_entry_attributes",
          "location": {
            "file": "tree.h",
            "line": 112,
            "column": 26
          },
          "returns": {
            "type": "unsigned int",
            "comment": "attributes as an integer"
          },
          "params": [
            {
              "name": "entry",
              "type": "const git_tree_entry *",
              "direction": "in",
              "comment": "a tree entry"
            }
          ],
          "comment": [
            "Get the UNIX file attributes of a tree entry"
          ],
          "group": "tree"
        },
        "git_tree_entry_name": {
          "kind": "function",
          "name": "git_tree_entry_name",
          "location": {
            "file": "tree.h",
            "line": 120,
            "column": 26
          },
          "returns": {
            "type": "const char *",
            "comment": "the name of the file"
          },
          "params": [
            {
              "name": "entry",
              "type": "const git_tree_entry *",
              "direction": "in",
              "comment": "a tree entry"
            }
          ],
          "comment": [
            "Get the filename of a tree entry"
          ],
          "group": "tree"
        },
        "git_tree_entry_id": {
          "kind": "function",
          "name": "git_tree_entry_id",
          "location": {
            "file": "tree.h",
            "line": 128,
            "column": 29
          },
          "returns": {
            "type": "const git_oid *",
            "comment": "the oid of the object"
          },
          "params": [
            {
              "name": "entry",
              "type": "const git_tree_entry *",
              "direction": "in",
              "comment": "a tree entry"
            }
          ],
          "comment": [
            "Get the id of the object pointed by the entry"
          ],
          "group": "tree"
        },
        "git_tree_entry_type": {
          "kind": "function",
          "name": "git_tree_entry_type",
          "location": {
            "file": "tree.h",
            "line": 136,
            "column": 23
          },
          "returns": {
            "type": "git_otype",
            "comment": "the type of the pointed object"
          },
          "params": [
            {
              "name": "entry",
              "type": "const git_tree_entry *",
              "direction": "in",
              "comment": "a tree entry"
            }
          ],
          "comment": [
            "Get the type of the object pointed by the entry"
          ],
          "group": "tree"
        },
        "git_tree_entry_2object": {
          "kind": "function",
          "name": "git_tree_entry_2object",
          "location": {
            "file": "tree.h",
            "line": 146,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "object_out",
              "type": "git_object **"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "repository where to lookup the pointed object"
            },
            {
              "name": "entry",
              "type": "const git_tree_entry *",
              "direction": "in",
              "comment": "a tree entry"
            }
          ],
          "comment": [
            "Convert a tree entry to the git_object it points too."
          ],
          "group": "tree"
        },
        "git_tree_create_fromindex": {
          "kind": "function",
          "name": "git_tree_create_fromindex",
          "location": {
            "file": "tree.h",
            "line": 164,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "oid",
              "type": "git_oid *",
              "direction": "in",
              "comment": "Pointer where to store the written tree"
            },
            {
              "name": "index",
              "type": "git_index *",
              "direction": "in",
              "comment": "Index to write"
            }
          ],
          "comment": [
            "Write a tree to the ODB from the index file",
            "This method will scan the index and write a representation\n of its current state back to disk; it recursively creates\n tree objects for each of the subtrees stored in the index,\n but only returns the OID of the root tree. This is the OID\n that can be used e.g. to create a commit.",
            "The index instance cannot be bare, and needs to be associated\n to an existing repository."
          ],
          "group": "tree"
        },
        "git_treebuilder_create": {
          "kind": "function",
          "name": "git_treebuilder_create",
          "location": {
            "file": "tree.h",
            "line": 183,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "0 on sucess; error code otherwise"
          },
          "params": [
            {
              "name": "builder_p",
              "type": "git_treebuilder **",
              "direction": "in",
              "comment": "Pointer where to store the tree builder"
            },
            {
              "name": "source",
              "type": "const git_tree *",
              "direction": "in",
              "comment": "Source tree to initialize the builder (optional)"
            }
          ],
          "comment": [
            "Create a new tree builder.",
            "The tree builder can be used to create or modify\n trees in memory and write them as tree objects to the\n database.",
            "If the `source` parameter is not NULL, the tree builder\n will be initialized with the entries of the given tree.",
            "If the `source` parameter is NULL, the tree builder will\n have no entries and will have to be filled manually."
          ],
          "group": "tree"
        },
        "git_treebuilder_clear": {
          "kind": "function",
          "name": "git_treebuilder_clear",
          "location": {
            "file": "tree.h",
            "line": 190,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "bld",
              "type": "git_treebuilder *",
              "direction": "in",
              "comment": "Builder to clear"
            }
          ],
          "comment": [
            "Clear all the entires in the builder"
          ],
          "group": "tree"
        },
        "git_treebuilder_free": {
          "kind": "function",
          "name": "git_treebuilder_free",
          "location": {
            "file": "tree.h",
            "line": 201,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "bld",
              "type": "git_treebuilder *",
              "direction": "in",
              "comment": "Builder to free"
            }
          ],
          "comment": [
            "Free a tree builder",
            "This will clear all the entries and free to builder.\n Failing to free the builder after you're done using it\n will result in a memory leak"
          ],
          "group": "tree"
        },
        "git_treebuilder_get": {
          "kind": "function",
          "name": "git_treebuilder_get",
          "location": {
            "file": "tree.h",
            "line": 213,
            "column": 36
          },
          "returns": {
            "type": "const git_tree_entry *",
            "comment": "pointer to the entry; NULL if not found"
          },
          "params": [
            {
              "name": "bld",
              "type": "git_treebuilder *",
              "direction": "in",
              "comment": "Tree builder"
            },
            {
              "name": "filename",
              "type": "const char *",
              "direction": "in",
              "comment": "Name of the entry"
            }
          ],
          "comment": [
            "Get an entry from the builder from its filename",
            "The returned entry is owned by the builder and should\n not be freed manually."
          ],
          "group": "tree"
        },
        "git_treebuilder_insert": {
          "kind": "function",
          "name": "git_treebuilder_insert",
          "location": {
            "file": "tree.h",
            "line": 234,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "entry_out",
              "type": "git_tree_entry **",
              "direction": "in",
              "comment": "Pointer to store the entry (optional)"
            },
            {
              "name": "bld",
              "type": "git_treebuilder *",
              "direction": "in",
              "comment": "Tree builder"
            },
            {
              "name": "filename",
              "type": "const char *",
              "direction": "in",
              "comment": "Filename of the entry"
            },
            {
              "name": "id",
              "type": "const git_oid *",
              "direction": "in",
              "comment": "SHA1 oid of the entry"
            },
            {
              "name": "attributes",
              "type": "unsigned int",
              "direction": "in",
              "comment": "Folder attributes of the entry"
            }
          ],
          "comment": [
            "Add or update an entry to the builder",
            "Insert a new entry for `filename` in the builder with the\n given attributes.",
            "if an entry named `filename` already exists, its attributes\n will be updated with the given ones.",
            "The optional pointer `entry_out` can be used to retrieve a\n pointer to the newly created/updated entry."
          ],
          "group": "tree"
        },
        "git_treebuilder_remove": {
          "kind": "function",
          "name": "git_treebuilder_remove",
          "location": {
            "file": "tree.h",
            "line": 242,
            "column": 17
          },
          "returns": {
            "type": "int"
          },
          "params": [
            {
              "name": "bld",
              "type": "git_treebuilder *",
              "direction": "in",
              "comment": "Tree builder"
            },
            {
              "name": "filename",
              "type": "const char *",
              "direction": "in",
              "comment": "Filename of the entry to remove"
            }
          ],
          "comment": [
            "Remove an entry from the builder by its filename"
          ],
          "group": "tree"
        },
        "git_treebuilder_filter": {
          "kind": "function",
          "name": "git_treebuilder_filter",
          "location": {
            "file": "tree.h",
            "line": 255,
            "column": 18
          },
          "returns": {
            "type": "void"
          },
          "params": [
            {
              "name": "bld",
              "type": "git_treebuilder *",
              "direction": "in",
              "comment": "Tree builder"
            },
            {
              "name": "filter",
              "type": "int (*)(const git_tree_entry *, void *)",
              "direction": "in",
              "comment": "Callback to filter entries"
            },
            {
              "name": "payload",
              "type": "void *"
            }
          ],
          "comment": [
            "Filter the entries in the tree",
            "The `filter` callback will be called for each entry\n in the tree with a pointer to the entry and the\n provided `payload`: if the callback returns 1, the\n entry will be filtered (removed from the builder)."
          ],
          "group": "tree"
        },
        "git_treebuilder_write": {
          "kind": "function",
          "name": "git_treebuilder_write",
          "location": {
            "file": "tree.h",
            "line": 269,
            "column": 17
          },
          "returns": {
            "type": "int",
            "comment": "GIT_SUCCESS or an error code"
          },
          "params": [
            {
              "name": "oid",
              "type": "git_oid *",
              "direction": "in",
              "comment": "Pointer where to store the written OID"
            },
            {
              "name": "repo",
              "type": "git_repository *",
              "direction": "in",
              "comment": "Repository where to store the object"
            },
            {
              "name": "bld",
              "type": "git_treebuilder *",
              "direction": "in",
              "comment": "Tree builder to write"
            }
          ],
          "comment": [
            "Write the contents of the tree builder as a tree object",
            "The tree builder will be written to the given `repo`, and\n it's identifying SHA1 hash will be stored in the `oid`\n pointer."
          ],
          "group": "tree"
        },
        "git_tree_entry": {
          "kind": "struct",
          "name": "git_tree_entry",
          "referenceName": "struct git_tree_entry",
          "opaque": true,
          "comment": [
            "Representation of each one of the entries in a tree object."
          ],
          "location": {
            "file": "types.h",
            "line": 111,
            "column": 31
          },
          "group": "tree",
          "returnedBy": [
            "git_tree_entry_byname",
            "git_tree_entry_byindex",
            "git_treebuilder_get"
          ],
          "parameterTo": [
            "git_tree_entry_attributes",
            "git_tree_entry_name",
            "git_tree_entry_id",
            "git_tree_entry_type",
            "git_tree_entry_2object",
            "git_treebuilder_insert"
          ]
        },
        "git_tree": {
          "kind": "struct",
          "name": "git_tree",
          "referenceName": "struct git_tree",
          "opaque": true,
          "comment": [
            "Representation of a tree object."
          ],
          "location": {
            "file": "types.h",
            "line": 114,
            "column": 25
          },
          "group": "tree",
          "parameterTo": [
            "git_commit_tree",
            "git_commit_create",
            "git_commit_create_v",
            "git_tree_lookup",
            "git_tree_lookup_prefix",
            "git_tree_close",
            "git_tree_id",
            "git_tree_entrycount",
            "git_tree_entry_byname",
            "git_tree_entry_byindex",
            "git_treebuilder_create"
          ]
        },
        "git_treebuilder": {
          "kind": "struct",
          "name": "git_treebuilder",
          "referenceName": "struct git_treebuilder",
          "opaque": true,
          "comment": [
            "Constructor for in-memory trees"
          ],
          "location": {
            "file": "types.h",
            "line": 117,
            "column": 32
          },
          "group": "tree",
          "parameterTo": [
            "git_treebuilder_create",
            "git_treebuilder_clear",
            "git_treebuilder_free",
            "git_treebuilder_get",
            "git_treebuilder_insert",
            "git_treebuilder_remove",
            "git_treebuilder_filter",
            "git_treebuilder_write"
          ]
        }
      },
      "info": {
        "summary": "Git tree parsing, loading routines"
      }
    },
    "types": {
      "apis": {
        "git_off_t": {
          "kind": "alias",
          "name": "git_off_t",
          "type": "int64_t",
          "location": {
            "file": "types.h",
            "line": 58,
            "column": 17
          },
          "group": "types",
          "typedef": true
        },
        "git_time_t": {
          "kind": "alias",
          "name": "git_time_t",
          "type": "int64_t",
          "location": {
            "file": "types.h",
            "line": 59,
            "column": 17
          },
          "group": "types",
          "returnedBy": [
            "git_commit_time"
          ],
          "parameterTo": [
            "git_signature_new"
          ],
          "typedef": true
        },
        "git_otype": {
          "kind": "enum",
          "name": "git_otype",
          "referenceName": "git_otype",
          "members": [
            {
              "name": "GIT_OBJ_ANY",
              "value": "-2",
              "comment": [
                "Object can be any of the following"
              ]
            },
            {
              "name": "GIT_OBJ_BAD",
              "value": "-1",
              "comment": [
                "Object is invalid."
              ]
            },
            {
              "name": "GIT_OBJ__EXT1",
              "value": "0",
              "comment": [
                "Reserved for future use."
              ]
            },
            {
              "name": "GIT_OBJ_COMMIT",
              "value": "1",
              "comment": [
                "A commit object."
              ]
            },
            {
              "name": "GIT_OBJ_TREE",
              "value": "2",
              "comment": [
                "A tree (directory listing) object."
              ]
            },
            {
              "name": "GIT_OBJ_BLOB",
              "value": "3",
              "comment": [
                "A file revision object."
              ]
            },
            {
              "name": "GIT_OBJ_TAG",
              "value": "4",
              "comment": [
                "An annotated tag object."
              ]
            },
            {
              "name": "GIT_OBJ__EXT2",
              "value": "5",
              "comment": [
                "Reserved for future use."
              ]
            },
            {
              "name": "GIT_OBJ_OFS_DELTA",
              "value": "6",
              "comment": [
                "A delta, base is given by an offset."
              ]
            },
            {
              "name": "GIT_OBJ_REF_DELTA",
              "value": "7",
              "comment": [
                "A delta, base is given by object id."
              ]
            }
          ],
          "comment": [
            "Basic type (loose or packed) of any Git object."
          ],
          "location": {
            "file": "types.h",
            "line": 64,
            "column": 9
          },
          "group": "types",
          "returnedBy": [
            "git_object_type",
            "git_object_string2type",
            "git_odb_object_type",
            "git_tag_type",
            "git_tree_entry_type"
          ],
          "parameterTo": [
            "git_object_lookup",
            "git_object_lookup_prefix",
            "git_object_type2string",
            "git_object_typeisloose",
            "git_object__size",
            "git_odb_read_header",
            "git_odb_write",
            "git_odb_open_wstream",
            "git_odb_hash",
            "git_odb_hashfile"
          ]
        },
        "git_time": {
          "kind": "struct",
          "name": "git_time",
          "referenceName": "git_time",
          "comment": [
            "Time in a signature"
          ],
          "members": [
            {
              "name": "time",
              "type": "git_time_t",
              "referenceType": "int64_t"
            },
            {
              "name": "offset",
              "type": "int",
              "comment": [
                "time in seconds from epoch"
              ]
            }
          ],
          "location": {
            "file": "types.h",
            "line": 135,
            "column": 16
          },
          "group": "types"
        },
        "git_rtype": {
          "kind": "enum",
          "name": "git_rtype",
          "referenceName": "git_rtype",
          "members": [
            {
              "name": "GIT_REF_INVALID",
              "value": "0"
            },
            {
              "name": "GIT_REF_OID",
              "value": "1",
              "comment": [
                "Invalid reference"
              ]
            },
            {
              "name": "GIT_REF_SYMBOLIC",
              "value": "2",
              "comment": [
                "A reference which points at an object id"
              ]
            },
            {
              "name": "GIT_REF_PACKED",
              "value": "4",
              "comment": [
                "A reference which points at another reference"
              ]
            },
            {
              "name": "GIT_REF_HAS_PEEL",
              "value": "8",
              "comment": [
                "A reference which points at another reference"
              ]
            },
            {
              "name": "GIT_REF_LISTALL",
              "value": "7",
              "comment": [
                "A reference which points at another reference"
              ]
            }
          ],
          "comment": [
            "Basic type of any Git reference."
          ],
          "location": {
            "file": "types.h",
            "line": 151,
            "column": 9
          },
          "group": "types",
          "returnedBy": [
            "git_reference_type"
          ]
        }
      },
      "info": {
        "summary": "libgit2 base & compatibility types"
      }
    }
  }
}