diff options
author | Matthias Clasen <mclasen@redhat.com> | 2016-08-06 23:07:29 -0400 |
---|---|---|
committer | Emmanuele Bassi <ebassi@gnome.org> | 2016-08-09 17:31:55 +0100 |
commit | c5d1764ccf119cb65dd00feeb6e105bc7ecc56a3 (patch) | |
tree | cf5a6df23c9e7ed766de3c8300e45e6cc9494cb3 | |
parent | 21206e72062dc6578cf497e0dabcf0696690baed (diff) | |
download | gtk+-c5d1764ccf119cb65dd00feeb6e105bc7ecc56a3.tar.gz |
gsk: Build docs
-rw-r--r-- | configure.ac | 2 | ||||
-rw-r--r-- | docs/reference/Makefile.am | 2 | ||||
-rw-r--r-- | docs/reference/gsk/Makefile.am | 79 | ||||
-rw-r--r-- | docs/reference/gsk/gsk-docs.xml | 29 | ||||
-rw-r--r-- | docs/reference/gsk/gsk3-sections.txt | 98 | ||||
-rw-r--r-- | docs/reference/gsk/gsk3.types | 3 | ||||
-rw-r--r-- | docs/reference/gsk/version.xml.in | 1 |
7 files changed, 213 insertions, 1 deletions
diff --git a/configure.ac b/configure.ac index 5602a2793b..9fa4a7ebc7 100644 --- a/configure.ac +++ b/configure.ac @@ -1955,6 +1955,8 @@ docs/Makefile docs/reference/Makefile docs/reference/gdk/Makefile docs/reference/gdk/version.xml +docs/reference/gsk/Makefile +docs/reference/gsk/version.xml docs/reference/gtk/Makefile docs/reference/gtk/gtk3.types docs/reference/gtk/version.xml diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am index a2f772e660..87cb6a8315 100644 --- a/docs/reference/Makefile.am +++ b/docs/reference/Makefile.am @@ -1,7 +1,7 @@ ## Process this file with automake to produce Makefile.in include $(top_srcdir)/Makefile.decl -SUBDIRS = gdk gtk libgail-util +SUBDIRS = gdk gsk gtk libgail-util GITIGNOREFILES = */*.1 diff --git a/docs/reference/gsk/Makefile.am b/docs/reference/gsk/Makefile.am new file mode 100644 index 0000000000..f2ce9c8fb3 --- /dev/null +++ b/docs/reference/gsk/Makefile.am @@ -0,0 +1,79 @@ +## Process this file with automake to produce Makefile.in + +AUTOMAKE_OPTIONS = 1.6 + +# The name of the module. +DOC_MODULE = gsk3 + +# The top-level SGML file. +DOC_MAIN_SGML_FILE = gsk-docs.xml + +# Extra options to supply to gtkdoc-scan +SCAN_OPTIONS = --deprecated-guards=GDK_DISABLE_DEPRECATED \ + --ignore-decorators=G_GNUC_WARN_UNUSED_RESULT + +# The directory containing the source code. Relative to $(srcdir) +DOC_SOURCE_DIR = $(top_srcdir)/gsk + +# Used for dependencies +HFILE_GLOB = $(top_srcdir)/gsk/*.h +CFILE_GLOB = $(top_srcdir)/gsk/*.c + +# Header files to ignore when scanning +IGNORE_HFILES = \ + gskcairorendererprivate.h \ + gskdebugprivate.h \ + gskdriverprivate.h \ + gskprofilerprivate.h \ + gskglrendererprivate.h \ + gskprivate.h \ + gskprofilerprivate.h \ + gskrendererprivate.h \ + gskrendernodeprivate.h \ + gskshaderbiulderprivate.h + +# Extra files to add when scanning +EXTRA_HFILES = + +# CFLAGS and LDFLAGS for compiling scan program. Only needed +# if $(DOC_MODULE).types is non-empty. +AM_CPPFLAGS = \ + -I$(top_srcdir) \ + -I$(top_builddir) \ + -I$(top_builddir)/gsk \ + $(GTK_DEBUG_FLAGS) \ + $(GDK_DEP_CFLAGS) + +GTKDOC_LIBS = $(top_builddir)/gsk/libgsk-3.la $(GDK_DEP_LIBS) + +# Extra options to supply to gtkdoc-mkdb +MKDB_OPTIONS=--output-format=xml --name-space=gsk + +# Extra SGML files that are included by DOC_MAIN_SGML_FILE +content_files = \ + version.xml + +# Images to copy into HTML directory +HTML_IMAGES = + +if ENABLE_DOC_CROSS_REFERENCES +# 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/glib \ + --extra-dir=$(CAIRO_PREFIX)/share/gtk-doc/html/cairo +endif + +include $(top_srcdir)/gtk-doc.make + +# Other files to distribute +EXTRA_DIST += version.xml.in + +if ENABLE_GTK_DOC +TESTS_ENVIRONMENT = cd $(srcdir) && \ + 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/gsk/gsk-docs.xml b/docs/reference/gsk/gsk-docs.xml new file mode 100644 index 0000000000..1384864d44 --- /dev/null +++ b/docs/reference/gsk/gsk-docs.xml @@ -0,0 +1,29 @@ +<?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 version SYSTEM "version.xml"> +]> +<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude"> + <bookinfo> + <title>GSK 3 Reference Manual</title> + <releaseinfo> + This document is for the GSK 3 library, version &version; + The latest versions can be found online at + <ulink role="online-location" url="http://developer.gnome.org/gdk3/">http://developer.gnome.org/gsk3/</ulink>. + </releaseinfo> + </bookinfo> + + <reference id="reference"> + <title>API Reference</title> + <xi:include href="xml/GskRenderer.xml" /> + <xi:include href="xml/GskRenderNode.xml" /> + <xi:include href="xml/GskRenderNodeIter.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> + +</book> diff --git a/docs/reference/gsk/gsk3-sections.txt b/docs/reference/gsk/gsk3-sections.txt new file mode 100644 index 0000000000..36160daca9 --- /dev/null +++ b/docs/reference/gsk/gsk3-sections.txt @@ -0,0 +1,98 @@ +<SECTION> +<FILE>GskRenderer</FILE> +gsk_renderer_get_for_display +gsk_renderer_set_viewport +gsk_renderer_get_viewport +gsk_renderer_set_projection +gsk_renderer_get_projection +gsk_renderer_set_modelview +gsk_renderer_get_modelview +GskScalingFilter +gsk_renderer_set_scaling_filters +gsk_renderer_get_scaling_filters +gsk_renderer_set_scale_factor +gsk_renderer_get_scale_factor +gsk_renderer_set_auto_clear +gsk_renderer_get_auto_clear +gsk_renderer_set_use_alpha +gsk_renderer_get_use_alpha +gsk_renderer_set_window +gsk_renderer_get_window +gsk_renderer_get_display +gsk_renderer_realize +gsk_renderer_unrealize +gsk_renderer_create_render_node +gsk_renderer_render +<SUBSECTION Standard> +GSK_IS_RENDERER +GSK_RENDERER +GSK_TYPE_RENDERER +GskRenderer +GskRendererClass +gsk_renderer_get_type +GSK_TYPE_SCALING_FILTER +</SECTION> + +<SECTION> +<FILE>GskRenderNode</FILE> +gsk_render_node_ref +gsk_render_node_unref +gsk_render_node_get_parent +gsk_render_node_get_first_child +gsk_render_node_get_last_child +gsk_render_node_get_next_sibling +gsk_render_node_get_previous_sibling +gsk_render_node_append_child +gsk_render_node_prepend_child +gsk_render_node_insert_child_at_pos +gsk_render_node_insert_child_before +gsk_render_node_insert_child_after +gsk_render_node_remove_child +gsk_render_node_replace_child +gsk_render_node_remove_all_children +gsk_render_node_get_n_children +gsk_render_node_contains +gsk_render_node_set_bounds +gsk_render_node_set_transform +gsk_render_node_set_anchor_point +gsk_render_node_set_child_transform +gsk_render_node_set_opacity +gsk_render_node_set_hidden +gsk_render_node_is_hidden +gsk_render_node_set_opaque +gsk_render_node_is_opaque +gsk_render_node_get_draw_context +GskBlendMode +gsk_render_node_set_blend_mode +gsk_render_node_get_blend_mode +gsk_render_node_get_scale_factor +gsk_render_node_set_name +gsk_value_set_render_node +gsk_value_take_render_node +gsk_value_get_render_node +gsk_value_dup_render_node +<SUBSECTION Standard> +GSK_IS_RENDER_NODE +GSK_RENDER_NODE +GSK_TYPE_RENDER_NODE +GSK_VALUE_HOLDS_RENDER_NODE +GskRenderNode +GskRenderNodeClass +gsk_render_node_get_type +GSK_TYPE_BLEND_MODE +</SECTION> + +<SECTION> +<FILE>GskRenderNodeIter</FILE> +gsk_render_node_iter_new +gsk_render_node_iter_free +gsk_render_node_iter_init +gsk_render_node_iter_is_valid +gsk_render_node_iter_prev +gsk_render_node_iter_next +gsk_render_node_iter_remove +<SUBSECTION Standard> +GSK_TYPE_RENDER_NODE_ITER +GskRenderNodeIter +gsk_render_node_iter_get_type +</SECTION> diff --git a/docs/reference/gsk/gsk3.types b/docs/reference/gsk/gsk3.types new file mode 100644 index 0000000000..3b80e275a3 --- /dev/null +++ b/docs/reference/gsk/gsk3.types @@ -0,0 +1,3 @@ +gsk_render_node_get_type +gsk_render_node_iter_get_type +gsk_renderer_get_type diff --git a/docs/reference/gsk/version.xml.in b/docs/reference/gsk/version.xml.in new file mode 100644 index 0000000000..3bb59ac105 --- /dev/null +++ b/docs/reference/gsk/version.xml.in @@ -0,0 +1 @@ +@GTK_VERSION@ |