GNOME.org
 

[latexila] Generate internal GTK-Doc documentation

commit 15b4ee70ffc963810c04fc5acefa0515d0caeac4
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Wed Apr 30 17:57:35 2014 +0200

    Generate internal GTK-Doc documentation

 Makefile.am                          |    5 ++-
 configure.ac                         |    3 +
 docs/Makefile.am                     |    3 +
 docs/reference/Makefile.am           |   99 ++++++++++++++++++++++++++++++++++
 docs/reference/latexila-docs.xml     |   30 ++++++++++
 docs/reference/latexila-sections.txt |   56 +++++++++++++++++++
 6 files changed, 195 insertions(+), 1 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index f867040..49b16f8 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,6 +1,6 @@
 ACLOCAL_AMFLAGS = -I m4
 
-SUBDIRS = data man po help src
+SUBDIRS = data man po help src docs
 
 DISTCHECK_CONFIGURE_FLAGS = --enable-introspection
 
@@ -29,12 +29,14 @@ MAINTAINERCLEANFILES =              \
        config.sub              \
        configure.scan          \
        depcomp                 \
+       gtk-doc.make            \
        install-sh              \
        ltmain.sh               \
        m4/codeset.m4           \
        m4/gettext.m4           \
        m4/glibc21.m4           \
        m4/glibc2.m4            \
+       m4/gtk-doc.m4           \
        m4/iconv.m4             \
        m4/intdiv0.m4           \
        m4/intldir.m4           \
@@ -76,6 +78,7 @@ MAINTAINERCLEANFILES =                \
        po/insert-header.sin    \
        po/quot.sed             \
        po/remove-potcdate.sin  \
+       test-driver             \
        `find "$(srcdir)" -type f -name Makefile.in -print`
 
 -include $(top_srcdir)/git.mk
diff --git a/configure.ac b/configure.ac
index 14c53a0..f62688c 100644
--- a/configure.ac
+++ b/configure.ac
@@ -140,6 +140,7 @@ GLIB_GSETTINGS
 GNOME_COMPILE_WARNINGS([maximum])
 GOBJECT_INTROSPECTION_CHECK([1.30.0])
 VAPIGEN_CHECK
