[template-glib] build: add gtk-doc stubs

From: Christian Hergert <chergert src gnome org>
To: commits-list gnome org
Cc:
Subject: [template-glib] build: add gtk-doc stubs
Date: Tue, 26 Jan 2016 07:14:08 +0000 (UTC)
commit fea2f7b749edcf747bb13ad2de34c3ce5ea36cc7
Author: Christian Hergert <chergert redhat com>
Date:   Tue Jan 26 08:12:13 2016 +0100

    build: add gtk-doc stubs

 configure.ac                    |    1 +
 doc/Makefile.am                 |   57 +++++++
 doc/template-glib-docs.sgml     |   62 +++++++
 doc/template-glib-sections.txt  |  342 +++++++++++++++++++++++++++++++++++++++
 doc/template-glib.types         |   19 +++
 doc/version.xml.in              |    1 +
 6 files changed, 482 insertions(+), 0 deletions(-)
---
diff --git a/configure.ac b/configure.ac
index 608a7b9..9d3cdfc 100644
--- a/configure.ac
+++ b/configure.ac
@@ -247,6 +247,7 @@ AC_CONFIG_FILES([
        examples/Makefile
 
        doc/Makefile
+       doc/version.xml
 
        po/Makefile.in
 
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 9b582ee..6e693a6 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,2 +1,59 @@
+## Process this file with automake to produce Makefile.in
+
+NULL = 
+
+AUTOMAKE_OPTIONS = 1.6
+
+# The name of the module.
+DOC_MODULE=template-glib
+
+# The top-level SGML file.
+DOC_MAIN_SGML_FILE=template-glib-docs.sgml
+
+# Extra options to supply to gtkdoc-scan
+SCAN_OPTIONS=
+
+# Extra options to pass to gtkdoc-scangobj
+SCANGOBJ_OPTIONS=
+
+# The directory containing the source code. Relative to $(srcdir)
+DOC_SOURCE_DIR=$(top_srcdir)/src
+
+# Used for dependencies
+HFILE_GLOB=$(top_srcdir)/src/tmpl-*.h
+CFILE_GLOB=$(top_srcdir)/src/tmpl-*.c
+
+# Header files to ignore when scanning
+IGNORE_HFILES=$(top_srcdir)/src/tmpl-glib.h
+
+# CFLAGS and LDFLAGS for compiling scan program. Only needed
+# if $(DOC_MODULE).types is non-empty.
+AM_CPPFLAGS =                  \
+       -I$(top_srcdir)/src     \
+       -I$(top_builddir)/src
+
+GTKDOC_LIBS = -L$(top_builddir)/src -ltemplate-glib-1.0
+
+# Extra options to supply to gtkdoc-mkdb
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
+content_files = version.xml
+
+# Images to copy into HTML directory
+HTML_IMAGES =
+
+# Extra options to supply to gtkdoc-fixref
+FIXXREF_OPTIONS = \
+       --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \
+       --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gio \
+       --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib
+
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+EXTRA_DIST += version.xml.in
+
+GITIGNOREFILES = version.xml
 
 -include $(top_srcdir)/git.mk
diff --git a/doc/template-glib-docs.sgml b/doc/template-glib-docs.sgml
new file mode 100644
index 0000000..6399b47
--- /dev/null
+++ b/doc/template-glib-docs.sgml
@@ -0,0 +1,62 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd";
+[
+  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+  <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
+  %gtkdocentities;
+]>
+<book id="index">
+  <bookinfo>
+    <title>&package_name; Reference Manual</title>
+    <releaseinfo>
+      for &package_string;.
+      The latest version of this documentation can be found on-line at
+      <ulink role="online-location" 
url="http://[SERVER]/&package_name;/index.html";>http://[SERVER]/&package_name;/</ulink>.
+    </releaseinfo>
+  </bookinfo>
+
+  <chapter>
+    <title>[Insert title here]</title>
+        <xi:include href="xml/tmpl-branch-node.xml"/>
+    <xi:include href="xml/tmpl-condition-node.xml"/>
+    <xi:include href="xml/tmpl-debug.xml"/>
+    <xi:include href="xml/tmpl-enums.xml"/>
+    <xi:include href="xml/tmpl-error.xml"/>
+    <xi:include href="xml/tmpl-expr.xml"/>
+    <xi:include href="xml/tmpl-expr-node.xml"/>
+    <xi:include href="xml/tmpl-expr-parser.xml"/>
+    <xi:include href="xml/tmpl-expr-parser-private.xml"/>
+    <xi:include href="xml/tmpl-expr-private.xml"/>
+    <xi:include href="xml/tmpl-expr-scanner.xml"/>
+    <xi:include href="xml/tmpl-expr-types.xml"/>
+    <xi:include href="xml/tmpl-gi-private.xml"/>
+    <xi:include href="xml/tmpl-iter-node.xml"/>
+    <xi:include href="xml/tmpl-iterator.xml"/>
+    <xi:include href="xml/tmpl-lexer.xml"/>
+    <xi:include href="xml/tmpl-node.xml"/>
+    <xi:include href="xml/tmpl-parser.xml"/>
+    <xi:include href="xml/tmpl-scope.xml"/>
+    <xi:include href="xml/tmpl-symbol.xml"/>
+    <xi:include href="xml/tmpl-template.xml"/>
+    <xi:include href="xml/tmpl-template-locator.xml"/>
+    <xi:include href="xml/tmpl-text-node.xml"/>
+    <xi:include href="xml/tmpl-token.xml"/>
+    <xi:include href="xml/tmpl-token-input-stream.xml"/>
+    <xi:include href="xml/tmpl-util-private.xml"/>
+
+  </chapter>
+  <chapter id="object-tree">
+    <title>Object Hierarchy</title>
+    <xi:include href="xml/tree_index.sgml"/>
+  </chapter>
+  <index id="api-index-full">
+    <title>API Index</title>
+    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="deprecated-api-index" role="deprecated">
+    <title>Index of deprecated API</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/doc/template-glib-overrides.txt b/doc/template-glib-overrides.txt
new file mode 100644
index 0000000..e69de29
diff --git a/doc/template-glib-sections.txt b/doc/template-glib-sections.txt
new file mode 100644
index 0000000..5a76137
--- /dev/null
+++ b/doc/template-glib-sections.txt
@@ -0,0 +1,342 @@
+<SECTION>
+<FILE>tmpl-branch-node</FILE>
+TMPL_TYPE_BRANCH_NODE
+tmpl_branch_node_new
+tmpl_branch_node_branch
+TmplBranchNode
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-condition-node</FILE>
+TMPL_TYPE_CONDITION_NODE
+tmpl_condition_node_new
+tmpl_condition_node_get_condition
+TmplConditionNode
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-debug</FILE>
+TMPL_ENABLE_TRACE
+G_LOG_LEVEL_TRACE
+TMPL_TRACE_MSG
+TMPL_PROBE
+TMPL_TODO
+TMPL_ENTRY
+TMPL_EXIT
+TMPL_GOTO
+TMPL_RETURN
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-enums</FILE>
+<SUBSECTION Standard>
+TMPL_TYPE_ERROR
+TMPL_TYPE_EXPR_BUILTIN
+TMPL_TYPE_EXPR_TYPE
+TMPL_TYPE_SYMBOL_TYPE
+tmpl_error_get_type
+tmpl_expr_builtin_get_type
+tmpl_expr_type_get_type
+tmpl_symbol_type_get_type
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-error</FILE>
+TMPL_ERROR
+TmplError
+tmpl_error_quark
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-expr</FILE>
+tmpl_expr_from_string
+tmpl_expr_ref
+tmpl_expr_unref
+tmpl_expr_eval
+tmpl_expr_new_boolean
+tmpl_expr_new_getattr
+tmpl_expr_new_setattr
+tmpl_expr_new_require
+tmpl_expr_new_simple
+tmpl_expr_new_string
+tmpl_expr_new_number
+tmpl_expr_new_gi_call
+tmpl_expr_new_fn_call
+tmpl_expr_new_user_fn_call
+tmpl_expr_new_flow
+tmpl_expr_new_symbol_ref
+tmpl_expr_new_symbol_assign
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-expr-node</FILE>
+TMPL_TYPE_EXPR_NODE
+tmpl_expr_node_new
+tmpl_expr_node_get_expr
+TmplExprNode
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-expr-parser</FILE>
+YYDEBUG
+tmpl_expr_parser_debug
+YYTOKENTYPE
+REQUIRE
+VERSION
+BOOL
+NUMBER
+NAME
+STRING_LITERAL
+BUILTIN
+EOL
+IF
+THEN
+ELSE
+WHILE
+DO
+FUNC
+CMP
+UMINUS
+YYSTYPE
+tmpl_expr_parser_parse
+<SUBSECTION Standard>
+YYSTYPE_IS_DECLARED
+YYSTYPE_IS_TRIVIAL
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-expr-parser-private</FILE>
+tmpl_expr_parser_destroy
+tmpl_expr_parser_flush
+tmpl_expr_parser_error
+tmpl_expr_parser_parse_string
+tmpl_expr_parser_init
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-expr-private</FILE>
+TmplExpr
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-expr-scanner</FILE>
+tmpl_expr_parser_IN_HEADER
+YY_INT_ALIGNED
+FLEX_SCANNER
+YY_FLEX_MAJOR_VERSION
+YY_FLEX_MINOR_VERSION
+YY_FLEX_SUBMINOR_VERSION
+FLEX_BETA
+FLEXINT_H
+flex_int8_t
+flex_uint8_t
+flex_int16_t
+flex_uint16_t
+flex_int32_t
+flex_uint32_t
+INT8_MIN
+INT16_MIN
+INT32_MIN
+INT8_MAX
+INT16_MAX
+INT32_MAX
+UINT8_MAX
+UINT16_MAX
+UINT32_MAX
+YY_USE_CONST
+yyconst
+YY_TYPEDEF_YY_SCANNER_T
+yyscan_t
+yyin
+yyout
+yyextra
+yyleng
+yytext
+yylineno
+yycolumn
+yy_flex_debug
+YY_BUF_SIZE
+YY_TYPEDEF_YY_BUFFER_STATE
+YY_BUFFER_STATE
+YY_TYPEDEF_YY_SIZE_T
+yy_size_t
+YY_STRUCT_YY_BUFFER_STATE
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-expr-types</FILE>
+TmplSymbolType
+TmplExprType
+TmplExprBuiltin
+<SUBSECTION Standard>
+TMPL_TYPE_EXPR
+TMPL_TYPE_SCOPE
+TMPL_TYPE_SYMBOL
+TmplExpr
+TmplScope
+TmplSymbol
+tmpl_expr_get_type
+tmpl_scope_get_type
+tmpl_symbol_get_type
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-gi-private</FILE>
+tmpl_gi_argument_from_g_value
+tmpl_gi_argument_to_g_value
+<SUBSECTION Standard>
+TMPL_TYPE_TYPELIB
+tmpl_typelib_get_type
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-iter-node</FILE>
+TMPL_TYPE_ITER_NODE
+tmpl_iter_node_new
+tmpl_iter_node_get_expr
+tmpl_iter_node_get_identifier
+TmplIterNode
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-iterator</FILE>
+TmplIterator
+tmpl_iterator_init
+tmpl_iterator_next
+tmpl_iterator_get_value
+tmpl_iterator_destroy
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-lexer</FILE>
+tmpl_lexer_new
+tmpl_lexer_free
+tmpl_lexer_unget
+tmpl_lexer_next
+<SUBSECTION Standard>
+TmplLexer
+tmpl_lexer_get_type
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-node</FILE>
+<TITLE>TmplNode</TITLE>
+TMPL_TYPE_NODE
+TmplNodeVisitor
+TmplNodeClass
+tmpl_node_new
+tmpl_node_new_for_token
+tmpl_node_accept
+tmpl_node_printf
+tmpl_node_visit_children
+TmplNode
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-parser</FILE>
+TMPL_TYPE_PARSER
+tmpl_parser_get_root
+tmpl_parser_new
+tmpl_parser_get_locator
+tmpl_parser_set_locator
+tmpl_parser_parse
+TmplParser
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-scope</FILE>
+tmpl_scope_new
+tmpl_scope_new_with_parent
+tmpl_scope_ref
+tmpl_scope_unref
+tmpl_scope_peek
+tmpl_scope_get
+tmpl_scope_set
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-symbol</FILE>
+tmpl_symbol_new
+tmpl_symbol_ref
+tmpl_symbol_unref
+tmpl_symbol_get_symbol_type
+tmpl_symbol_get_value
+tmpl_symbol_get_expr
+tmpl_symbol_assign_value
+tmpl_symbol_assign_boolean
+tmpl_symbol_assign_double
+tmpl_symbol_assign_string
+tmpl_symbol_assign_object
+tmpl_symbol_assign_expr
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-template</FILE>
+<TITLE>TmplTemplate</TITLE>
+TMPL_TYPE_TEMPLATE
+TmplTemplateClass
+tmpl_template_new
+tmpl_template_get_locator
+tmpl_template_set_locator
+tmpl_template_parse_file
+tmpl_template_parse_resource
+tmpl_template_parse_path
+tmpl_template_parse_string
+tmpl_template_parse
+tmpl_template_expand
+tmpl_template_expand_string
+TmplTemplate
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-template-locator</FILE>
+<TITLE>TmplTemplateLocator</TITLE>
+TMPL_TYPE_TEMPLATE_LOCATOR
+TmplTemplateLocatorClass
+tmpl_template_locator_new
+tmpl_template_locator_append_search_path
+tmpl_template_locator_prepend_search_path
+tmpl_template_locator_locate
+tmpl_template_locator_get_search_path
+TmplTemplateLocator
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-text-node</FILE>
+TMPL_TYPE_TEXT_NODE
+tmpl_text_node_new
+tmpl_text_node_get_text
+tmpl_text_node_set_text
+TmplTextNode
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-token</FILE>
+TmplTokenType
+tmpl_token_new_generic
+tmpl_token_new_unichar
+tmpl_token_new_text
+tmpl_token_new_eof
+tmpl_token_get_text
+tmpl_token_type
+tmpl_token_free
+tmpl_token_include_get_path
+TmplToken
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-token-input-stream</FILE>
+TMPL_TYPE_TOKEN_INPUT_STREAM
+tmpl_token_input_stream_new
+tmpl_token_input_stream_read_token
+TmplTokenInputStream
+</SECTION>
+
+<SECTION>
+<FILE>tmpl-util-private</FILE>
+TMPL_CLEAR_VALUE
+tmpl_destroy_in_main_context
+tmpl_value_repr
+tmpl_value_as_boolean
+</SECTION>
+
diff --git a/doc/template-glib.types b/doc/template-glib.types
new file mode 100644
index 0000000..042cfb2
--- /dev/null
+++ b/doc/template-glib.types
@@ -0,0 +1,19 @@
+tmpl_branch_node_get_type
+tmpl_condition_node_get_type
+tmpl_error_get_type
+tmpl_expr_builtin_get_type
+tmpl_expr_get_type
+tmpl_expr_node_get_type
+tmpl_expr_type_get_type
+tmpl_iter_node_get_type
+tmpl_lexer_get_type
+tmpl_node_get_type
+tmpl_parser_get_type
+tmpl_scope_get_type
+tmpl_symbol_get_type
+tmpl_symbol_type_get_type
+tmpl_template_get_type
+tmpl_template_locator_get_type
+tmpl_text_node_get_type
+tmpl_token_input_stream_get_type
+tmpl_typelib_get_type
diff --git a/doc/version.xml.in b/doc/version.xml.in
new file mode 100644
index 0000000..d78bda9
--- /dev/null
+++ b/doc/version.xml.in
@@ -0,0 +1 @@
+ VERSION@
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]