[clutter] docs: Merge Clutter and Cally API reference

From: Emmanuele Bassi <ebassi src gnome org>
To: commits-list gnome org
Cc:
Subject: [clutter] docs: Merge Clutter and Cally API reference
Date: Tue, 19 May 2015 14:28:16 +0000 (UTC)
commit 6088437786b76bb3f3dc400ce6d57bedf33b1def
Author: Emmanuele Bassi <ebassi gnome org>
Date:   Tue May 19 12:58:08 2015 +0100

    docs: Merge Clutter and Cally API reference
    
    It's pretty much pointless to have two API references:
    
     • the Cally API reference is fairly small
     • the build system is already complicated as it is
     • GTK-Doc isn't smart enough to ignore sub-directories
     • Cally is not a separate library, just a separate namespace
    
    There are some issues with GTK-Doc not accepting multiple namespaces,
    but nothing seriously tragic.

 doc/reference/Makefile.am                  |    4 +-
 doc/reference/clutter/Makefile.am          |   68 +++--------
 doc/reference/clutter/clutter-docs.xml.in  |   34 ++++++
 doc/reference/clutter/clutter-sections.txt |  177 ++++++++++++++++++++++++++++
 doc/reference/clutter/clutter.types        |   50 +++++++-
 5 files changed, 272 insertions(+), 61 deletions(-)
---
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index 5c120d9..121968a 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -1,3 +1 @@
-SUBDIRS = clutter cally
-
-DIST_SUBDIRS = clutter cally
+SUBDIRS = clutter
diff --git a/doc/reference/clutter/Makefile.am b/doc/reference/clutter/Makefile.am
index 9fc9f47..df25a59 100644
--- a/doc/reference/clutter/Makefile.am
+++ b/doc/reference/clutter/Makefile.am
@@ -1,39 +1,25 @@
 DOC_MODULE = clutter
 DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml
-
-# The directory containing the source code. Relative to $(srcdir).
-# gtk-doc will search all .c & .h files beneath here for inline comments
-# documenting the functions and macros.
-# e.g. DOC_SOURCE_DIR=../../../gtk
 DOC_SOURCE_DIR = $(top_srcdir)/clutter $(top_builddir)/clutter
 
-# Extra options to pass to gtkdoc-scangobj. Not normally needed.
-SCANGOBJ_OPTIONS = --type-init-func="clutter_base_init()"
-
-# Extra options to supply to gtkdoc-scan.
-# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCANGOBJ_OPTIONS =
 SCAN_OPTIONS =
-
-# Extra options to supply to gtkdoc-mkdb.
-# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
-MKDB_OPTIONS = --output-format=xml --name-space=clutter
-
-# Extra options to supply to gtkdoc-mktmpl
-# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+MKDB_OPTIONS = --xml-mode --output-format=xml --name-space=clutter
 MKTMPL_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 = \
        --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \
        --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \
        --extra-dir=$(CAIRO_PREFIX)/share/gtk-doc/html/cairo \
        --extra-dir=$(PANGO_PREFIX)/share/gtk-doc/html/pango \
-       --extra-dir=$(COGL_PREFIX)/share/gtk-doc/html/cogl
+       --extra-dir=$(COGL_PREFIX)/share/gtk-doc/html/cogl \
+       --extra-dir=$(GDK_PREFIX)/share/gtk-doc/html/gdk \
+       --extra-dir=$(ATK_PREFIX)/share/gtk-doc/html/atk
+
+BUILT_HFILES = \
+       clutter-enum-types.h \
+       clutter-version.h \
+       clutter-marshal.h
 
