Commit 10520e36 authored by Johan Dahlin's avatar Johan Dahlin Committed by Johan Dahlin

Add gtk-doc support

parent 3af08400
......@@ -2,6 +2,7 @@
*.lo
*.o
*.pyc
*.stamp
.deps
.libs
Makefile
......@@ -18,6 +19,7 @@ config.sub
configure
COPYING
depcomp
gtk-doc.make
gobject-introspection-1.0.pc
INSTALL
install-sh
......@@ -27,6 +29,8 @@ missing
stamp-h1
ylwrap
py-compile
docs/reference/html
docs/reference/xml
gir/GIRepository-2.0.gir
gir/GIRepository-2.0.typelib
gir/GL-1.0.typelib
......@@ -58,7 +62,14 @@ tests/everything/Everything-1.0.gir
tests/everything/Everything-1.0.tgir
tests/everything/Everything-1.0.typelib
tests/invoke/testfns-metadata.c
tests/invoke/genericmarshaller
tests/invoke/invoke
tests/offsets/gitestoffsets.c
tests/offsets/gitestoffsets
tests/offsets/offsets-1.0.gir
tests/offsets/offsets-1.0.typelib
tests/offsets/offsets.compiled
tests/offsets/offsets.introspected
tests/repository/gitestrepo
tests/repository/gitestthrows
tests/scanner/BarApp-1.0.gir
......@@ -80,5 +91,6 @@ tests/scanner/foo-1.0.typelib
tests/scanner/utility-1.0.gir
tests/scanner/utility-1.0.tgir
tests/scanner/utility-1.0.typelib
tests/extended.gir.test
tools/g-ir-compiler
tools/g-ir-generate
......@@ -33,6 +33,7 @@ EXTRA_DIST = \
CONTRIBUTORS \
$(pkgconfig_DATA) \
$(man_MANS) \
m4/introspection.m4 \
misc/pep8.py \
misc/pyflakes.py
......
......@@ -161,6 +161,9 @@ GIREPO_CFLAGS="$GIREPO_CFLAGS $FFI_CFLAGS"
GIREPO_CFLAGS="$GIREPO_CFLAGS $GCOV_CFLAGS"
# gtk-doc
GTK_DOC_CHECK([1.12])
# Checks for header files.
AC_HEADER_STDC
AC_CHECK_HEADERS([fcntl.h stdlib.h string.h])
......@@ -201,5 +204,7 @@ tests/offsets/Makefile
tests/scanner/Makefile
tests/repository/Makefile
tests/everything/Makefile
docs/Makefile
docs/reference/Makefile
gobject-introspection-1.0.pc])
AC_OUTPUT
SUBDIRS = reference
AUTOMAKE_OPTIONS = 1.6
# The name of the module.
DOC_MODULE=gi
# The top-level SGML file.
DOC_MAIN_SGML_FILE=gi-docs.sgml
# The directory containing the source code. Relative to $(srcdir)
DOC_SOURCE_DIR=../../girepository
# Extra options to supply to gtkdoc-scan
SCAN_OPTIONS=
# Extra options to supply to gtkdoc-mkdb
MKDB_OPTIONS=--sgml-mode --output-format=xml --namespace=g
# Used for dependencies
HFILE_GLOB=$(top_srcdir)/girepository/*.h
CFILE_GLOB=$(top_srcdir)/girepository/*.c
# Headers to ignore
IGNORE_HFILES=
INCLUDES=$(GIREPO_CFLAGS) -I$(top_srcdir)
GTKDOC_LIBS = $(GIREPO_LIBS) $(top_builddir)/girepository/libgirepository-1.0.la $(top_builddir)/girepository/libgirepository-parser.la
# Extra options to supply to gtkdoc-fixref
FIXXREF_OPTIONS=
# include common portion ...
include $(top_srcdir)/gtk-doc.make
# Other files to distribute
EXTRA_DIST +=version.xml.in
########################################################################
dist-hook-local: $(BUILT_EXTRA_DIST)
files='$(BUILT_EXTRA_DIST)'; \
for f in $$files; do \
if test -f $$f; then d=.; else d=$(srcdir); fi; \
cp $$d/$$f $(distdir) || exit 1; done
<SECTION>
<FILE>girepository</FILE>
G_TYPE_IREPOSITORY
G_IREPOSITORY
GIRepositoryPrivate
GIBaseInfo
GICallableInfo
GIFunctionInfo
GICallbackInfo
GIRegisteredTypeInfo
GIStructInfo
GIUnionInfo
GIEnumInfo
GIObjectInfo
GIInterfaceInfo
GIConstantInfo
GIValueInfo
GISignalInfo
GIVFuncInfo
GIPropertyInfo
GIFieldInfo
GIArgInfo
GITypeInfo
GIErrorDomainInfo
GIUnresolvedInfo
GTypelib
<TITLE>GIRepository</TITLE>
GIRepository
GIRepositoryLoadFlags
g_irepository_get_default
g_irepository_prepend_search_path
g_irepository_get_search_path
g_irepository_load_typelib
g_irepository_is_registered
g_irepository_find_by_name
g_irepository_require
g_irepository_get_dependencies
g_irepository_get_loaded_namespaces
g_irepository_find_by_gtype
g_irepository_get_n_infos
g_irepository_get_info
g_irepository_get_typelib_path
g_irepository_get_shared_library
g_irepository_get_version
g_irepository_get_option_group
g_irepository_dump
g_typelib_new_from_memory
g_typelib_new_from_const_memory
g_typelib_new_from_mapped_file
g_typelib_free
g_typelib_symbol
g_typelib_get_namespace
GIRepositoryError
G_IREPOSITORY_ERROR
g_irepository_error_quark
gi_cclosure_marshal_generic
GIInfoType
g_base_info_ref
g_base_info_unref
g_base_info_get_type
g_base_info_get_name
g_base_info_get_namespace
g_base_info_is_deprecated
g_base_info_get_annotation
g_base_info_get_container
g_base_info_get_typelib
g_info_new
GIFunctionInfoFlags
g_function_info_get_symbol
g_function_info_get_flags
g_function_info_get_property
g_function_info_get_vfunc
G_INVOKE_ERROR
g_invoke_error_quark
GInvokeError
g_function_info_invoke
GITransfer
g_callable_info_get_return_type
g_callable_info_get_caller_owns
g_callable_info_may_return_null
g_callable_info_get_n_args
g_callable_info_get_arg
GIDirection
GIScopeType
g_arg_info_get_direction
g_arg_info_is_dipper
g_arg_info_is_return_value
g_arg_info_is_optional
g_arg_info_may_be_null
g_arg_info_get_ownership_transfer
g_arg_info_get_scope
g_arg_info_get_closure
g_arg_info_get_destroy
g_arg_info_get_type
GITypeTag
g_type_tag_to_string
g_type_info_is_pointer
g_type_info_get_tag
g_type_info_get_param_type
g_type_info_get_interface
g_type_info_get_array_length
g_type_info_get_array_fixed_size
g_type_info_is_zero_terminated
g_type_info_get_n_error_domains
g_type_info_get_error_domain
g_error_domain_info_get_quark
g_error_domain_info_get_codes
g_value_info_get_value
GIFieldInfoFlags
g_field_info_get_flags
g_field_info_get_size
g_field_info_get_offset
g_field_info_get_type
g_field_info_get_field
g_field_info_set_field
g_union_info_get_n_fields
g_union_info_get_field
g_union_info_get_n_methods
g_union_info_get_method
g_union_info_is_discriminated
g_union_info_get_discriminator_offset
g_union_info_get_discriminator_type
g_union_info_get_discriminator
g_union_info_find_method
g_union_info_get_size
g_union_info_get_alignment
g_struct_info_get_n_fields
g_struct_info_get_field
g_struct_info_get_n_methods
g_struct_info_get_method
g_struct_info_find_method
g_struct_info_get_size
g_struct_info_get_alignment
g_struct_info_is_class_struct
g_registered_type_info_get_type_name
g_registered_type_info_get_type_init
g_registered_type_info_get_g_type
g_enum_info_get_n_values
g_enum_info_get_value
g_enum_info_get_storage_type
g_object_info_get_type_name
g_object_info_get_type_init
g_object_info_get_abstract
g_object_info_get_parent
g_object_info_get_n_interfaces
g_object_info_get_interface
g_object_info_get_n_fields
g_object_info_get_field
g_object_info_get_n_properties
g_object_info_get_property
g_object_info_get_n_methods
g_object_info_get_method
g_object_info_find_method
g_object_info_get_n_signals
g_object_info_get_signal
g_object_info_get_n_vfuncs
g_object_info_get_vfunc
g_object_info_get_n_constants
g_object_info_get_constant
g_object_info_get_class_struct
g_interface_info_get_n_prerequisites
g_interface_info_get_prerequisite
g_interface_info_get_n_properties
g_interface_info_get_property
g_interface_info_get_n_methods
g_interface_info_get_method
g_interface_info_find_method
g_interface_info_get_n_signals
g_interface_info_get_signal
g_interface_info_get_n_vfuncs
g_interface_info_get_vfunc
g_interface_info_get_n_constants
g_interface_info_get_constant
g_property_info_get_flags
g_property_info_get_type
g_signal_info_get_flags
g_signal_info_get_class_closure
g_signal_info_true_stops_emit
GIVFuncInfoFlags
g_vfunc_info_get_flags
g_vfunc_info_get_offset
g_vfunc_info_get_signal
g_constant_info_get_type
g_constant_info_get_value
<SUBSECTION Standard>
G_TYPE_TAG_IS_BASIC
g_irepository_get_type
</SECTION>
<SECTION>
<FILE>gtypelib</FILE>
G_IR_MAGIC
GTypelib
g_typelib_get_dir_entry
g_typelib_check_sanity
g_typelib_get_string
GTypelibError
G_TYPELIB_ERROR
g_typelib_error_quark
g_typelib_validate
<SUBSECTION Standard>
BLOB_IS_REGISTERED_TYPE
</SECTION>
<SECTION>
<FILE>ginfo</FILE>
g_type_info_new
g_info_new_full
</SECTION>
<SECTION>
<FILE>girffi</FILE>
GIFFIClosureCallback
g_ir_ffi_get_ffi_type
g_callable_info_get_ffi_arg_types
g_callable_info_get_ffi_return_type
g_callable_info_prepare_closure
g_callable_info_free_closure
</SECTION>
<SECTION>
<FILE>girmodule</FILE>
GIrModule
g_ir_module_new
g_ir_module_free
g_ir_module_add_include_module
g_ir_module_build_typelib
</SECTION>
<SECTION>
<FILE>girnode</FILE>
GIrNodeFunction
GIrNodeParam
GIrNodeType
GIrNodeSignal
GIrNodeProperty
GIrNodeVFunc
GIrNodeField
GIrNodeValue
GIrNodeEnum
GIrNodeBoxed
GIrNodeStruct
GIrNodeConstant
GIrNodeErrorDomain
GIrNodeXRef
GIrNodeUnion
GIrNodeTypeId
<TITLE>GIrNode</TITLE>
GIrNode
g_ir_node_new
g_ir_node_free
g_ir_node_get_size
g_ir_node_get_full_size
g_ir_node_build_typelib
g_ir_node_cmp
g_ir_node_can_have_member
g_ir_node_add_member
write_string
g_ir_node_param_direction_string
g_ir_node_type_to_string
g_ir_find_node
g_ir_node_compute_offsets
</SECTION>
<SECTION>
<FILE>girparser</FILE>
GIrParser
g_ir_parser_new
g_ir_parser_free
g_ir_parser_set_includes
g_ir_parser_parse_string
g_ir_parser_parse_file
</SECTION>
<SECTION>
<FILE>girwriter</FILE>
g_idl_writer_save_file
</SECTION>
This diff is collapsed.
<?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 gi-ginfo SYSTEM "xml/ginfo.xml">
<!ENTITY gi-girepository SYSTEM "xml/girepository.xml">
<!ENTITY gi-girffi SYSTEM "xml/girffi.xml">
<!ENTITY gi-girmodule SYSTEM "xml/girmodule.xml">
<!ENTITY gi-girnode SYSTEM "xml/girnode.xml">
<!ENTITY gi-girparser SYSTEM "xml/girparser.xml">
<!ENTITY gi-girwriter SYSTEM "xml/girwriter.xml">
<!ENTITY gi-gtypelib SYSTEM "xml/gtypelib.xml">
<!ENTITY version SYSTEM "version.xml">
]>
<book id="index">
<bookinfo>
<title>GObject Introspection Reference Manual</title>
</bookinfo>
<chapter id="glib">
<title>GObject-Introspection Overview</title>
<para>
Bla bla bla bla bla
</para>
<!--
&gi-overview;
&gi-building;
-->
</chapter>
<!--
<chapter id="gi-gir">
<title>GIR markup format</title>
&gi-gir-overview;
&gi-gir-creating;
&gi-gir-parsing;
&gi-gir-verifying;
</chapter>
-->
<chapter id="gi-typelib">
<title>typelib</title>
&gi-gtypelib;
</chapter>
<chapter id="gi-girepository">
<title>GIRepository</title>
&gi-girepository;
&gi-ginfo;
&gi-girmodule;
&gi-girparser;
&gi-girwriter;
&gi-girffi;
</chapter>
<!--
<chapter id="tools">
<title>GObject Introspection Tools</title>
&g-ir-scanner;
&g-ir-compiler;
&g-ir-generator;
</chapter>
-->
</book>
<SECTION>
<FILE>girepository</FILE>
G_TYPE_IREPOSITORY
G_IREPOSITORY
GIRepositoryPrivate
GIBaseInfo
GICallableInfo
GIFunctionInfo
GICallbackInfo
GIRegisteredTypeInfo
GIStructInfo
GIUnionInfo
GIEnumInfo
GIObjectInfo
GIInterfaceInfo
GIConstantInfo
GIValueInfo
GISignalInfo
GIVFuncInfo
GIPropertyInfo
GIFieldInfo
GIArgInfo
GITypeInfo
GIErrorDomainInfo
GIUnresolvedInfo
GTypelib
<TITLE>GIRepository</TITLE>
GIRepository
GIRepositoryLoadFlags
g_irepository_get_default
g_irepository_prepend_search_path
g_irepository_get_search_path
g_irepository_load_typelib
g_irepository_is_registered
g_irepository_find_by_name
g_irepository_require
g_irepository_get_dependencies
g_irepository_get_loaded_namespaces
g_irepository_find_by_gtype
g_irepository_get_n_infos
g_irepository_get_info
g_irepository_get_typelib_path
g_irepository_get_shared_library
g_irepository_get_version
g_irepository_get_option_group
g_irepository_dump
g_typelib_new_from_memory
g_typelib_new_from_const_memory
g_typelib_new_from_mapped_file
g_typelib_free
g_typelib_symbol
g_typelib_get_namespace
GIRepositoryError
G_IREPOSITORY_ERROR
g_irepository_error_quark
gi_cclosure_marshal_generic
GIInfoType
g_base_info_ref
g_base_info_unref
g_base_info_get_type
g_base_info_get_name
g_base_info_get_namespace
g_base_info_is_deprecated
g_base_info_get_annotation
g_base_info_get_container
g_base_info_get_typelib
g_info_new
GIFunctionInfoFlags
g_function_info_get_symbol
g_function_info_get_flags
g_function_info_get_property
g_function_info_get_vfunc
G_INVOKE_ERROR
g_invoke_error_quark
GInvokeError
g_function_info_invoke
GITransfer
g_callable_info_get_return_type
g_callable_info_get_caller_owns
g_callable_info_may_return_null
g_callable_info_get_n_args
g_callable_info_get_arg
GIDirection
GIScopeType
g_arg_info_get_direction
g_arg_info_is_dipper
g_arg_info_is_return_value
g_arg_info_is_optional
g_arg_info_may_be_null
g_arg_info_get_ownership_transfer
g_arg_info_get_scope
g_arg_info_get_closure
g_arg_info_get_destroy
g_arg_info_get_type
GITypeTag
g_type_tag_to_string
g_type_info_is_pointer
g_type_info_get_tag
g_type_info_get_param_type
g_type_info_get_interface
g_type_info_get_array_length
g_type_info_get_array_fixed_size
g_type_info_is_zero_terminated
g_type_info_get_n_error_domains
g_type_info_get_error_domain
g_error_domain_info_get_quark
g_error_domain_info_get_codes
g_value_info_get_value
GIFieldInfoFlags
g_field_info_get_flags
g_field_info_get_size
g_field_info_get_offset
g_field_info_get_type
g_field_info_get_field
g_field_info_set_field
g_union_info_get_n_fields
g_union_info_get_field
g_union_info_get_n_methods
g_union_info_get_method
g_union_info_is_discriminated
g_union_info_get_discriminator_offset
g_union_info_get_discriminator_type
g_union_info_get_discriminator
g_union_info_find_method
g_union_info_get_size
g_union_info_get_alignment
g_struct_info_get_n_fields
g_struct_info_get_field
g_struct_info_get_n_methods
g_struct_info_get_method
g_struct_info_find_method
g_struct_info_get_size
g_struct_info_get_alignment
g_struct_info_is_class_struct
g_registered_type_info_get_type_name
g_registered_type_info_get_type_init
g_registered_type_info_get_g_type
g_enum_info_get_n_values
g_enum_info_get_value
g_enum_info_get_storage_type
g_object_info_get_type_name
g_object_info_get_type_init
g_object_info_get_abstract
g_object_info_get_parent
g_object_info_get_n_interfaces
g_object_info_get_interface
g_object_info_get_n_fields
g_object_info_get_field
g_object_info_get_n_properties
g_object_info_get_property
g_object_info_get_n_methods
g_object_info_get_method
g_object_info_find_method
g_object_info_get_n_signals
g_object_info_get_signal
g_object_info_get_n_vfuncs
g_object_info_get_vfunc
g_object_info_get_n_constants
g_object_info_get_constant
g_object_info_get_class_struct
g_interface_info_get_n_prerequisites
g_interface_info_get_prerequisite
g_interface_info_get_n_properties
g_interface_info_get_property
g_interface_info_get_n_methods
g_interface_info_get_method
g_interface_info_find_method
g_interface_info_get_n_signals
g_interface_info_get_signal
g_interface_info_get_n_vfuncs
g_interface_info_get_vfunc
g_interface_info_get_n_constants
g_interface_info_get_constant
g_property_info_get_flags
g_property_info_get_type
g_signal_info_get_flags
g_signal_info_get_class_closure
g_signal_info_true_stops_emit
GIVFuncInfoFlags
g_vfunc_info_get_flags
g_vfunc_info_get_offset
g_vfunc_info_get_signal
g_constant_info_get_type
g_constant_info_get_value
<SUBSECTION Standard>
G_TYPE_TAG_IS_BASIC
g_irepository_get_type
</SECTION>
<SECTION>
<FILE>gtypelib</FILE>
G_IR_MAGIC
GTypelib
g_typelib_get_dir_entry
g_typelib_check_sanity
g_typelib_get_string
GTypelibError
G_TYPELIB_ERROR
g_typelib_error_quark
g_typelib_validate
<SUBSECTION Standard>
BLOB_IS_REGISTERED_TYPE
</SECTION>
<SECTION>
<FILE>ginfo</FILE>
g_type_info_new
g_info_new_full
</SECTION>
<SECTION>
<FILE>girffi</FILE>
GIFFIClosureCallback
g_ir_ffi_get_ffi_type
g_callable_info_get_ffi_arg_types
g_callable_info_get_ffi_return_type
g_callable_info_prepare_closure
g_callable_info_free_closure
</SECTION>
<SECTION>
<FILE>girmodule</FILE>
GIrModule
g_ir_module_new
g_ir_module_free
g_ir_module_add_include_module
g_ir_module_build_typelib
</SECTION>
<SECTION>
<FILE>girnode</FILE>
GIrNode
GIrNodeFunction
GIrNodeParam
GIrNodeType
GIrNodeInterface
GIrNodeSignal
GIrNodeProperty
GIrNodeVFunc
GIrNodeField
GIrNodeValue
GIrNodeEnum
GIrNodeBoxed
GIrNodeStruct
GIrNodeConstant
GIrNodeErrorDomain
GIrNodeXRef
GIrNodeUnion
GIrNodeTypeId
g_ir_node_new
g_ir_node_free
g_ir_node_get_size
g_ir_node_get_full_size
g_ir_node_build_typelib
g_ir_node_cmp
g_ir_node_can_have_member
g_ir_node_add_member
write_string
g_ir_node_param_direction_string
g_ir_node_type_to_string
g_ir_find_node
g_ir_node_compute_offsets
</SECTION>
<SECTION>
<FILE>girparser</FILE>
GIrParser
g_ir_parser_new
g_ir_parser_free
g_ir_parser_set_includes
g_ir_parser_parse_string
g_ir_parser_parse_file
</SECTION>
<SECTION>
<FILE>girwriter</FILE>
g_idl_writer_save_file
</SECTION>
g_irepository_get_type
g_irepository_get_type
<!-- ##### SECTION Title ##### -->
ginfo
<!-- ##### SECTION Short_Description ##### -->
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION g_type_info_new ##### -->
<para>