[libgit2-glib] Fix building documentation
- From: Garrett Regier <gregier src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgit2-glib] Fix building documentation
- Date: Sat, 9 Jun 2012 12:05:45 +0000 (UTC)
commit 7d172fbc30e7f2062faabf2b961b58ee38a43bdd
Author: Garrett Regier <garrettregier gmail com>
Date: Sat Jun 9 04:52:03 2012 -0700
Fix building documentation
configure.ac | 2 +
docs/reference/Makefile.am | 26 +-
docs/reference/libgit2-glib-1.0-docs.sgml | 57 +++
docs/reference/libgit2-glib-1.0-sections.txt | 558 ++++++++++++++++++--------
docs/reference/libgit2-glib-1.0.types | 38 +--
docs/reference/libgit2-glib-docs.sgml | 45 --
libgit2-glib/ggit-blob.h | 7 +-
libgit2-glib/ggit-commit.c | 24 +-
libgit2-glib/ggit-commit.h | 9 +-
libgit2-glib/ggit-config.c | 2 +-
libgit2-glib/ggit-config.h | 7 +-
libgit2-glib/ggit-diff-delta.h | 1 -
libgit2-glib/ggit-diff-file.h | 1 -
libgit2-glib/ggit-diff-options.h | 1 -
libgit2-glib/ggit-diff-range.h | 1 -
libgit2-glib/ggit-diff.h | 7 +-
libgit2-glib/ggit-error.h | 7 +
libgit2-glib/ggit-index-entry-unmerged.c | 5 +-
libgit2-glib/ggit-index-entry-unmerged.h | 5 -
libgit2-glib/ggit-index-entry.c | 6 +-
libgit2-glib/ggit-index-entry.h | 5 -
libgit2-glib/ggit-index.h | 7 +-
libgit2-glib/ggit-native.h | 8 +-
libgit2-glib/ggit-object-factory-base.h | 10 +-
libgit2-glib/ggit-object-factory.c | 2 +-
libgit2-glib/ggit-object-factory.h | 10 +-
libgit2-glib/ggit-object.h | 7 +-
libgit2-glib/ggit-oid.h | 1 -
libgit2-glib/ggit-ref.c | 6 +-
libgit2-glib/ggit-ref.h | 7 +-
libgit2-glib/ggit-reflog-entry.c | 2 +-
libgit2-glib/ggit-reflog-entry.h | 1 -
libgit2-glib/ggit-reflog.c | 4 +-
libgit2-glib/ggit-reflog.h | 1 -
libgit2-glib/ggit-remote.c | 4 +-
libgit2-glib/ggit-remote.h | 1 -
libgit2-glib/ggit-repository.c | 8 +-
libgit2-glib/ggit-repository.h | 7 +-
libgit2-glib/ggit-revision-walker.h | 7 +-
libgit2-glib/ggit-signature.h | 7 +-
libgit2-glib/ggit-submodule.c | 2 +-
libgit2-glib/ggit-submodule.h | 1 -
libgit2-glib/ggit-tag.c | 2 +-
libgit2-glib/ggit-tag.h | 7 +-
libgit2-glib/ggit-tree-entry.h | 1 -
libgit2-glib/ggit-tree.h | 7 +-
libgit2-glib/ggit-types.h | 70 +++-
47 files changed, 681 insertions(+), 323 deletions(-)
---
diff --git a/configure.ac b/configure.ac
index 609a7a8..14a53de 100644
--- a/configure.ac
+++ b/configure.ac
@@ -11,6 +11,8 @@ AC_INIT([libgit2-glib],
[libgit2-glib])
AC_CONFIG_HEADERS([config.h])
+AC_CONFIG_SRCDIR([libgit2-glib/ggit-repository.c])
+AC_CONFIG_MACRO_DIR([m4])
AM_INIT_AUTOMAKE([1.11 tar-ustar dist-xz no-dist-gzip])
AM_MAINTAINER_MODE([enable])
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 77e09cd..a5ffd70 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -1,6 +1,3 @@
-GTKDOC_CFLAGS = -I$(top_srcdir) $(LIBGIT2_CFLAGS)
-GTKDOC_LIBS = $(top_builddir)/libgit2-glib/libgit2-glib-1.0.la $(LIBGIT2_LIBS)
-
## Process this file with automake to produce Makefile.in
AUTOMAKE_OPTIONS = 1.7
@@ -8,22 +5,22 @@ AUTOMAKE_OPTIONS = 1.7
DOC_MODULE = libgit2-glib-1.0
# The top-level SGML file.
-DOC_MAIN_SGML_FILE = libgit2-glib-docs.sgml
+DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.sgml
# Extra options to supply to gtkdoc-scan
SCAN_OPTIONS =
# The directory containing the source code. Relative to $(srcdir)
-DOC_SOURCE_DIR = ../..
+DOC_SOURCE_DIR = $(top_srcdir)/libgit2-glib
# Used for dependencies
HFILE_GLOB = $(top_srcdir)/libgit2-glib/*.h
CFILE_GLOB = $(top_srcdir)/libgit2-glib/*.c
# Headers to ignore
-IGNORE_HFILES = \
- config.h \
- ggit-object-private.h \
+IGNORE_HFILES = \
+ config.h \
+ ggit-convert.h \
ggit-utils.h
update-sections: $(HFILE_GLOB)
@@ -37,6 +34,17 @@ update-sections: $(HFILE_GLOB)
# Extra options to supply to gtkdoc-mkdb
MKDB_OPTIONS = --sgml-mode --output-format=xml --ignore-files=trio
+# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
+# Only needed if you are using gtkdoc-scangobj to dynamically query widget
+# signals and properties.
+GTKDOC_CFLAGS = \
+ -I$(top_srcdir) \
+ $(LIBGIT2_GLIB_CFLAGS)
+
+GTKDOC_LIBS = \
+ $(top_builddir)/libgit2-glib/libgit2-glib-1.0.la \
+ $(LIBGIT2_GLIB_LIBS)
+
# Images to copy into HTML directory
HTML_IMAGES =
@@ -52,3 +60,5 @@ include $(top_srcdir)/gtk-doc.make
# Other files to distribute
EXTRA_DIST +=
+
+# ex:set ts=8 noet:
diff --git a/docs/reference/libgit2-glib-1.0-docs.sgml b/docs/reference/libgit2-glib-1.0-docs.sgml
new file mode 100644
index 0000000..84f3daf
--- /dev/null
+++ b/docs/reference/libgit2-glib-1.0-docs.sgml
@@ -0,0 +1,57 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!ENTITY version SYSTEM "version.xml">
+]>
+<book id="index" xmlns:xi="http://www.w3.org/2001/XInclude">
+ <bookinfo>
+ <title>libgit2-glib Reference Manual</title>
+ <releaseinfo>for libgit2-glib &version;</releaseinfo>
+ </bookinfo>
+
+ <reference>
+ <title>API reference</title>
+ <xi:include href="xml/ggit-blob.xml"/>
+ <xi:include href="xml/ggit-commit.xml"/>
+ <xi:include href="xml/ggit-config.xml"/>
+ <xi:include href="xml/ggit-diff.xml"/>
+ <xi:include href="xml/ggit-diff-delta.xml"/>
+ <xi:include href="xml/ggit-diff-file.xml"/>
+ <xi:include href="xml/ggit-diff-options.xml"/>
+ <xi:include href="xml/ggit-diff-range.xml"/>
+ <xi:include href="xml/ggit-error.xml"/>
+ <xi:include href="xml/ggit-index.xml"/>
+ <xi:include href="xml/ggit-index-entry.xml"/>
+ <xi:include href="xml/ggit-index-entry-unmerged.xml"/>
+ <xi:include href="xml/ggit-main.xml"/>
+ <xi:include href="xml/ggit-native.xml"/>
+ <xi:include href="xml/ggit-object.xml"/>
+ <xi:include href="xml/ggit-object-factory.xml"/>
+ <xi:include href="xml/ggit-object-factory-base.xml"/>
+ <xi:include href="xml/ggit-oid.xml"/>
+ <xi:include href="xml/ggit-ref.xml"/>
+ <xi:include href="xml/ggit-reflog.xml"/>
+ <xi:include href="xml/ggit-reflog-entry.xml"/>
+ <xi:include href="xml/ggit-remote.xml"/>
+ <xi:include href="xml/ggit-repository.xml"/>
+ <xi:include href="xml/ggit-revision-walker.xml"/>
+ <xi:include href="xml/ggit-signature.xml"/>
+ <xi:include href="xml/ggit-submodule.xml"/>
+ <xi:include href="xml/ggit-tag.xml"/>
+ <xi:include href="xml/ggit-tree.xml"/>
+ <xi:include href="xml/ggit-tree-entry.xml"/>
+ <xi:include href="xml/ggit-types.xml"/>
+ </reference>
+
+ <index id="api-index-full">
+ <title>Index of all symbols</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </index>
+ <index id="api-index-deprecated" role="deprecated">
+ <title>Index of deprecated symbols</title>
+ <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+ </index>
+
+ <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+
+</book>
diff --git a/docs/reference/libgit2-glib-1.0-sections.txt b/docs/reference/libgit2-glib-1.0-sections.txt
index 0cf6b40..1649f93 100644
--- a/docs/reference/libgit2-glib-1.0-sections.txt
+++ b/docs/reference/libgit2-glib-1.0-sections.txt
@@ -1,57 +1,62 @@
<SECTION>
-<FILE>blob</FILE>
+<FILE>ggit-blob</FILE>
<TITLE>GgitBlob</TITLE>
-<INCLUDE>libgit2-glib/ggit-blob.h</INCLUDE>
GgitBlob
+GgitBlobClass
ggit_blob_get_raw_content
ggit_blob_get_raw_size
<SUBSECTION Standard>
-GgitBlobClass
-GGIT_TYPE_BLOB
GGIT_BLOB
-GGIT_BLOB_CONST
GGIT_BLOB_CLASS
+GGIT_BLOB_GET_CLASS
GGIT_IS_BLOB
GGIT_IS_BLOB_CLASS
-GGIT_BLOB_GET_CLASS
+GGIT_TYPE_BLOB
ggit_blob_get_type
</SECTION>
<SECTION>
-<FILE>commit</FILE>
+<FILE>ggit-commit</FILE>
<TITLE>GgitCommit</TITLE>
-<INCLUDE>libgit2-glib/ggit-commit.h</INCLUDE>
GgitCommit
+GgitCommitClass
+GgitCommitParents
ggit_commit_get_message_encoding
ggit_commit_get_message
ggit_commit_get_subject
ggit_commit_get_committer
ggit_commit_get_author
ggit_commit_get_parents
+ggit_commit_parents_ref
+ggit_commit_parents_unref
ggit_commit_parents_size
ggit_commit_parents_get
ggit_commit_parents_get_id
ggit_commit_get_tree
ggit_commit_get_tree_id
<SUBSECTION Standard>
-GgitCommitClass
-GGIT_TYPE_COMMIT
GGIT_COMMIT
-GGIT_COMMIT_CONST
GGIT_COMMIT_CLASS
+GGIT_COMMIT_GET_CLASS
GGIT_IS_COMMIT
GGIT_IS_COMMIT_CLASS
-GGIT_COMMIT_GET_CLASS
+GGIT_TYPE_COMMIT
+GgitCommitPrivate
ggit_commit_get_type
+ggit_commit_parents_get_type
</SECTION>
<SECTION>
-<FILE>config</FILE>
+<FILE>ggit-config</FILE>
<TITLE>GgitConfig</TITLE>
-<INCLUDE>libgit2-glib/ggit-config.h</INCLUDE>
GgitConfig
+GgitConfigClass
ggit_config_new
ggit_config_get_global
+ggit_config_get_int32
+ggit_config_set_int32
+ggit_config_get_int64
+ggit_config_set_int64
ggit_config_get_bool
ggit_config_set_bool
ggit_config_get_string
@@ -61,65 +66,146 @@ ggit_config_foreach
ggit_config_match
ggit_config_match_foreach
<SUBSECTION Standard>
-GgitConfigClass
-GGIT_TYPE_CONFIG
GGIT_CONFIG
-GGIT_CONFIG_CONST
GGIT_CONFIG_CLASS
+GGIT_CONFIG_GET_CLASS
GGIT_IS_CONFIG
GGIT_IS_CONFIG_CLASS
-GGIT_CONFIG_GET_CLASS
+GGIT_TYPE_CONFIG
+GgitConfigPrivate
ggit_config_get_type
</SECTION>
<SECTION>
-<FILE>error</FILE>
+<FILE>ggit-diff</FILE>
+<TITLE>GgitDiff</TITLE>
+GgitDiff
+GgitDiffClass
+ggit_diff_new_tree_to_tree
+ggit_diff_new_index_to_tree
+ggit_diff_new_workdir_to_index
+ggit_diff_new_workdir_to_tree
+ggit_diff_merge
+ggit_diff_foreach
+ggit_diff_print_compact
+ggit_diff_print_patch
+ggit_diff_blobs
+<SUBSECTION Standard>
+GGIT_DIFF
+GGIT_DIFF_CLASS
+GGIT_DIFF_GET_CLASS
+GGIT_IS_DIFF
+GGIT_IS_DIFF_CLASS
+GGIT_TYPE_DIFF
+ggit_diff_get_type
+</SECTION>
+
+<SECTION>
+<FILE>ggit-diff-delta</FILE>
+<TITLE>GgitDiffDelta</TITLE>
+GgitDiffDelta
+ggit_diff_delta_ref
+ggit_diff_delta_unref
+ggit_diff_delta_get_old_file
+ggit_diff_delta_get_new_file
+ggit_diff_delta_get_status
+ggit_diff_delta_get_similarity
+ggit_diff_delta_get_binary
+<SUBSECTION Standard>
+GGIT_DIFF_DELTA
+GGIT_TYPE_DIFF_DELTA
+ggit_diff_delta_get_type
+</SECTION>
+
+<SECTION>
+<FILE>ggit-diff-file</FILE>
+<TITLE>GgitDiffFile</TITLE>
+GgitDiffFile
+ggit_diff_file_ref
+ggit_diff_file_unref
+ggit_diff_file_get_oid
+ggit_diff_file_get_path
+ggit_diff_file_get_mode
+ggit_diff_file_get_size
+ggit_diff_file_get_flags
+<SUBSECTION Standard>
+GGIT_DIFF_FILE
+GGIT_TYPE_DIFF_FILE
+ggit_diff_file_get_type
+</SECTION>
+
+<SECTION>
+<FILE>ggit-diff-options</FILE>
+<TITLE>GgitDiffOptions</TITLE>
+GgitDiffOptions
+ggit_diff_options_copy
+ggit_diff_options_free
+ggit_diff_options_new
+<SUBSECTION Standard>
+GGIT_DIFF_OPTIONS
+GGIT_TYPE_DIFF_OPTIONS
+ggit_diff_options_get_type
+</SECTION>
+
+<SECTION>
+<FILE>ggit-diff-range</FILE>
+<TITLE>GgitDiffRange</TITLE>
+GgitDiffRange
+ggit_diff_range_ref
+ggit_diff_range_unref
+ggit_diff_range_get_old_start
+ggit_diff_range_get_old_lines
+ggit_diff_range_get_new_start
+ggit_diff_range_get_new_lines
+<SUBSECTION Standard>
+GGIT_DIFF_RANGE
+GGIT_TYPE_DIFF_RANGE
+ggit_diff_range_get_type
+</SECTION>
+
+<SECTION>
+<FILE>ggit-error</FILE>
<TITLE>GgitError</TITLE>
-<INCLUDE>libgit2-glib/ggit-error.h</INCLUDE>
-GgitError
GGIT_ERROR
ggit_error_quark
</SECTION>
<SECTION>
-<FILE>index-entry-unmerged</FILE>
-<TITLE>GgitIndexEntryUnmerged</TITLE>
-<INCLUDE>libgit2-glib/ggit-index-entry-unmerged.h</INCLUDE>
-GgitIndexEntriesUnmerged
-GgitIndexEntryUnmerged
-ggit_index_entries_unmerged_copy
-ggit_index_entries_unmerged_get
-ggit_index_entries_unmerged_get_by_file
-ggit_index_entry_unmerged_copy
-ggit_index_entries_unmerged_free
-ggit_index_entries_unmerged_size
-ggit_index_entry_unmerged_free
-ggit_index_entry_unmerged_get_mode
-ggit_index_entry_unmerged_get_id
-ggit_index_entry_unmerged_get_file
+<FILE>ggit-index</FILE>
+<TITLE>GgitIndex</TITLE>
+GgitIndex
+GgitIndexClass
+ggit_index_open
+ggit_index_read
+ggit_index_write
+ggit_index_uniq
+ggit_index_remove
+ggit_index_append
+ggit_index_add
+ggit_index_get_entries
+ggit_index_get_entries_unmerged
<SUBSECTION Standard>
-GGIT_TYPE_INDEX_ENTRY_UNMERGED
-GGIT_INDEX_ENTRY_UNMERGED
-GGIT_INDEX_ENTRY_UNMERGED_CONST
-GGIT_TYPE_INDEX_ENTRIES_UNMERGED
-GGIT_INDEX_ENTRIES_UNMERGED
-GGIT_INDEX_ENTRIES_UNMERGED_CONST
-ggit_index_entries_unmerged_get_type
-ggit_index_entry_unmerged_get_type
+GGIT_INDEX
+GGIT_INDEX_CLASS
+GGIT_INDEX_GET_CLASS
+GGIT_IS_INDEX
+GGIT_IS_INDEX_CLASS
+GGIT_TYPE_INDEX
+GgitIndexPrivate
+ggit_index_get_type
</SECTION>
<SECTION>
-<FILE>index-entry</FILE>
+<FILE>ggit-index-entry</FILE>
<TITLE>GgitIndexEntry</TITLE>
-<INCLUDE>libgit2-glib/ggit-index-entry.h</INCLUDE>
GgitIndexEntries
GgitIndexEntry
-ggit_index_entries_copy
-ggit_index_entries_free
+ggit_index_entries_ref
+ggit_index_entries_unref
ggit_index_entries_get
ggit_index_entries_size
-ggit_index_entry_copy
-ggit_index_entry_free
+ggit_index_entry_ref
+ggit_index_entry_unref
ggit_index_entry_get_dev
ggit_index_entry_get_ino
ggit_index_entry_get_mode
@@ -131,120 +217,115 @@ ggit_index_entry_get_flags
ggit_index_entry_get_flags_extended
ggit_index_entry_get_file
<SUBSECTION Standard>
-GGIT_TYPE_INDEX_ENTRY
+GGIT_INDEX_ENTRIES
GGIT_INDEX_ENTRY
-GGIT_INDEX_ENTRY_CONST
GGIT_TYPE_INDEX_ENTRIES
-GGIT_INDEX_ENTRIES
-GGIT_INDEX_ENTRIES_CONST
+GGIT_TYPE_INDEX_ENTRY
ggit_index_entries_get_type
ggit_index_entry_get_type
</SECTION>
<SECTION>
-<FILE>index</FILE>
-<TITLE>GgitIndex</TITLE>
-<INCLUDE>libgit2-glib/ggit-index.h</INCLUDE>
-GgitIndex
-ggit_index_open
-ggit_index_read
-ggit_index_write
-ggit_index_uniq
-ggit_index_remove
-ggit_index_append
-ggit_index_add
-ggit_index_get_entries
-ggit_index_get_entries_unmerged
+<FILE>ggit-index-entry-unmerged</FILE>
+<TITLE>GgitIndexEntryUnmerged</TITLE>
+GgitIndexEntriesUnmerged
+GgitIndexEntryUnmerged
+ggit_index_entries_unmerged_get
+ggit_index_entries_unmerged_get_by_file
+ggit_index_entries_unmerged_ref
+ggit_index_entries_unmerged_unref
+ggit_index_entries_unmerged_size
+ggit_index_entry_unmerged_ref
+ggit_index_entry_unmerged_unref
+ggit_index_entry_unmerged_get_mode
+ggit_index_entry_unmerged_get_id
+ggit_index_entry_unmerged_get_file
<SUBSECTION Standard>
-GgitIndexClass
-GGIT_TYPE_INDEX
-GGIT_INDEX
-GGIT_INDEX_CONST
-GGIT_INDEX_CLASS
-GGIT_IS_INDEX
-GGIT_IS_INDEX_CLASS
-GGIT_INDEX_GET_CLASS
-ggit_index_get_type
+GGIT_INDEX_ENTRIES_UNMERGED
+GGIT_INDEX_ENTRY_UNMERGED
+GGIT_TYPE_INDEX_ENTRIES_UNMERGED
+GGIT_TYPE_INDEX_ENTRY_UNMERGED
+ggit_index_entries_unmerged_get_type
+ggit_index_entry_unmerged_get_type
+</SECTION>
+
+<SECTION>
+<FILE>ggit-main</FILE>
+<TITLE>Ggit Main</TITLE>
+ggit_init
</SECTION>
<SECTION>
-<FILE>native</FILE>
+<FILE>ggit-native</FILE>
<TITLE>GgitNative</TITLE>
-<INCLUDE>libgit2-glib/ggit-native.h</INCLUDE>
GgitNative
-<SUBSECTION Standard>
GgitNativeClass
-GGIT_TYPE_NATIVE
-GGIT_NATIVE
-GGIT_NATIVE_CONST
-GGIT_NATIVE_CLASS
+<SUBSECTION Standard>
GGIT_IS_NATIVE
GGIT_IS_NATIVE_CLASS
+GGIT_NATIVE
+GGIT_NATIVE_CLASS
GGIT_NATIVE_GET_CLASS
+GGIT_TYPE_NATIVE
+GgitNativePrivate
ggit_native_get_type
</SECTION>
<SECTION>
-<FILE>object-factory-base</FILE>
-<TITLE>GgitObjectFactoryBase</TITLE>
-<INCLUDE>libgit2-glib/ggit-object-factory-base.h</INCLUDE>
-GgitObjectFactoryBase
+<FILE>ggit-object</FILE>
+<TITLE>GgitObject</TITLE>
+GgitObject
+GgitObjectClass
+ggit_object_get_id
+ggit_object_get_owner
<SUBSECTION Standard>
-GgitObjectFactoryBaseClass
-GGIT_TYPE_OBJECT_FACTORY_BASE
-GGIT_OBJECT_FACTORY_BASE
-GGIT_OBJECT_FACTORY_BASE_CONST
-GGIT_OBJECT_FACTORY_BASE_CLASS
-GGIT_IS_OBJECT_FACTORY_BASE
-GGIT_IS_OBJECT_FACTORY_BASE_CLASS
-GGIT_OBJECT_FACTORY_BASE_GET_CLASS
-ggit_object_factory_base_get_type
+GGIT_IS_OBJECT
+GGIT_IS_OBJECT_CLASS
+GGIT_OBJECT
+GGIT_OBJECT_CLASS
+GGIT_OBJECT_GET_CLASS
+GGIT_TYPE_OBJECT
+ggit_object_get_type
</SECTION>
<SECTION>
-<FILE>object-factory</FILE>
+<FILE>ggit-object-factory</FILE>
<TITLE>GgitObjectFactory</TITLE>
-<INCLUDE>libgit2-glib/ggit-object-factory.h</INCLUDE>
GgitObjectFactory
+GgitObjectFactoryClass
ggit_object_factory_get_default
ggit_object_factory_register
ggit_object_factory_unregister
ggit_object_factory_construct
<SUBSECTION Standard>
-GgitObjectFactoryClass
-GGIT_TYPE_OBJECT_FACTORY
-GGIT_OBJECT_FACTORY
-GGIT_OBJECT_FACTORY_CONST
-GGIT_OBJECT_FACTORY_CLASS
GGIT_IS_OBJECT_FACTORY
GGIT_IS_OBJECT_FACTORY_CLASS
+GGIT_OBJECT_FACTORY
+GGIT_OBJECT_FACTORY_CLASS
GGIT_OBJECT_FACTORY_GET_CLASS
+GGIT_TYPE_OBJECT_FACTORY
+GgitObjectFactoryPrivate
ggit_object_factory_get_type
</SECTION>
<SECTION>
-<FILE>object</FILE>
-<TITLE>GgitObject</TITLE>
-<INCLUDE>libgit2-glib/ggit-object.h</INCLUDE>
-GgitObject
-ggit_object_get_id
-ggit_object_get_owner
+<FILE>ggit-object-factory-base</FILE>
+<TITLE>GgitObjectFactoryBase</TITLE>
+GgitObjectFactoryBase
+GgitObjectFactoryBaseClass
<SUBSECTION Standard>
-GGIT_TYPE_OBJECT
-GGIT_OBJECT
-GGIT_OBJECT_CONST
-GGIT_OBJECT_CLASS
-GGIT_IS_OBJECT
-GGIT_IS_OBJECT_CLASS
-GGIT_OBJECT_GET_CLASS
-GgitObjectPrivate
-ggit_object_get_type
+GGIT_IS_OBJECT_FACTORY_BASE
+GGIT_IS_OBJECT_FACTORY_BASE_CLASS
+GGIT_OBJECT_FACTORY_BASE
+GGIT_OBJECT_FACTORY_BASE_CLASS
+GGIT_OBJECT_FACTORY_BASE_GET_CLASS
+GGIT_TYPE_OBJECT_FACTORY_BASE
+ggit_object_factory_base_get_type
</SECTION>
<SECTION>
-<FILE>oid</FILE>
+<FILE>ggit-oid</FILE>
<TITLE>GgitOId</TITLE>
-<INCLUDE>libgit2-glib/ggit-oid.h</INCLUDE>
GgitOId
ggit_oid_copy
ggit_oid_free
@@ -255,17 +336,16 @@ ggit_oid_to_string
ggit_oid_hash
ggit_oid_equal
<SUBSECTION Standard>
-GGIT_TYPE_OID
GGIT_OID
-GGIT_OID_CONST
+GGIT_TYPE_OID
ggit_oid_get_type
</SECTION>
<SECTION>
-<FILE>ref</FILE>
+<FILE>ggit-ref</FILE>
<TITLE>GgitRef</TITLE>
-<INCLUDE>libgit2-glib/ggit-ref.h</INCLUDE>
GgitRef
+GgitRefClass
ggit_ref_get_id
ggit_ref_get_target
ggit_ref_get_reference_type
@@ -278,29 +358,91 @@ ggit_ref_set_oid
ggit_ref_rename
ggit_ref_delete
ggit_ref_lookup
+ggit_ref_get_reflog
+ggit_ref_create_reflog
+ggit_ref_rename_reflog
+ggit_ref_delete_reflog
<SUBSECTION Standard>
-GgitRefClass
-GGIT_TYPE_REF
-GGIT_REF
-GGIT_REF_CONST
-GGIT_REF_CLASS
GGIT_IS_REF
GGIT_IS_REF_CLASS
+GGIT_REF
+GGIT_REF_CLASS
GGIT_REF_GET_CLASS
+GGIT_TYPE_REF
ggit_ref_get_type
</SECTION>
<SECTION>
-<FILE>repository</FILE>
+<FILE>ggit-reflog</FILE>
+<TITLE>GgitReflog</TITLE>
+GgitReflog
+ggit_reflog_ref
+ggit_reflog_unref
+ggit_reflog_get_entry_count
+ggit_reflog_get_entry_from_index
+<SUBSECTION Standard>
+GGIT_REFLOG
+GGIT_TYPE_REFLOG
+ggit_reflog_get_type
+</SECTION>
+
+<SECTION>
+<FILE>ggit-reflog-entry</FILE>
+<TITLE>GgitReflogEntry</TITLE>
+GgitReflogEntry
+ggit_reflog_entry_ref
+ggit_reflog_entry_unref
+ggit_reflog_entry_get_old_oid
+ggit_reflog_entry_get_new_oid
+ggit_reflog_entry_get_committer
+ggit_reflog_entry_get_message
+<SUBSECTION Standard>
+GGIT_REFLOG_ENTRY
+GGIT_TYPE_REFLOG_ENTRY
+ggit_reflog_entry_get_type
+</SECTION>
+
+<SECTION>
+<FILE>ggit-remote</FILE>
+<TITLE>GgitRemote</TITLE>
+GgitRemote
+ggit_remote_ref
+ggit_remote_unref
+ggit_remote_save
+ggit_remote_get_name
+ggit_remote_get_url
+ggit_remote_connect
+ggit_remote_get_connected
+ggit_remote_disconnect
+ggit_remote_is_valid_url
+<SUBSECTION Standard>
+GGIT_REMOTE
+GGIT_TYPE_REMOTE
+ggit_remote_get_type
+</SECTION>
+
+<SECTION>
+<FILE>ggit-repository</FILE>
<TITLE>GgitRepository</TITLE>
-<INCLUDE>libgit2-glib/ggit-repository.h</INCLUDE>
GgitRepository
+GgitRepositoryClass
ggit_repository_open
ggit_repository_init_repository
ggit_repository_lookup
ggit_repository_lookup_reference
ggit_repository_create_reference
ggit_repository_create_symbolic_reference
+ggit_repository_create_tag
+ggit_repository_create_tag_from_buffer
+ggit_repository_create_tag_lightweight
+ggit_repository_list_tags
+ggit_repository_create_branch
+ggit_repository_delete_branch
+ggit_repository_move_branch
+ggit_repository_list_branches
+ggit_repository_get_remote
+ggit_repository_add_remote
+ggit_repository_list_remotes
ggit_repository_get_head
ggit_repository_discover
ggit_repository_is_head_detached
@@ -315,96 +457,162 @@ ggit_repository_file_status_foreach
ggit_repository_references_foreach
ggit_repository_get_config
ggit_repository_get_index
+ggit_repository_lookup_submodule
+ggit_repository_submodule_foreach
+ggit_repository_reset
<SUBSECTION Standard>
-GgitRepositoryClass
-GGIT_TYPE_REPOSITORY
-GGIT_REPOSITORY
-GGIT_REPOSITORY_CONST
-GGIT_REPOSITORY_CLASS
GGIT_IS_REPOSITORY
GGIT_IS_REPOSITORY_CLASS
+GGIT_REPOSITORY
+GGIT_REPOSITORY_CLASS
GGIT_REPOSITORY_GET_CLASS
+GGIT_TYPE_REPOSITORY
GgitRepositoryPrivate
ggit_repository_get_type
</SECTION>
<SECTION>
-<FILE>signature</FILE>
+<FILE>ggit-revision-walker</FILE>
+<TITLE>GgitRevisionWalker</TITLE>
+GgitRevisionWalker
+GgitRevisionWalkerClass
+ggit_revision_walker_new
+ggit_revision_walker_reset
+ggit_revision_walker_push
+ggit_revision_walker_hide
+ggit_revision_walker_next
+ggit_revision_walker_set_sort_mode
+ggit_revision_walker_get_repository
+<SUBSECTION Standard>
+GGIT_IS_REVISION_WALKER
+GGIT_IS_REVISION_WALKER_CLASS
+GGIT_REVISION_WALKER
+GGIT_REVISION_WALKER_CLASS
+GGIT_REVISION_WALKER_GET_CLASS
+GGIT_TYPE_REVISION_WALKER
+GgitRevisionWalkerPrivate
+ggit_revision_walker_get_type
+</SECTION>
+
+<SECTION>
+<FILE>ggit-signature</FILE>
<TITLE>GgitSignature</TITLE>
-<INCLUDE>libgit2-glib/ggit-signature.h</INCLUDE>
GgitSignature
+GgitSignatureClass
ggit_signature_new
ggit_signature_new_now
-ggit_signature_copy
-ggit_signature_free
ggit_signature_get_name
ggit_signature_get_email
ggit_signature_get_time
-ggit_signature_get_time_offset
+ggit_signature_get_time_zone
<SUBSECTION Standard>
-GGIT_TYPE_SIGNATURE
+GGIT_IS_SIGNATURE
+GGIT_IS_SIGNATURE_CLASS
GGIT_SIGNATURE
-GGIT_SIGNATURE_CONST
+GGIT_SIGNATURE_CLASS
+GGIT_SIGNATURE_GET_CLASS
+GGIT_TYPE_SIGNATURE
+GgitSignaturePrivate
ggit_signature_get_type
</SECTION>
<SECTION>
-<FILE>tag</FILE>
+<FILE>ggit-submodule</FILE>
+<TITLE>GgitSubmodule</TITLE>
+GgitSubmodule
+ggit_submodule_ref
+ggit_submodule_unref
+ggit_submodule_get_name
+ggit_submodule_get_path
+ggit_submodule_get_url
+ggit_submodule_get_oid
+ggit_submodule_get_update
+ggit_submodule_get_ignore
+ggit_submodule_get_fetch_recurse
+<SUBSECTION Standard>
+GGIT_SUBMODULE
+GGIT_TYPE_SUBMODULE
+ggit_submodule_get_type
+</SECTION>
+
+<SECTION>
+<FILE>ggit-tag</FILE>
<TITLE>GgitTag</TITLE>
-<INCLUDE>libgit2-glib/ggit-tag.h</INCLUDE>
GgitTag
+GgitTagClass
ggit_tag_get_target
-ggit_tag_get_target_oid
+ggit_tag_get_target_id
ggit_tag_get_name
ggit_tag_get_tagger
ggit_tag_get_message
<SUBSECTION Standard>
-GgitTagClass
-GGIT_TYPE_TAG
-GGIT_TAG
-GGIT_TAG_CONST
-GGIT_TAG_CLASS
GGIT_IS_TAG
GGIT_IS_TAG_CLASS
+GGIT_TAG
+GGIT_TAG_CLASS
GGIT_TAG_GET_CLASS
+GGIT_TYPE_TAG
ggit_tag_get_type
</SECTION>
<SECTION>
-<FILE>tree-entry</FILE>
+<FILE>ggit-tree</FILE>
+<TITLE>GgitTree</TITLE>
+GgitTree
+GgitTreeClass
+ggit_tree_get_id
+ggit_tree_get
+ggit_tree_size
+ggit_tree_get_by_file
+<SUBSECTION Standard>
+GGIT_IS_TREE
+GGIT_IS_TREE_CLASS
+GGIT_TREE
+GGIT_TREE_CLASS
+GGIT_TREE_GET_CLASS
+GGIT_TYPE_TREE
+ggit_tree_get_type
+</SECTION>
+
+<SECTION>
+<FILE>ggit-tree-entry</FILE>
<TITLE>GgitTreeEntry</TITLE>
-<INCLUDE>libgit2-glib/ggit-tree-entry.h</INCLUDE>
GgitTreeEntry
-ggit_tree_entry_copy
-ggit_tree_entry_free
+ggit_tree_entry_ref
+ggit_tree_entry_unref
ggit_tree_entry_get_attributes
ggit_tree_entry_get_id
ggit_tree_entry_get_name
ggit_tree_entry_get_object_type
<SUBSECTION Standard>
-GGIT_TYPE_TREE_ENTRY
GGIT_TREE_ENTRY
-GGIT_TREE_ENTRY_CONST
+GGIT_TYPE_TREE_ENTRY
ggit_tree_entry_get_type
</SECTION>
<SECTION>
-<FILE>tree</FILE>
-<TITLE>GgitTree</TITLE>
-<INCLUDE>libgit2-glib/ggit-tree.h</INCLUDE>
-GgitTree
-ggit_tree_get_id
-ggit_tree_get
-ggit_tree_size
-ggit_tree_get_by_file
-<SUBSECTION Standard>
-GgitTreeClass
-GGIT_TYPE_TREE
-GGIT_TREE
-GGIT_TREE_CONST
-GGIT_TREE_CLASS
-GGIT_IS_TREE
-GGIT_IS_TREE_CLASS
-GGIT_TREE_GET_CLASS
-ggit_tree_get_type
+<FILE>ggit-types</FILE>
+<TITLE>Ggit Types</TITLE>
+GgitBranchType
+GgitCreateFlags
+GgitDeltaType
+GgitDiffFlags
+GgitDiffFileFlags
+GgitDiffLineType
+GgitError
+GgitRefType
+GgitResetType
+GgitSortMode
+GgitStatusFlags
+GgitSubmoduleIgnore
+GgitSubmoduleUpdate
+GgitConfigCallback
+GgitConfigMatchCallback
+GgitDiffFileCallback
+GgitDiffHunkCallback
+GgitDiffLineCallback
+GgitReferencesCallback
+GgitStatusCallback
+GgitSubmoduleCallback
</SECTION>
+
diff --git a/docs/reference/libgit2-glib-1.0.types b/docs/reference/libgit2-glib-1.0.types
index 2ce9e78..5c14d96 100644
--- a/docs/reference/libgit2-glib-1.0.types
+++ b/docs/reference/libgit2-glib-1.0.types
@@ -1,40 +1,30 @@
-#include <libgit2-glib/ggit-blob.h>
-#include <libgit2-glib/ggit-commit.h>
-#include <libgit2-glib/ggit-config.h>
-#include <libgit2-glib/ggit-index.h>
-#include <libgit2-glib/ggit-index-entry.h>
-#include <libgit2-glib/ggit-index-entry-unmerged.h>
-#include <libgit2-glib/ggit-native.h>
-#include <libgit2-glib/ggit-object.h>
-#include <libgit2-glib/ggit-object-factory.h>
-#include <libgit2-glib/ggit-object-factory-base.h>
-#include <libgit2-glib/ggit-oid.h>
-#include <libgit2-glib/ggit-ref.h>
-#include <libgit2-glib/ggit-repository.h>
-#include <libgit2-glib/ggit-revision-walker.h>
-#include <libgit2-glib/ggit-signature.h>
-#include <libgit2-glib/ggit-tag.h>
-#include <libgit2-glib/ggit-tree.h>
-#include <libgit2-glib/ggit-tree-entry.h>
-
ggit_blob_get_type
ggit_commit_get_type
ggit_commit_parents_get_type
ggit_config_get_type
-ggit_index_get_type
+ggit_diff_delta_get_type
+ggit_diff_file_get_type
+ggit_diff_get_type
+ggit_diff_options_get_type
+ggit_diff_range_get_type
ggit_index_entries_get_type
-ggit_index_entry_get_type
ggit_index_entries_unmerged_get_type
+ggit_index_entry_get_type
ggit_index_entry_unmerged_get_type
+ggit_index_get_type
ggit_native_get_type
-ggit_object_get_type
-ggit_object_factory_get_type
ggit_object_factory_base_get_type
+ggit_object_factory_get_type
+ggit_object_get_type
ggit_oid_get_type
ggit_ref_get_type
+ggit_reflog_entry_get_type
+ggit_reflog_get_type
+ggit_remote_get_type
ggit_repository_get_type
ggit_revision_walker_get_type
ggit_signature_get_type
+ggit_submodule_get_type
ggit_tag_get_type
-ggit_tree_get_type
ggit_tree_entry_get_type
+ggit_tree_get_type
diff --git a/libgit2-glib/ggit-blob.h b/libgit2-glib/ggit-blob.h
index a13391d..416948e 100644
--- a/libgit2-glib/ggit-blob.h
+++ b/libgit2-glib/ggit-blob.h
@@ -32,7 +32,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_BLOB (ggit_blob_get_type ())
#define GGIT_BLOB(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_BLOB, GgitBlob))
-#define GGIT_BLOB_CONST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_BLOB, GgitBlob const))
#define GGIT_BLOB_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GGIT_TYPE_BLOB, GgitBlobClass))
#define GGIT_IS_BLOB(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GGIT_TYPE_BLOB))
#define GGIT_IS_BLOB_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GGIT_TYPE_BLOB))
@@ -48,6 +47,12 @@ struct _GgitBlob
gpointer _priv;
};
+/**
+ * GgitBlobClass:
+ * @parent_class: The parent class.
+ *
+ * The class structure for #GgitBlobClass.
+ */
struct _GgitBlobClass
{
GgitObjectClass parent_class;
diff --git a/libgit2-glib/ggit-commit.c b/libgit2-glib/ggit-commit.c
index aa61735..7392532 100644
--- a/libgit2-glib/ggit-commit.c
+++ b/libgit2-glib/ggit-commit.c
@@ -59,6 +59,15 @@ ggit_commit_parents_new (GgitCommit *commit)
return ret;
}
+/**
+ * ggit_commit_parents_ref:
+ * @parents: a #GgitCommitParents.
+ *
+ * Atomically increments the reference count of @parents by one.
+ * This function is MT-safe and may be called from any thread.
+ *
+ * Returns: a #GgitCommitParents.
+ **/
GgitCommitParents *
ggit_commit_parents_ref (GgitCommitParents *parents)
{
@@ -69,6 +78,13 @@ ggit_commit_parents_ref (GgitCommitParents *parents)
return parents;
}
+/**
+ * ggit_commit_parents_unref:
+ * @parents: a #GgitCommitParents.
+ *
+ * Atomically decrements the reference count of @parents by one.
+ * If the reference count drops to 0, @parents is freed.
+ **/
void
ggit_commit_parents_unref (GgitCommitParents *parents)
{
@@ -244,7 +260,7 @@ ggit_commit_get_subject (GgitCommit *commit)
* @commit: a #GgitCommit.
*
* Gets the committer of @commit. The returned value must be free'd with
- * ggit_signature_free().
+ * g_object_unref().
*
* Returns: (transfer full): the committer of the commit.
*/
@@ -269,7 +285,7 @@ ggit_commit_get_committer (GgitCommit *commit)
* @commit: a #GgitCommit.
*
* Gets the author of @commit. The returned value must be free'd with
- * ggit_signature_free().
+ * g_object_unref().
*
* Returns: (transfer full): the author of the commit.
*/
@@ -361,7 +377,7 @@ ggit_commit_parents_get (GgitCommitParents *parents,
*
* Get the #GgitOId of a parent.
*
- * Returns: (transfer full): a #GgitOid.
+ * Returns: (transfer full): a #GgitOId.
*
**/
GgitOId *
@@ -413,7 +429,7 @@ ggit_commit_get_tree (GgitCommit *commit)
* @commit: a #GgitCommit.
*
* Get the #GgitOId of the tree of @commit. Note that this is more efficient
- * than getting the tree object with #ggit_commit_get_tree because no additional
+ * than getting the tree object with ggit_commit_get_tree() because no additional
* files need to be read from disk.
*
* Returns: (transfer full) a #GgitOId.
diff --git a/libgit2-glib/ggit-commit.h b/libgit2-glib/ggit-commit.h
index af7b7c9..0726841 100644
--- a/libgit2-glib/ggit-commit.h
+++ b/libgit2-glib/ggit-commit.h
@@ -32,7 +32,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_COMMIT (ggit_commit_get_type ())
#define GGIT_COMMIT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_COMMIT, GgitCommit))
-#define GGIT_COMMIT_CONST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_COMMIT, GgitCommit const))
#define GGIT_COMMIT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GGIT_TYPE_COMMIT, GgitCommitClass))
#define GGIT_IS_COMMIT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GGIT_TYPE_COMMIT))
#define GGIT_IS_COMMIT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GGIT_TYPE_COMMIT))
@@ -41,8 +40,6 @@ G_BEGIN_DECLS
typedef struct _GgitCommitClass GgitCommitClass;
typedef struct _GgitCommitPrivate GgitCommitPrivate;
-typedef struct _GgitCommitParents GgitCommitParents;
-
struct _GgitCommit
{
GgitObject parent;
@@ -51,6 +48,12 @@ struct _GgitCommit
GgitCommitPrivate *priv;
};
+/**
+ * GgitCommitClass:
+ * @parent_class: The parent class.
+ *
+ * The class structure for #GgitCommitClass.
+ */
struct _GgitCommitClass
{
GgitObjectClass parent_class;
diff --git a/libgit2-glib/ggit-config.c b/libgit2-glib/ggit-config.c
index dca970f..4d98b2e 100644
--- a/libgit2-glib/ggit-config.c
+++ b/libgit2-glib/ggit-config.c
@@ -164,7 +164,7 @@ ggit_config_init (GgitConfig *self)
* @file: (allow-none): a #GFile
*
* Create a new config for a given file. If %NULL is specified for @file, an
- * an empty configuration is created. See also #ggit_config_get_global to get
+ * an empty configuration is created. See also ggit_config_get_global() to get
* a config representing the global user configuration.
*
* Returns: (transfer full): a #GgitConfig
diff --git a/libgit2-glib/ggit-config.h b/libgit2-glib/ggit-config.h
index 39bcd7b..811d01b 100644
--- a/libgit2-glib/ggit-config.h
+++ b/libgit2-glib/ggit-config.h
@@ -32,7 +32,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_CONFIG (ggit_config_get_type ())
#define GGIT_CONFIG(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_CONFIG, GgitConfig))
-#define GGIT_CONFIG_CONST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_CONFIG, GgitConfig const))
#define GGIT_CONFIG_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GGIT_TYPE_CONFIG, GgitConfigClass))
#define GGIT_IS_CONFIG(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GGIT_TYPE_CONFIG))
#define GGIT_IS_CONFIG_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GGIT_TYPE_CONFIG))
@@ -48,6 +47,12 @@ struct _GgitConfig
GgitConfigPrivate *priv;
};
+/**
+ * GgitConfigClass:
+ * @parent_class: The parent class.
+ *
+ * The class structure for #GgitConfigClass.
+ */
struct _GgitConfigClass
{
GgitNativeClass parent_class;
diff --git a/libgit2-glib/ggit-diff-delta.h b/libgit2-glib/ggit-diff-delta.h
index f0d5160..7424a5c 100644
--- a/libgit2-glib/ggit-diff-delta.h
+++ b/libgit2-glib/ggit-diff-delta.h
@@ -29,7 +29,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_DIFF_DELTA (ggit_diff_delta_get_type ())
#define GGIT_DIFF_DELTA(obj) ((GgitDiffDelta *)obj)
-#define GGIT_DIFF_DELTA_CONST(obj) ((GgitDiffDelta const *)obj)
GType ggit_diff_delta_get_type (void) G_GNUC_CONST;
diff --git a/libgit2-glib/ggit-diff-file.h b/libgit2-glib/ggit-diff-file.h
index 7bc023c..7466092 100644
--- a/libgit2-glib/ggit-diff-file.h
+++ b/libgit2-glib/ggit-diff-file.h
@@ -29,7 +29,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_DIFF_FILE (ggit_diff_file_get_type ())
#define GGIT_DIFF_FILE(obj) ((GgitDiffFile *)obj)
-#define GGIT_DIFF_FILE_CONST(obj) ((GgitDiffFile const *)obj)
GType ggit_diff_file_get_type (void) G_GNUC_CONST;
diff --git a/libgit2-glib/ggit-diff-options.h b/libgit2-glib/ggit-diff-options.h
index d41f6a5..70b1d0e 100644
--- a/libgit2-glib/ggit-diff-options.h
+++ b/libgit2-glib/ggit-diff-options.h
@@ -31,7 +31,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_DIFF_OPTIONS (ggit_diff_options_get_type ())
#define GGIT_DIFF_OPTIONS(obj) ((GgitDiffOptions *)obj)
-#define GGIT_DIFF_OPTIONS_CONST(obj) ((GgitDiffOptions const *)obj)
GType ggit_diff_options_get_type (void) G_GNUC_CONST;
diff --git a/libgit2-glib/ggit-diff-range.h b/libgit2-glib/ggit-diff-range.h
index 1df4850..7367969 100644
--- a/libgit2-glib/ggit-diff-range.h
+++ b/libgit2-glib/ggit-diff-range.h
@@ -27,7 +27,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_DIFF_RANGE (ggit_diff_range_get_type ())
#define GGIT_DIFF_RANGE(obj) ((GgitDiffRange *)obj)
-#define GGIT_DIFF_RANGE_CONST(obj) ((GgitDiffRange const *)obj)
GType ggit_diff_range_get_type (void) G_GNUC_CONST;
diff --git a/libgit2-glib/ggit-diff.h b/libgit2-glib/ggit-diff.h
index 652ddc4..64d0902 100644
--- a/libgit2-glib/ggit-diff.h
+++ b/libgit2-glib/ggit-diff.h
@@ -29,7 +29,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_DIFF (ggit_diff_get_type ())
#define GGIT_DIFF(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_DIFF, GgitDiff))
-#define GGIT_DIFF_CONST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_DIFF, GgitDiff const))
#define GGIT_DIFF_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GGIT_TYPE_DIFF, GgitDiffClass))
#define GGIT_IS_DIFF(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GGIT_TYPE_DIFF))
#define GGIT_IS_DIFF_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GGIT_TYPE_DIFF))
@@ -45,6 +44,12 @@ struct _GgitDiff
gpointer priv;
};
+/**
+ * GgitDiffClass:
+ * @parent_class: The parent class.
+ *
+ * The class structure for #GgitDiffClass.
+ */
struct _GgitDiffClass
{
GgitNativeClass parent_class;
diff --git a/libgit2-glib/ggit-error.h b/libgit2-glib/ggit-error.h
index 0829077..e9ceccb 100644
--- a/libgit2-glib/ggit-error.h
+++ b/libgit2-glib/ggit-error.h
@@ -27,6 +27,13 @@
G_BEGIN_DECLS
+/**
+ * GGIT_ERROR:
+ *
+ * Error domain for Ggit. Errors in this domain will
+ * be from the GgitError enumeration. See #GError for
+ * more information on error domains.
+ */
#define GGIT_ERROR ggit_error_quark ()
GQuark ggit_error_quark (void);
diff --git a/libgit2-glib/ggit-index-entry-unmerged.c b/libgit2-glib/ggit-index-entry-unmerged.c
index 2275010..bf3c27b 100644
--- a/libgit2-glib/ggit-index-entry-unmerged.c
+++ b/libgit2-glib/ggit-index-entry-unmerged.c
@@ -152,8 +152,8 @@ ggit_index_entries_unmerged_unref (GgitIndexEntriesUnmerged *entries)
* #GgitIndexEntryUnmerged is _only_ valid as long as:
*
* 1) The associated index has been closed
- * 2) The entry has not been removed (see #ggit_index_remove)
- * 3) The index has not been refreshed (see #ggit_index_read)
+ * 2) The entry has not been removed (see ggit_index_remove())
+ * 3) The index has not been refreshed (see ggit_index_read())
*
* Returns: (transfer full): a #GgitIndexEntryUnmerged.
*
@@ -259,6 +259,7 @@ ggit_index_entry_unmerged_get_mode (GgitIndexEntryUnmerged *entry,
/**
* ggit_index_entry_unmerged_get_id:
* @entry: a #GgitIndexEntryUnmerged.
+ * @stage: the stage (0, 1 or 2)
*
* Get the oid of the index entry.
*
diff --git a/libgit2-glib/ggit-index-entry-unmerged.h b/libgit2-glib/ggit-index-entry-unmerged.h
index 10a29a5..54c9b79 100644
--- a/libgit2-glib/ggit-index-entry-unmerged.h
+++ b/libgit2-glib/ggit-index-entry-unmerged.h
@@ -30,14 +30,9 @@ G_BEGIN_DECLS
#define GGIT_TYPE_INDEX_ENTRY_UNMERGED (ggit_index_entry_unmerged_get_type ())
#define GGIT_INDEX_ENTRY_UNMERGED(obj) ((GgitIndexEntryUnmerged *)obj)
-#define GGIT_INDEX_ENTRY_UNMERGED_CONST(obj) ((GgitIndexEntryUnmerged const *)obj)
#define GGIT_TYPE_INDEX_ENTRIES_UNMERGED (ggit_index_entries_unmerged_get_type ())
#define GGIT_INDEX_ENTRIES_UNMERGED(obj) ((GgitIndexEntriesUnmerged *)obj)
-#define GGIT_INDEX_ENTRIES_UNMERGED_CONST(obj) ((GgitIndexEntriesUnmerged const *)obj)
-
-typedef struct _GgitIndexEntriesUnmerged GgitIndexEntriesUnmerged;
-typedef struct _GgitIndexEntryUnmerged GgitIndexEntryUnmerged;
GgitIndexEntriesUnmerged *
_ggit_index_entries_unmerged_new (GgitIndex *owner);
diff --git a/libgit2-glib/ggit-index-entry.c b/libgit2-glib/ggit-index-entry.c
index 11a339e..2dce962 100644
--- a/libgit2-glib/ggit-index-entry.c
+++ b/libgit2-glib/ggit-index-entry.c
@@ -152,11 +152,11 @@ ggit_index_entries_unref (GgitIndexEntries *entries)
* _only_ valid as long as:
*
* 1) The associated index has been closed
- * 2) The entry has not been removed (see #ggit_index_remove)
- * 3) The index has not been refreshed (see #ggit_index_read)
+ * 2) The entry has not been removed (see ggit_index_remove())
+ * 3) The index has not been refreshed (see ggit_index_read())
*
* Changes to the #GgitIndexEntry will be reflected in the index once written
- * back to disk using #ggit_index_write.
+ * back to disk using ggit_index_write().
*
* Returns: (transfer full): a #GgitIndexEntry.
*
diff --git a/libgit2-glib/ggit-index-entry.h b/libgit2-glib/ggit-index-entry.h
index 50867a0..c32e912 100644
--- a/libgit2-glib/ggit-index-entry.h
+++ b/libgit2-glib/ggit-index-entry.h
@@ -30,14 +30,9 @@ G_BEGIN_DECLS
#define GGIT_TYPE_INDEX_ENTRY (ggit_index_entry_get_type ())
#define GGIT_INDEX_ENTRY(obj) ((GgitIndexEntry *)obj)
-#define GGIT_INDEX_ENTRY_CONST(obj) ((GgitIndexEntry const *)obj)
#define GGIT_TYPE_INDEX_ENTRIES (ggit_index_entries_get_type ())
#define GGIT_INDEX_ENTRIES(obj) ((GgitIndexEntries *)obj)
-#define GGIT_INDEX_ENTRIES_CONST(obj) ((GgitIndexEntries const *)obj)
-
-typedef struct _GgitIndexEntries GgitIndexEntries;
-typedef struct _GgitIndexEntry GgitIndexEntry;
GType ggit_index_entries_get_type (void) G_GNUC_CONST;
GgitIndexEntries *_ggit_index_entries_new (GgitIndex *owner);
diff --git a/libgit2-glib/ggit-index.h b/libgit2-glib/ggit-index.h
index 5437d4d..1f72cc1 100644
--- a/libgit2-glib/ggit-index.h
+++ b/libgit2-glib/ggit-index.h
@@ -33,7 +33,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_INDEX (ggit_index_get_type ())
#define GGIT_INDEX(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_INDEX, GgitIndex))
-#define GGIT_INDEX_CONST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_INDEX, GgitIndex const))
#define GGIT_INDEX_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GGIT_TYPE_INDEX, GgitIndexClass))
#define GGIT_IS_INDEX(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GGIT_TYPE_INDEX))
#define GGIT_IS_INDEX_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GGIT_TYPE_INDEX))
@@ -49,6 +48,12 @@ struct _GgitIndex
GgitIndexPrivate *priv;
};
+/**
+ * GgitIndexClass:
+ * @parent_class: The parent class.
+ *
+ * The class structure for #GgitIndexClass.
+ */
struct _GgitIndexClass
{
GgitNativeClass parent_class;
diff --git a/libgit2-glib/ggit-native.h b/libgit2-glib/ggit-native.h
index 86e3ef7..ddad504 100644
--- a/libgit2-glib/ggit-native.h
+++ b/libgit2-glib/ggit-native.h
@@ -28,13 +28,11 @@ G_BEGIN_DECLS
#define GGIT_TYPE_NATIVE (ggit_native_get_type ())
#define GGIT_NATIVE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_NATIVE, GgitNative))
-#define GGIT_NATIVE_CONST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_NATIVE, GgitNative const))
#define GGIT_NATIVE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GGIT_TYPE_NATIVE, GgitNativeClass))
#define GGIT_IS_NATIVE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GGIT_TYPE_NATIVE))
#define GGIT_IS_NATIVE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GGIT_TYPE_NATIVE))
#define GGIT_NATIVE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GGIT_TYPE_NATIVE, GgitNativeClass))
-typedef struct _GgitNative GgitNative;
typedef struct _GgitNativeClass GgitNativeClass;
typedef struct _GgitNativePrivate GgitNativePrivate;
@@ -45,6 +43,12 @@ struct _GgitNative
GgitNativePrivate *priv;
};
+/**
+ * GgitNativeClass:
+ * @parent_class: The parent class.
+ *
+ * The class structure for #GgitNativeClass.
+ */
struct _GgitNativeClass
{
GgitObjectFactoryBaseClass parent_class;
diff --git a/libgit2-glib/ggit-object-factory-base.h b/libgit2-glib/ggit-object-factory-base.h
index 472fe52..88de4ee 100644
--- a/libgit2-glib/ggit-object-factory-base.h
+++ b/libgit2-glib/ggit-object-factory-base.h
@@ -23,17 +23,17 @@
#include <glib-object.h>
+#include "ggit-types.h"
+
G_BEGIN_DECLS
#define GGIT_TYPE_OBJECT_FACTORY_BASE (ggit_object_factory_base_get_type ())
#define GGIT_OBJECT_FACTORY_BASE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_OBJECT_FACTORY_BASE, GgitObjectFactoryBase))
-#define GGIT_OBJECT_FACTORY_BASE_CONST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_OBJECT_FACTORY_BASE, GgitObjectFactoryBase const))
#define GGIT_OBJECT_FACTORY_BASE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GGIT_TYPE_OBJECT_FACTORY_BASE, GgitObjectFactoryBaseClass))
#define GGIT_IS_OBJECT_FACTORY_BASE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GGIT_TYPE_OBJECT_FACTORY_BASE))
#define GGIT_IS_OBJECT_FACTORY_BASE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GGIT_TYPE_OBJECT_FACTORY_BASE))
#define GGIT_OBJECT_FACTORY_BASE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GGIT_TYPE_OBJECT_FACTORY_BASE, GgitObjectFactoryBaseClass))
-typedef struct _GgitObjectFactoryBase GgitObjectFactoryBase;
typedef struct _GgitObjectFactoryBaseClass GgitObjectFactoryBaseClass;
struct _GgitObjectFactoryBase
@@ -41,6 +41,12 @@ struct _GgitObjectFactoryBase
GObject parent;
};
+/**
+ * GgitObjectFactoryBaseClass:
+ * @parent_class: The parent class.
+ *
+ * The class structure for #GgitObjectFactoryBaseClass.
+ */
struct _GgitObjectFactoryBaseClass
{
GObjectClass parent_class;
diff --git a/libgit2-glib/ggit-object-factory.c b/libgit2-glib/ggit-object-factory.c
index f1acf66..d4710a1 100644
--- a/libgit2-glib/ggit-object-factory.c
+++ b/libgit2-glib/ggit-object-factory.c
@@ -138,7 +138,7 @@ ggit_object_factory_get_default (void)
*
* Register @subtype as the instantiation class for @basetype. Each time an
* object of type @basetype is going to be created, an instance of @subtype
- * is created instead. @basetype must be subclassed from #GgitObjectFactoryObject.
+ * is created instead. @basetype must be subclassed from #GgitObjectFactoryBase.
*
**/
void
diff --git a/libgit2-glib/ggit-object-factory.h b/libgit2-glib/ggit-object-factory.h
index 31ac985..7273ba8 100644
--- a/libgit2-glib/ggit-object-factory.h
+++ b/libgit2-glib/ggit-object-factory.h
@@ -23,17 +23,17 @@
#include <glib-object.h>
+#include "ggit-types.h"
+
G_BEGIN_DECLS
#define GGIT_TYPE_OBJECT_FACTORY (ggit_object_factory_get_type ())
#define GGIT_OBJECT_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_OBJECT_FACTORY, GgitObjectFactory))
-#define GGIT_OBJECT_FACTORY_CONST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_OBJECT_FACTORY, GgitObjectFactory const))
#define GGIT_OBJECT_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GGIT_TYPE_OBJECT_FACTORY, GgitObjectFactoryClass))
#define GGIT_IS_OBJECT_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GGIT_TYPE_OBJECT_FACTORY))
#define GGIT_IS_OBJECT_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GGIT_TYPE_OBJECT_FACTORY))
#define GGIT_OBJECT_FACTORY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GGIT_TYPE_OBJECT_FACTORY, GgitObjectFactoryClass))
-typedef struct _GgitObjectFactory GgitObjectFactory;
typedef struct _GgitObjectFactoryClass GgitObjectFactoryClass;
typedef struct _GgitObjectFactoryPrivate GgitObjectFactoryPrivate;
@@ -44,6 +44,12 @@ struct _GgitObjectFactory
GgitObjectFactoryPrivate *priv;
};
+/**
+ * GgitObjectFactoryClass:
+ * @parent_class: The parent class.
+ *
+ * The class structure for #GgitObjectFactoryClass.
+ */
struct _GgitObjectFactoryClass
{
GObjectClass parent_class;
diff --git a/libgit2-glib/ggit-object.h b/libgit2-glib/ggit-object.h
index 1e2bcb2..7473742 100644
--- a/libgit2-glib/ggit-object.h
+++ b/libgit2-glib/ggit-object.h
@@ -32,7 +32,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_OBJECT (ggit_object_get_type ())
#define GGIT_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_OBJECT, GgitObject))
-#define GGIT_OBJECT_CONST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_OBJECT, GgitObject const))
#define GGIT_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GGIT_TYPE_OBJECT, GgitObjectClass))
#define GGIT_IS_OBJECT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GGIT_TYPE_OBJECT))
#define GGIT_IS_OBJECT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GGIT_TYPE_OBJECT))
@@ -48,6 +47,12 @@ struct _GgitObject
gpointer _priv;
};
+/**
+ * GgitObjectClass:
+ * @parent_class: The parent class.
+ *
+ * The class structure for #GgitObjectClass.
+ */
struct _GgitObjectClass
{
GgitNativeClass parent_class;
diff --git a/libgit2-glib/ggit-oid.h b/libgit2-glib/ggit-oid.h
index 23cd776..da6a544 100644
--- a/libgit2-glib/ggit-oid.h
+++ b/libgit2-glib/ggit-oid.h
@@ -31,7 +31,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_OID (ggit_oid_get_type ())
#define GGIT_OID(obj) ((GgitOId *)obj)
-#define GGIT_OID_CONST(obj) ((GgitOId const *)obj)
GType ggit_oid_get_type (void) G_GNUC_CONST;
diff --git a/libgit2-glib/ggit-ref.c b/libgit2-glib/ggit-ref.c
index 89e9784..336d29c 100644
--- a/libgit2-glib/ggit-ref.c
+++ b/libgit2-glib/ggit-ref.c
@@ -93,11 +93,11 @@ ggit_ref_get_target (GgitRef *ref)
}
/**
- * ggit_ref_get_type:
+ * ggit_ref_get_reference_type:
* @ref: a #GgitRef.
*
- * Gets the type of @ref. Either direct (GGIT_REF_OID) or
- * symbolic (GGIT_REF_SYMBOLIC).
+ * Gets the type of @ref. Either direct (#GGIT_REF_OID) or
+ * symbolic (#GGIT_REF_SYMBOLIC).
*
* Returns: the type of a reference.
*/
diff --git a/libgit2-glib/ggit-ref.h b/libgit2-glib/ggit-ref.h
index 486cd20..cde371f 100644
--- a/libgit2-glib/ggit-ref.h
+++ b/libgit2-glib/ggit-ref.h
@@ -30,7 +30,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_REF (ggit_ref_get_type ())
#define GGIT_REF(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_REF, GgitRef))
-#define GGIT_REF_CONST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_REF, GgitRef const))
#define GGIT_REF_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GGIT_TYPE_REF, GgitRefClass))
#define GGIT_IS_REF(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GGIT_TYPE_REF))
#define GGIT_IS_REF_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GGIT_TYPE_REF))
@@ -46,6 +45,12 @@ struct _GgitRef
gpointer *_priv;
};
+/**
+ * GgitRefClass:
+ * @parent_class: The parent class.
+ *
+ * The class structure for #GgitRefClass.
+ */
struct _GgitRefClass
{
GgitNativeClass parent_class;
diff --git a/libgit2-glib/ggit-reflog-entry.c b/libgit2-glib/ggit-reflog-entry.c
index fa2ba51..74ccad7 100644
--- a/libgit2-glib/ggit-reflog-entry.c
+++ b/libgit2-glib/ggit-reflog-entry.c
@@ -65,7 +65,7 @@ ggit_reflog_entry_ref (GgitReflogEntry *reflog_entry)
/**
* ggit_reflog_entry_unref:
- * reflog_entry: a #GgitReflogEntry.
+ * @reflog_entry: a #GgitReflogEntry.
*
* Atomically decrements the reference count of @reflog_entry by one.
* If the reference count drops to 0, @reflog_entry is freed.
diff --git a/libgit2-glib/ggit-reflog-entry.h b/libgit2-glib/ggit-reflog-entry.h
index 546613b..067115c 100644
--- a/libgit2-glib/ggit-reflog-entry.h
+++ b/libgit2-glib/ggit-reflog-entry.h
@@ -29,7 +29,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_REFLOG_ENTRY (ggit_reflog_entry_get_type ())
#define GGIT_REFLOG_ENTRY(obj) ((GgitReflogEntry *)obj)
-#define GGIT_REFLOG_ENTRY_CONST(obj) ((GgitReflogEntry const *)obj)
GType ggit_reflog_entry_get_type (void) G_GNUC_CONST;
diff --git a/libgit2-glib/ggit-reflog.c b/libgit2-glib/ggit-reflog.c
index f64e562..fe0f23e 100644
--- a/libgit2-glib/ggit-reflog.c
+++ b/libgit2-glib/ggit-reflog.c
@@ -63,7 +63,7 @@ ggit_reflog_ref (GgitReflog *reflog)
/**
* ggit_reflog_unref:
- * reflog: a #GgitReflog.
+ * @reflog: a #GgitReflog.
*
* Atomically decrements the reference count of @reflog by one.
* If the reference count drops to 0, @reflog is freed.
@@ -97,7 +97,7 @@ ggit_reflog_get_entry_count (GgitReflog *reflog)
}
/**
- * ggit_reflog_get_from_index:
+ * ggit_reflog_get_entry_from_index:
* @reflog: a #GgitReflog.
* @idx: the position to lookup.
*
diff --git a/libgit2-glib/ggit-reflog.h b/libgit2-glib/ggit-reflog.h
index 3dfac18..8c88c01 100644
--- a/libgit2-glib/ggit-reflog.h
+++ b/libgit2-glib/ggit-reflog.h
@@ -29,7 +29,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_REFLOG (ggit_reflog_get_type ())
#define GGIT_REFLOG(obj) ((GgitReflog *)obj)
-#define GGIT_REFLOG_CONST(obj) ((GgitReflog const *)obj)
GType ggit_reflog_get_type (void) G_GNUC_CONST;
diff --git a/libgit2-glib/ggit-remote.c b/libgit2-glib/ggit-remote.c
index 009967c..06e2a57 100644
--- a/libgit2-glib/ggit-remote.c
+++ b/libgit2-glib/ggit-remote.c
@@ -65,7 +65,7 @@ ggit_remote_ref (GgitRemote *remote)
/**
* ggit_remote_unref:
- * remote: a #GgitRemote.
+ * @remote: a #GgitRemote.
*
* Atomically decrements the reference count of @remote by one.
* If the reference count drops to 0, @remote is freed.
@@ -168,7 +168,7 @@ ggit_remote_connect (GgitRemote *remote,
}
/**
- * ggit_remote_connected:
+ * ggit_remote_get_connected:
* @remote: a #GgitRemote.
*
* Check whether @remote is connected.
diff --git a/libgit2-glib/ggit-remote.h b/libgit2-glib/ggit-remote.h
index af4c098..bbf98d9 100644
--- a/libgit2-glib/ggit-remote.h
+++ b/libgit2-glib/ggit-remote.h
@@ -30,7 +30,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_REMOTE (ggit_remote_get_type ())
#define GGIT_REMOTE(obj) ((GgitRemote *)obj)
-#define GGIT_REMOTE_CONST(obj) ((GgitRemote const *)obj)
GType ggit_remote_get_type (void) G_GNUC_CONST;
diff --git a/libgit2-glib/ggit-repository.c b/libgit2-glib/ggit-repository.c
index 7a6182a..ce16986 100644
--- a/libgit2-glib/ggit-repository.c
+++ b/libgit2-glib/ggit-repository.c
@@ -477,7 +477,7 @@ ggit_repository_lookup (GgitRepository *repository,
* @error: a #GError for error reporting, or %NULL.
*
* Lookups a reference by its name in @repository. The returned #GgitRef must
- * be freed with ggit_ref_free().
+ * be freed with g_object_unref().
*
* Returns: (transfer full): the searched reference.
*/
@@ -518,7 +518,7 @@ ggit_repository_lookup_reference (GgitRepository *repository,
* Creates a new object id reference.
*
* The reference will be created in the repository and written
- * to the disk. The returned value must be freed with ggit_ref_free().
+ * to the disk. The returned value must be freed with g_object_unref().
*
* Returns: (transfer full): the newly created reference.
*/
@@ -561,7 +561,7 @@ ggit_repository_create_reference (GgitRepository *repository,
* Creates a new symbolic reference.
*
* The reference will be created in the repository and written
- * to the disk. The returned value must be freed with ggit_ref_free().
+ * to the disk. The returned value must be freed with g_object_unref().
*
* Returns: (transfer full): the newly created reference.
*/
@@ -1560,7 +1560,7 @@ ggit_repository_submodule_foreach (GgitRepository *repository,
}
/**
- * ggit_respository_reset:
+ * ggit_repository_reset:
* @repository: a #GgitRepository.
* @target: the target #GgitObject which is a commit or a tag.
* @reset_type: the #GgitResetType to perform.
diff --git a/libgit2-glib/ggit-repository.h b/libgit2-glib/ggit-repository.h
index 3daf4e9..da5aa1b 100644
--- a/libgit2-glib/ggit-repository.h
+++ b/libgit2-glib/ggit-repository.h
@@ -36,7 +36,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_REPOSITORY (ggit_repository_get_type ())
#define GGIT_REPOSITORY(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_REPOSITORY, GgitRepository))
-#define GGIT_REPOSITORY_CONST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_REPOSITORY, GgitRepository const))
#define GGIT_REPOSITORY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GGIT_TYPE_REPOSITORY, GgitRepositoryClass))
#define GGIT_IS_REPOSITORY(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GGIT_TYPE_REPOSITORY))
#define GGIT_IS_REPOSITORY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GGIT_TYPE_REPOSITORY))
@@ -52,6 +51,12 @@ struct _GgitRepository
GgitRepositoryPrivate *priv;
};
+/**
+ * GgitRepositoryClass:
+ * @parent_class: The parent class.
+ *
+ * The class structure for #GgitRepositoryClass.
+ */
struct _GgitRepositoryClass
{
GgitNativeClass parent_class;
diff --git a/libgit2-glib/ggit-revision-walker.h b/libgit2-glib/ggit-revision-walker.h
index 8eb9685..4bad403 100644
--- a/libgit2-glib/ggit-revision-walker.h
+++ b/libgit2-glib/ggit-revision-walker.h
@@ -30,7 +30,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_REVISION_WALKER (ggit_revision_walker_get_type ())
#define GGIT_REVISION_WALKER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_REVISION_WALKER, GgitRevisionWalker))
-#define GGIT_REVISION_WALKER_CONST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_REVISION_WALKER, GgitRevisionWalker const))
#define GGIT_REVISION_WALKER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GGIT_TYPE_REVISION_WALKER, GgitRevisionWalkerClass))
#define GGIT_IS_REVISION_WALKER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GGIT_TYPE_REVISION_WALKER))
#define GGIT_IS_REVISION_WALKER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GGIT_TYPE_REVISION_WALKER))
@@ -46,6 +45,12 @@ struct _GgitRevisionWalker
GgitRevisionWalkerPrivate *priv;
};
+/**
+ * GgitRevisionWalkerClass:
+ * @parent_class: The parent class.
+ *
+ * The class structure for #GgitRevisionWalkerClass.
+ */
struct _GgitRevisionWalkerClass
{
GgitNativeClass parent_class;
diff --git a/libgit2-glib/ggit-signature.h b/libgit2-glib/ggit-signature.h
index d972b71..49d9f96 100644
--- a/libgit2-glib/ggit-signature.h
+++ b/libgit2-glib/ggit-signature.h
@@ -29,7 +29,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_SIGNATURE (ggit_signature_get_type ())
#define GGIT_SIGNATURE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_SIGNATURE, GgitSignature))
-#define GGIT_SIGNATURE_CONST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_SIGNATURE, GgitSignature const))
#define GGIT_SIGNATURE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GGIT_TYPE_SIGNATURE, GgitSignatureClass))
#define GGIT_IS_SIGNATURE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GGIT_TYPE_SIGNATURE))
#define GGIT_IS_SIGNATURE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GGIT_TYPE_SIGNATURE))
@@ -46,6 +45,12 @@ struct _GgitSignature
GgitSignaturePrivate *priv;
};
+/**
+ * GgitSignatureClass:
+ * @parent_class: The parent class.
+ *
+ * The class structure for #GgitSignatureClass.
+ */
struct _GgitSignatureClass
{
GgitNativeClass parent_class;
diff --git a/libgit2-glib/ggit-submodule.c b/libgit2-glib/ggit-submodule.c
index 810ea61..806b406 100644
--- a/libgit2-glib/ggit-submodule.c
+++ b/libgit2-glib/ggit-submodule.c
@@ -63,7 +63,7 @@ ggit_submodule_ref (GgitSubmodule *submodule)
/**
* ggit_submodule_unref:
- * submodule: a #GgitSubmodule.
+ * @submodule: a #GgitSubmodule.
*
* Atomically decrements the reference count of @submodule by one.
* If the reference count drops to 0, @remote is freed.
diff --git a/libgit2-glib/ggit-submodule.h b/libgit2-glib/ggit-submodule.h
index c3aa517..f435cf9 100644
--- a/libgit2-glib/ggit-submodule.h
+++ b/libgit2-glib/ggit-submodule.h
@@ -30,7 +30,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_SUBMODULE (ggit_submodule_get_type ())
#define GGIT_SUBMODULE(obj) ((GgitSubmodule *)obj)
-#define GGIT_SUBMODULE_CONST(obj) ((GgitSubmodule const *)obj)
GType ggit_submodule_get_type (void) G_GNUC_CONST;
diff --git a/libgit2-glib/ggit-tag.c b/libgit2-glib/ggit-tag.c
index 0a39eca..e8ed571 100644
--- a/libgit2-glib/ggit-tag.c
+++ b/libgit2-glib/ggit-tag.c
@@ -143,7 +143,7 @@ ggit_tag_get_name (GgitTag *tag)
* @tag: a #GgitTag.
*
* Get the tagger (author) of @tag. The returned value must be free with
- * ggit_signature_free().
+ * g_object_unref().
*
* Returns: (transfer full): the tagger (author) of the tag.
*/
diff --git a/libgit2-glib/ggit-tag.h b/libgit2-glib/ggit-tag.h
index 741ef33..c336f6d 100644
--- a/libgit2-glib/ggit-tag.h
+++ b/libgit2-glib/ggit-tag.h
@@ -32,7 +32,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_TAG (ggit_tag_get_type ())
#define GGIT_TAG(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_TAG, GgitTag))
-#define GGIT_TAG_CONST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_TAG, GgitTag const))
#define GGIT_TAG_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GGIT_TYPE_TAG, GgitTagClass))
#define GGIT_IS_TAG(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GGIT_TYPE_TAG))
#define GGIT_IS_TAG_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GGIT_TYPE_TAG))
@@ -48,6 +47,12 @@ struct _GgitTag
gpointer _priv;
};
+/**
+ * GgitTagClass:
+ * @parent_class: The parent class.
+ *
+ * The class structure for #GgitTagClass.
+ */
struct _GgitTagClass
{
GgitObjectClass parent_class;
diff --git a/libgit2-glib/ggit-tree-entry.h b/libgit2-glib/ggit-tree-entry.h
index 400bca0..9a2221c 100644
--- a/libgit2-glib/ggit-tree-entry.h
+++ b/libgit2-glib/ggit-tree-entry.h
@@ -29,7 +29,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_TREE_ENTRY (ggit_tree_entry_get_type ())
#define GGIT_TREE_ENTRY(obj) ((GgitTreeEntry *)obj)
-#define GGIT_TREE_ENTRY_CONST(obj) ((GgitTreeEntry const *)obj)
GType ggit_tree_entry_get_type (void) G_GNUC_CONST;
diff --git a/libgit2-glib/ggit-tree.h b/libgit2-glib/ggit-tree.h
index 0fc4163..01ebaef 100644
--- a/libgit2-glib/ggit-tree.h
+++ b/libgit2-glib/ggit-tree.h
@@ -31,7 +31,6 @@ G_BEGIN_DECLS
#define GGIT_TYPE_TREE (ggit_tree_get_type ())
#define GGIT_TREE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_TREE, GgitTree))
-#define GGIT_TREE_CONST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGIT_TYPE_TREE, GgitTree const))
#define GGIT_TREE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GGIT_TYPE_TREE, GgitTreeClass))
#define GGIT_IS_TREE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GGIT_TYPE_TREE))
#define GGIT_IS_TREE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GGIT_TYPE_TREE))
@@ -47,6 +46,12 @@ struct _GgitTree
gpointer priv;
};
+/**
+ * GgitTreeClass:
+ * @parent_class: The parent class.
+ *
+ * The class structure for #GgitTreeClass.
+ */
struct _GgitTreeClass
{
GgitObjectClass parent_class;
diff --git a/libgit2-glib/ggit-types.h b/libgit2-glib/ggit-types.h
index beb2091..57de29f 100644
--- a/libgit2-glib/ggit-types.h
+++ b/libgit2-glib/ggit-types.h
@@ -40,6 +40,13 @@ typedef struct _GgitBlob GgitBlob;
typedef struct _GgitCommit GgitCommit;
/**
+ * GgitCommitParents:
+ *
+ * Represents the parents of a commit object.
+ */
+typedef struct _GgitCommitParents GgitCommitParents;
+
+/**
* GgitConfig:
*
* Represents a git configuration.
@@ -89,6 +96,41 @@ typedef struct _GgitDiffRange GgitDiffRange;
typedef struct _GgitIndex GgitIndex;
/**
+ * GgitIndexEntries:
+ *
+ * Represents the entries in an index object.
+ */
+typedef struct _GgitIndexEntries GgitIndexEntries;
+
+/**
+ * GgitIndexEntry:
+ *
+ * Represents an index entry object.
+ */
+typedef struct _GgitIndexEntry GgitIndexEntry;
+
+/**
+ * GgitIndexEntriesUnmerged:
+ *
+ * Represents the unmerged entries in an index object.
+ */
+typedef struct _GgitIndexEntriesUnmerged GgitIndexEntriesUnmerged;
+
+/**
+ * GgitIndexEntryUnmerged:
+ *
+ * Represents an unmerged index entry object.
+ */
+typedef struct _GgitIndexEntryUnmerged GgitIndexEntryUnmerged;
+
+/**
+ * GgitNative:
+ *
+ * Represents a generic native object.
+ */
+typedef struct _GgitNative GgitNative;
+
+/**
* GgitObject:
*
* Represents a generic object in a repository.
@@ -96,6 +138,20 @@ typedef struct _GgitIndex GgitIndex;
typedef struct _GgitObject GgitObject;
/**
+ * GgitObjectFactory:
+ *
+ * Represents an object factory.
+ */
+typedef struct _GgitObjectFactory GgitObjectFactory;
+
+/**
+ * GgitObjectFactoryBase:
+ *
+ * Represents the base type for objects created by an object factory.
+ */
+typedef struct _GgitObjectFactoryBase GgitObjectFactoryBase;
+
+/**
* GgitOId:
*
* Represents a unique ID of any object.
@@ -244,7 +300,7 @@ typedef enum {
* @GGIT_DIFF_INCLUDE_IGNORED: include ignored files.
* @GGIT_DIFF_INCLUDE_UNTRACKED: include untracked files.
* @GGIT_DIFF_INCLUDE_UNMODIFIED: include unmodified files.
- * @GGIT_DIFF_RECURSE_UNTRACKED_DIRS:
+ * @GGIT_DIFF_RECURSE_UNTRACKED_DIRS: recurse to untracked directories.
*
* How the diff should be generated.
*/
@@ -271,6 +327,8 @@ typedef enum {
* @GGIT_DIFF_FILE_NOT_BINARY: if the file is not binary.
* @GGIT_DIFF_FILE_FREE_DATA: if the data must be freed (libgit2 internal).
* @GGIT_DIFF_FILE_UNMAP_DATA: if the data must be unmapped (libgit2 internal).
+ *
+ * Describes the diff file.
*/
typedef enum {
GGIT_DIFF_FILE_VALID_OID = 1 << 0,
@@ -434,11 +492,11 @@ typedef enum {
/**
* GgitSubmoduleUpdate:
- * GGIT_SUBMODULE_UPDATE_CHECKOUT: checkout the submodule.
- * GGIT_SUBMODULE_UPDATE_REBASE: rebase the current branch onto the
- * commit recorded in the superproject.
- * GGIT_SUBMODULE_UPDATE_MERGE: merge the commit recorded in the
- * superproject into the current branch.
+ * @GGIT_SUBMODULE_UPDATE_CHECKOUT: checkout the submodule.
+ * @GGIT_SUBMODULE_UPDATE_REBASE: rebase the current branch onto the
+ * commit recorded in the superproject.
+ * @GGIT_SUBMODULE_UPDATE_MERGE: merge the commit recorded in the
+ * superproject into the current branch.
*
* Describes how a submodule should be updated.
*/
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]