+GTK_DOC_CHECK([1.14], [--flavour no-tmpl])
 
 # Generate files
 AC_CONFIG_FILES([Makefile
@@ -159,6 +160,8 @@ AC_CONFIG_FILES([Makefile
                 data/images/app/Makefile
                 data/org.gnome.latexila.gschema.xml
                 data/templates/Makefile
+                docs/Makefile
+                docs/reference/Makefile
                 help/Makefile
                 man/Makefile
                 po/Makefile.in
diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644
index 0000000..034926c
--- /dev/null
+++ b/docs/Makefile.am
@@ -0,0 +1,3 @@
+SUBDIRS = reference
+
+-include $(top_srcdir)/git.mk
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
new file mode 100644
index 0000000..9f2fa03
--- /dev/null
+++ b/docs/reference/Makefile.am
@@ -0,0 +1,99 @@
+## Process this file with automake to produce Makefile.in
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# The name of the module, e.g. 'glib'.
+DOC_MODULE = latexila
+
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+#DOC_MODULE_VERSION=2
+
+# The top-level XML file (SGML in the past). You can change this if you want to.
+DOC_MAIN_SGML_FILE = latexila-docs.xml
+
+# Directories containing the source code.
+# gtk-doc will search all .c and .h files beneath these paths
+# for inline comments documenting functions and macros.
+# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
+DOC_SOURCE_DIR = $(top_srcdir)/src/liblatexila
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS =
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCAN_OPTIONS = --rebuild-types
+
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
+MKDB_OPTIONS = --xml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-mktmpl
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+MKTMPL_OPTIONS =
+
+# Extra options to supply to gtkdoc-mkhtml
+MKHTML_OPTIONS =
+
+# Extra options to supply to gtkdoc-fixref. Not normally needed.
+# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
+FIXXREF_OPTIONS =
+
+# Used for dependencies. The docs will be rebuilt if any of these change.
+# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
+# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
+HFILE_GLOB = $(top_srcdir)/src/liblatexila/*.h
+CFILE_GLOB = $(top_srcdir)/src/liblatexila/*.c
+
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+EXTRA_HFILES =
+
+# Header files or dirs to ignore when scanning. Use base file/dir names
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
+IGNORE_HFILES =
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+HTML_IMAGES =
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
+content_files =
+
+# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# These files must be listed here *and* in content_files
+# e.g. expand_content_files=running.sgml
+expand_content_files =
+
+# 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.
+# e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+GTKDOC_CFLAGS = -I$(top_srcdir) -I$(top_builddir)
+GTKDOC_LIBS = $(top_builddir)/src/liblatexila/liblatexila.la
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+# e.g. EXTRA_DIST += version.xml.in
+EXTRA_DIST =
+
+# Files not to distribute
+# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
+# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
+DISTCLEANFILES = latexila-overrides.txt latexila.types
+
+# Comment this out if you want 'make check' to test you doc status
+# and run some sanity checks
+if ENABLE_GTK_DOC
+TESTS_ENVIRONMENT = \
+  DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
+  SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
+TESTS = $(GTKDOC_CHECK)
+endif
+
+-include $(top_srcdir)/git.mk
diff --git a/docs/reference/latexila-docs.xml b/docs/reference/latexila-docs.xml
new file mode 100644
index 0000000..f12c1c6
--- /dev/null
+++ b/docs/reference/latexila-docs.xml
@@ -0,0 +1,30 @@
+<?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'">
+]>
+<book id="index">
+  <bookinfo>
+    <title>LaTeXila Reference Manual</title>
+  </bookinfo>
+
+  <chapter>
+    <title>API reference</title>
+    <xi:include href="xml/build-tools.xml"/>
+    <xi:include href="xml/build-tools-default.xml"/>
+    <xi:include href="xml/build-tools-personal.xml"/>
+  </chapter>
+
+  <chapter id="object-tree">
+    <title>Object Hierarchy</title>
+     <xi:include href="xml/tree_index.sgml"/>
+  </chapter>
+
+  <index id="api-index-full">
+    <title>Index of all symbols</title>
+    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+  </index>
+
+  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>
diff --git a/docs/reference/latexila-sections.txt b/docs/reference/latexila-sections.txt
new file mode 100644
index 0000000..e79140f
--- /dev/null
+++ b/docs/reference/latexila-sections.txt
@@ -0,0 +1,56 @@
+<INCLUDE>latexila.h</INCLUDE>
+
+<SECTION>
+<FILE>build-tools</FILE>
+<TITLE>LatexilaBuildTools</TITLE>
+LatexilaBuildToolsPrivate
+latexila_build_tool_get_description
+latexila_build_tool_free
+latexila_build_tools_load
+latexila_build_tools_set_enabled
+<SUBSECTION Standard>
+LATEXILA_BUILD_TOOLS
+LATEXILA_BUILD_TOOLS_CLASS
+LATEXILA_BUILD_TOOLS_GET_CLASS
+LATEXILA_IS_BUILD_TOOLS
+LATEXILA_IS_BUILD_TOOLS_CLASS
+LATEXILA_TYPE_BUILD_TOOLS
+latexila_build_tools_get_type
+</SECTION>
+
+<SECTION>
+<FILE>build-tools-default</FILE>
+<TITLE>LatexilaBuildToolsDefault</TITLE>
+LatexilaBuildToolsDefaultPrivate
+latexila_build_tools_default_get_instance
+<SUBSECTION Standard>
+LATEXILA_BUILD_TOOLS_DEFAULT
+LATEXILA_BUILD_TOOLS_DEFAULT_CLASS
+LATEXILA_BUILD_TOOLS_DEFAULT_GET_CLASS
+LATEXILA_IS_BUILD_TOOLS_DEFAULT
+LATEXILA_IS_BUILD_TOOLS_DEFAULT_CLASS
+LATEXILA_TYPE_BUILD_TOOLS_DEFAULT
+latexila_build_tools_default_get_type
+</SECTION>
+
+<SECTION>
+<FILE>build-tools-personal</FILE>
+<TITLE>LatexilaBuildToolsPersonal</TITLE>
+LatexilaBuildToolsPersonalPrivate
+latexila_build_tools_personal_get_instance
+latexila_build_tools_personal_save
+latexila_build_tools_personal_move_up
+latexila_build_tools_personal_move_down
+latexila_build_tools_personal_delete
+latexila_build_tools_personal_add
+latexila_build_tools_personal_insert
+latexila_build_tools_personal_replace
+<SUBSECTION Standard>
+LATEXILA_BUILD_TOOLS_PERSONAL
+LATEXILA_BUILD_TOOLS_PERSONAL_CLASS
+LATEXILA_BUILD_TOOLS_PERSONAL_GET_CLASS
+LATEXILA_IS_BUILD_TOOLS_PERSONAL
+LATEXILA_IS_BUILD_TOOLS_PERSONAL_CLASS
+LATEXILA_TYPE_BUILD_TOOLS_PERSONAL
+latexila_build_tools_personal_get_type
+</SECTION>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]