-# 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)/clutter/*.h \
        $(top_builddir)/clutter/*.h \
@@ -48,10 +34,12 @@ HFILE_GLOB = \
        $(top_srcdir)/clutter/wayland/clutter-wayland.h \
        $(top_srcdir)/clutter/wayland/clutter-wayland-compositor.h \
        $(top_srcdir)/clutter/wayland/clutter-wayland-surface.h \
-       $(top_srcdir)/clutter/mir/clutter-mir.h
+       $(top_srcdir)/clutter/mir/clutter-mir.h \
+       $(top_srcdir)/clutter/cally/*.h
 
 CFILE_GLOB = \
        $(top_srcdir)/clutter/*.c \
+       $(top_srcdir)/clutter/cally/*.c \
        $(top_srcdir)/clutter/cogl/*.c \
        $(top_srcdir)/clutter/x11/*.c \
        $(top_srcdir)/clutter/win32/*.c \
@@ -62,8 +50,6 @@ CFILE_GLOB = \
        $(top_srcdir)/clutter/mir/*.c \
        $(top_srcdir)/clutter/deprecated/*.c
 
-# Header files to ignore when scanning.
-# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
 IGNORE_HFILES = \
        config.h                        \
        clutter.h                       \
@@ -100,7 +86,7 @@ IGNORE_HFILES = \
        clutter-stage-private.h         \
        clutter-stage-window.h          \
        clutter-timeout-interval.h      \
-       cally                           \
+       cally-actor-private.h           \
        cex100                          \
        cogl                            \
        egl                             \
@@ -126,8 +112,6 @@ EXTRA_HFILES = \
        $(top_srcdir)/clutter/wayland/clutter-wayland-surface.h \
        $(top_srcdir)/clutter/mir/clutter-mir.h
 
-# Images to copy into HTML directory.
-# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
 HTML_IMAGES = \
        actor-box.png \
        actor-example.png \
@@ -142,13 +126,10 @@ HTML_IMAGES = \
        offscreen-redirect.png \
        table-layout.png
 
-# SVG used to generate the images above
 SVG_IMAGES = \
        animator-key-frames.svg \
         easing-modes.svg
 
-# 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 = \
        glossary.xml \
        clutter-overview.xml \
@@ -159,9 +140,6 @@ content_files = \
        migrating-ClutterEffect.xml \
        migrating-ClutterPath.xml
 
-# 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 = \
        glossary.xml \
        clutter-overview.xml \
@@ -172,26 +150,12 @@ expand_content_files = \
        migrating-ClutterEffect.xml \
        migrating-ClutterPath.xml
 
-# 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. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
-# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
-
-AM_CPPFLAGS = \
-       -I$(top_srcdir) \
-       -I$(top_srcdir)/clutter \
-       -I$(top_builddir) \
-       -I$(top_builddir)/clutter \
-       -DCLUTTER_DISABLE_DEPRECATION_WARNINGS
-AM_CFLAGS = $(CLUTTER_CFLAGS)
+GTKDOC_CFLAGS = -I$(top_srcdir) -I$(top_builddir) -DCLUTTER_DISABLE_DEPRECATION_WARNINGS $(CLUTTER_CFLAGS)
 GTKDOC_LIBS = $(top_builddir)/clutter/libclutter- CLUTTER_API_VERSION@.la $(CLUTTER_LIBS)
 
-# 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 += clutter.types
 EXTRA_DIST += $(HTML_IMAGES) $(SVG_IMAGES)
 
 if ENABLE_GTK_DOC
diff --git a/doc/reference/clutter/clutter-docs.xml.in b/doc/reference/clutter/clutter-docs.xml.in
index 182dfb6..28095ca 100644
--- a/doc/reference/clutter/clutter-docs.xml.in
+++ b/doc/reference/clutter/clutter-docs.xml.in
@@ -227,6 +227,40 @@
     <xi:include href="xml/clutter-mir.xml"/>
   </part>
 
+  <part id="cally">
+    <title>Accessibility</title>
+
+    <partintro>
+      <para>Clutter provides support for accessibility technologies by
+      implementing the ATK interfaces. Since Clutter is a low-level tool
+      kit, and developers are supposed to create more complex actor
+      classes, we expose a low level API under the Cally namespace; this
+      API can be used as the base to build more accessibility features
+      inside custom derived ClutterActor classes.</para>
+    </partintro>
+
+    <chapter>
+      <title>Base Classes</title>
+
+      <xi:include href="xml/cally-actor.xml"/>
+      <xi:include href="xml/cally-group.xml"/>
+      <xi:include href="xml/cally-stage.xml"/>
+      <xi:include href="xml/cally-texture.xml"/>
+      <xi:include href="xml/cally-rectangle.xml"/>
+      <xi:include href="xml/cally-text.xml"/>
+      <xi:include href="xml/cally-clone.xml"/>
+    </chapter>
+
+    <chapter>
+      <title>Utility API</title>
+
+      <xi:include href="xml/cally.xml"/>
+      <xi:include href="xml/cally-util.xml"/>
+      <xi:include href="xml/cally-root.xml"/>
+
+    </chapter>
+  </part>
+
   <part id="migration">
     <title>Migrating from previous version of Clutter</title>
 
diff --git a/doc/reference/clutter/clutter-sections.txt b/doc/reference/clutter/clutter-sections.txt
index 6d2d336..1591b06 100644
--- a/doc/reference/clutter/clutter-sections.txt
+++ b/doc/reference/clutter/clutter-sections.txt
@@ -3601,3 +3601,180 @@ clutter_mir_set_connection
 clutter_mir_stage_get_mir_surface
 clutter_mir_stage_set_mir_surface
 </SECTION>
+
+<SECTION>
+<FILE>cally-stage</FILE>
+<TITLE>CallyStage</TITLE>
+CallyStage
+CallyStageClass
+cally_stage_new
+<SUBSECTION Standard>
+CALLY_STAGE
+CALLY_IS_STAGE
+CALLY_TYPE_STAGE
+CALLY_STAGE_CLASS
+CALLY_IS_STAGE_CLASS
+CALLY_STAGE_GET_CLASS
+<SUBSECTION Private>
+CallyStagePrivate
+cally_stage_get_type
+</SECTION>
+
+<SECTION>
+<FILE>cally-clone</FILE>
+<TITLE>CallyClone</TITLE>
+CallyClone
+CallyCloneClass
+cally_clone_new
+<SUBSECTION Standard>
+CALLY_CLONE
+CALLY_IS_CLONE
+CALLY_TYPE_CLONE
+CALLY_CLONE_CLASS
+CALLY_IS_CLONE_CLASS
+CALLY_CLONE_GET_CLASS
+<SUBSECTION Private>
+CallyClonePrivate
+cally_clone_get_type
+</SECTION>
+
+<SECTION>
+<FILE>cally-actor</FILE>
+<TITLE>CallyActor</TITLE>
+CallyActor
+CallyActorClass
+CallyActionFunc
+CallyActionCallback
+cally_actor_new
+cally_actor_add_action
+cally_actor_add_action_full
+cally_actor_remove_action
+cally_actor_remove_action_by_name
+<SUBSECTION Standard>
+CALLY_ACTOR
+CALLY_IS_ACTOR
+CALLY_TYPE_ACTOR
+CALLY_ACTOR_CLASS
+CALLY_IS_ACTOR_CLASS
+CALLY_ACTOR_GET_CLASS
+<SUBSECTION Private>
+CallyActorPrivate
+cally_actor_get_type
+</SECTION>
+
+<SECTION>
+<FILE>cally-text</FILE>
+<TITLE>CallyText</TITLE>
+CallyText
+CallyTextClass
+cally_text_new
+<SUBSECTION Standard>
+CALLY_TEXT
+CALLY_IS_TEXT
+CALLY_TYPE_TEXT
+CALLY_TEXT_CLASS
+CALLY_IS_TEXT_CLASS
+CALLY_TEXT_GET_CLASS
+<SUBSECTION Private>
+CallyTextPrivate
+cally_text_get_type
+</SECTION>
+
+<SECTION>
+<FILE>cally-util</FILE>
+<TITLE>CallyUtil</TITLE>
+CallyUtil
+CallyUtilClass
+<SUBSECTION Standard>
+CALLY_UTIL
+CALLY_IS_UTIL
+CALLY_TYPE_UTIL
+CALLY_UTIL_CLASS
+CALLY_IS_UTIL_CLASS
+CALLY_UTIL_GET_CLASS
+<SUBSECTION Private>
+CallyUtilPrivate
+cally_util_get_type
+</SECTION>
+
+<SECTION>
+<FILE>cally-texture</FILE>
+<TITLE>CallyTexture</TITLE>
+CallyTexture
+CallyTextureClass
+cally_texture_new
+<SUBSECTION Standard>
+CALLY_TEXTURE
+CALLY_IS_TEXTURE
+CALLY_TYPE_TEXTURE
+CALLY_TEXTURE_CLASS
+CALLY_IS_TEXTURE_CLASS
+CALLY_TEXTURE_GET_CLASS
+<SUBSECTION Private>
+CallyTexturePrivate
+cally_texture_get_type
+</SECTION>
+
+<SECTION>
+<FILE>cally-root</FILE>
+<TITLE>CallyRoot</TITLE>
+CallyRoot
+CallyRootClass
+cally_root_new
+<SUBSECTION Standard>
+CALLY_ROOT
+CALLY_IS_ROOT
+CALLY_TYPE_ROOT
+CALLY_ROOT_CLASS
+CALLY_IS_ROOT_CLASS
+CALLY_ROOT_GET_CLASS
+<SUBSECTION Private>
+CallyRootPrivate
+cally_root_get_type
+</SECTION>
+
+<SECTION>
+<FILE>cally-group</FILE>
+<TITLE>CallyGroup</TITLE>
+CallyGroup
+CallyGroupClass
+cally_group_new
+<SUBSECTION Standard>
+CALLY_GROUP
+CALLY_IS_GROUP
+CALLY_TYPE_GROUP
+CALLY_GROUP_CLASS
+CALLY_IS_GROUP_CLASS
+CALLY_GROUP_GET_CLASS
+<SUBSECTION Private>
+CallyGroupPrivate
+cally_group_get_type
+</SECTION>
+
+<SECTION>
+<FILE>cally-rectangle</FILE>
+<TITLE>CallyRectangle</TITLE>
+CallyRectangle
+CallyRectangleClass
+cally_rectangle_new
+<SUBSECTION Standard>
+CALLY_RECTANGLE
+CALLY_IS_RECTANGLE
+CALLY_TYPE_RECTANGLE
+CALLY_RECTANGLE_CLASS
+CALLY_IS_RECTANGLE_CLASS
+CALLY_RECTANGLE_GET_CLASS
+<SUBSECTION Private>
+CallyRectanglePrivate
+cally_rectangle_get_type
+</SECTION>
+
+<SECTION>
+<FILE>cally</FILE>
+<TITLE>General API</TITLE>
+cally_get_cally_initialized
+cally_accessibility_init
+<SUBSECTION>
+CALLY_ACCESSIBLE_FACTORY
+CALLY_ACTOR_SET_FACTORY
+</SECTION>
diff --git a/doc/reference/clutter/clutter.types b/doc/reference/clutter/clutter.types
index 1fd1996..0037acc 100644
--- a/doc/reference/clutter/clutter.types
+++ b/doc/reference/clutter/clutter.types
@@ -1,5 +1,14 @@
-#include <clutter/clutter.h>
+cally_actor_get_type
+cally_clone_get_type
+cally_group_get_type
+cally_rectangle_get_type
+cally_root_get_type
+cally_stage_get_type
+cally_text_get_type
+cally_texture_get_type
+cally_util_get_type
 clutter_action_get_type
+clutter_actor_box_get_type
 clutter_actor_get_type
 clutter_actor_meta_get_type
 clutter_align_constraint_get_type
@@ -7,6 +16,7 @@ clutter_alpha_get_type
 clutter_animatable_get_type
 clutter_animation_get_type
 clutter_animator_get_type
+clutter_animator_key_get_type
 clutter_backend_get_type
 clutter_behaviour_depth_get_type
 clutter_behaviour_ellipse_get_type
@@ -15,18 +25,21 @@ clutter_behaviour_opacity_get_type
 clutter_behaviour_path_get_type
 clutter_behaviour_rotate_get_type
 clutter_behaviour_scale_get_type
+clutter_bin_layout_get_type
 clutter_bind_constraint_get_type
 clutter_binding_pool_get_type
-clutter_bin_layout_get_type
 clutter_blur_effect_get_type
 clutter_box_get_type
 clutter_box_layout_get_type
 clutter_brightness_contrast_effect_get_type
-clutter_canvas_get_type
 clutter_cairo_texture_get_type
+clutter_canvas_get_type
 clutter_child_meta_get_type
 clutter_click_action_get_type
+clutter_clip_node_get_type
 clutter_clone_get_type
+clutter_color_get_type
+clutter_color_node_get_type
 clutter_colorize_effect_get_type
 clutter_constraint_get_type
 clutter_container_get_type
@@ -37,48 +50,73 @@ clutter_device_manager_get_type
 clutter_drag_action_get_type
 clutter_drop_action_get_type
 clutter_effect_get_type
+clutter_event_get_type
+clutter_event_sequence_get_type
 clutter_fixed_layout_get_type
 clutter_flow_layout_get_type
+clutter_fog_get_type
+clutter_geometry_get_type
 clutter_gesture_action_get_type
+clutter_glx_texture_pixmap_get_type
 clutter_grid_layout_get_type
 clutter_group_get_type
 clutter_image_get_type
 clutter_input_device_get_type
 clutter_interval_get_type
 clutter_keyframe_transition_get_type
+clutter_knot_get_type
 clutter_layout_manager_get_type
 clutter_layout_meta_get_type
 clutter_list_model_get_type
+clutter_margin_get_type
 clutter_media_get_type
 clutter_model_get_type
 clutter_model_iter_get_type
 clutter_offscreen_effect_get_type
 clutter_page_turn_effect_get_type
-clutter_pan_action_get_type
 clutter_paint_node_get_type
+clutter_paint_volume_get_type
+clutter_pan_action_get_type
+clutter_param_color_get_type
+clutter_param_fixed_get_type
+clutter_param_units_get_type
 clutter_path_constraint_get_type
 clutter_path_get_type
+clutter_path_node_get_type
+clutter_perspective_get_type
+clutter_pipeline_node_get_type
+clutter_point_get_type
 clutter_property_transition_get_type
+clutter_rect_get_type
 clutter_rectangle_get_type
 clutter_rotate_action_get_type
 clutter_score_get_type
-clutter_scriptable_get_type
 clutter_script_get_type
+clutter_scriptable_get_type
 clutter_scroll_actor_get_type
 clutter_settings_get_type
-clutter_shader_get_type
 clutter_shader_effect_get_type
+clutter_shader_float_get_type
+clutter_shader_get_type
+clutter_shader_int_get_type
+clutter_shader_matrix_get_type
+clutter_size_get_type
 clutter_snap_constraint_get_type
 clutter_stage_get_type
 clutter_stage_manager_get_type
 clutter_state_get_type
+clutter_state_key_get_type
 clutter_swipe_action_get_type
 clutter_table_layout_get_type
 clutter_tap_action_get_type
 clutter_text_buffer_get_type
 clutter_text_get_type
+clutter_text_node_get_type
 clutter_texture_get_type
+clutter_texture_node_get_type
 clutter_timeline_get_type
 clutter_transition_get_type
 clutter_transition_group_get_type
+clutter_units_get_type
+clutter_vertex_get_type
 clutter_zoom_action_get_type
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]