docs: Add Cally API reference

2010-07-05 13:59:36 +01:00 · 2010-07-05 13:59:36 +01:00 · e0a1f20ca2
parent e110b35694
commit e0a1f20ca2
8 changed files with 419 additions and 2 deletions
--- a/.gitignore
+++ b/.gitignore
@ -29,6 +29,7 @@ stamp-marshal
 /clutter/cogl/cogl/driver/gles/cogl-fixed-fragment-shader.[ch]
 /clutter/x11/clutter-x11-enum-types.[ch]
 /clutter/json/*.gir
+/clutter/cally/cally*.pc
 *.gir
 *.typelib
 config.*
@ -69,6 +70,19 @@ doc/reference/cogl/cogl.signals
 doc/reference/cogl/cogl-docs.xml
 doc/reference/cogl/*.stamp
 doc/reference/cogl/*.bak
+doc/reference/cally/cally-*.txt
+!/doc/reference/cally/cally-sections.txt
+doc/reference/cally/html
+doc/reference/cally/tmpl
+doc/reference/cally/xml
+doc/reference/cally/cally.args
+doc/reference/cally/cally.hierarchy
+doc/reference/cally/cally.interfaces
+doc/reference/cally/cally.prerequisites
+doc/reference/cally/cally.signals
+doc/reference/cally/cally-docs.xml
+doc/reference/cally/*.stamp
+doc/reference/cally/*.bak
 doltcompile
 doltlibtool
 gtk-doc.make
--- a/configure.ac
+++ b/configure.ac
@ -1042,6 +1042,8 @@ AC_CONFIG_FILES([
        doc/reference/clutter/clutter-docs.xml
        doc/reference/cogl/Makefile
        doc/reference/cogl/cogl-docs.xml
+        doc/reference/cally/Makefile
+        doc/reference/cally/cally-docs.xml
        doc/common/Makefile
        doc/manual/Makefile
        doc/manual/clutter-manual.xml
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@ -1 +1 @@
-SUBDIRS = cogl clutter
+SUBDIRS = cogl clutter cally
--- a/doc/reference/cally/Makefile.am
+++ b/doc/reference/cally/Makefile.am
@ -0,0 +1,87 @@
+## Process this file with automake to produce Makefile.in
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# This is a blank Makefile.am for using gtk-doc.
+# Copy this to your project's API docs directory and modify the variables to
+# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
+# of using the various options.
+
+# The name of the module, e.g. 'glib'.
+DOC_MODULE=cally
+
+# The top-level SGML file. You can change this if you want to.
+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=../../../clutter/cally
+
+# 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"
+SCAN_OPTIONS=--deprecated-guards="CALLY_DISABLE_DEPRECATED"
+
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=cally
+
+# Extra options to supply to gtkdoc-mktmpl
+# e.g. MKTMPL_OPTIONS=--only-section-tmpl
+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=../cogl/html \
+	--extra-dir=../clutter/html \
+	--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
+
+# 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/cally/*.h $(top_builddir)/clutter/cally/*.h
+CFILE_GLOB=$(top_srcdir)/clutter/cally/*.c $(top_builddir)/clutter/cally/*.c
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES=cally-actor-private.h
+
+EXTRA_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. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+
+INCLUDES=-I$(top_srcdir) -I$(top_srcdir)/clutter -I$(top_srcdir)/clutter/cogl -I$(top_builddir) -I$(top_builddir)/clutter -I$(top_builddir)/clutter/cogl $(CLUTTER_CFLAGS)
+GTKDOC_LIBS=$(top_builddir)/clutter/libclutter-@CLUTTER_SONAME_INFIX@-@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 +=
--- a/doc/reference/cally/cally-docs.xml.in
+++ b/doc/reference/cally/cally-docs.xml.in
@ -0,0 +1,130 @@
+<?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 version "@VERSION@">
+]>
+
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+  <bookinfo>
+    <title>Cally Reference Manual</title>
+    <releaseinfo>for Clutter &version;</releaseinfo>
+
+    <copyright>
+      <year>2010</year>
+      <holder>Intel Corporation</holder>
+    </copyright>
+
+    <legalnotice>
+      <para>
+        Permission is granted to copy, distribute and/or modify this
+        document under the terms of the <citetitle>GNU Free
+        Documentation License</citetitle>, Version 1.1 or any later
+        version published by the Free Software Foundation with no
+        Invariant Sections, no Front-Cover Texts, and no Back-Cover
+        Texts. You may obtain a copy of the <citetitle>GNU Free
+        Documentation License</citetitle> from the Free Software
+        Foundation by visiting <ulink type="http"
+        url="http://www.fsf.org">their Web site</ulink> or by writing
+        to:
+
+        <address>
+          The Free Software Foundation, Inc.,
+          <street>59 Temple Place</street> - Suite 330,
+          <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
+          <country>USA</country>
+        </address>
+      </para>
+    </legalnotice>
+  </bookinfo>
+
+  <part id="callybase">
+    <title>Cally Reference</title>
+
+    <chapter>
+      <title>Base Classes</title>
+
+      <xi:include href="xml/cally-actor.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="callyobjects">
+    <title>Cally Actors and Objects</title>
+
+    <chapter id="callyobjecthierarchy">
+      <title>Object Hierarchy</title>
+
+      <xi:include href="xml/tree_index.sgml"><xi:fallback /></xi:include>
+    </chapter>
+
+    <chapter id="callyobjectindex">
+      <title>Object Index</title>
+
+      <xi:include href="xml/object_index.sgml"><xi:fallback /></xi:include>
+    </chapter>
+  </part>
+
+  <index>
+    <title>Index of all symbols</title>
+    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+  </index>
+
+  <index role="deprecated">
+    <title>Index of deprecated symbols</title>
+    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+  </index>
+
+  <index role="1.4">
+    <title>Index of new symbols in 1.4</title>
+    <xi:include href="xml/api-index-1.4.xml"><xi:fallback /></xi:include>
+  </index>
+
+  <appendix id="license">
+    <title>License</title>
+
+    <para>
+      This library is free software; you can redistribute it and/or
+      modify it under the terms of the <citetitle>GNU Library General
+      Public License</citetitle> as published by the Free Software
+      Foundation; either version 2 of the License, or (at your option)
+      any later version.
+    </para>
+
+    <para>
+      This library is distributed in the hope that it will be useful,
+      but WITHOUT ANY WARRANTY; without even the implied warranty of
+      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+      <citetitle>GNU Library General Public License</citetitle> for
+      more details.
+    </para>
+
+    <para>
+      You may obtain a copy of the <citetitle>GNU Library General
+      Public License</citetitle> from the Free Software Foundation by
+      visiting <ulink type="http" url="http://www.fsf.org">their Web
+      site</ulink> or by writing to:
+
+      <address>
+        Free Software Foundation, Inc.
+        <street>59 Temple Place</street> - Suite 330
+        <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
+        <country>USA</country>
+      </address>
+    </para>
+  </appendix>
+
+</book>
--- a/doc/reference/cally/cally-sections.txt
+++ b/doc/reference/cally/cally-sections.txt
@ -0,0 +1,174 @@
+<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
+cally_actor_new
+cally_actor_add_action
+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-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-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>
--- a/doc/reference/cally/cally.types
+++ b/doc/reference/cally/cally.types
@ -0,0 +1,9 @@
+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
--- a/doc/reference/clutter/Makefile.am
+++ b/doc/reference/clutter/Makefile.am
@ -81,13 +81,14 @@ IGNORE_HFILES=\
 	clutter-script-private.h 	\
 	clutter-stage-window.h 		\
 	clutter-timeout-interval.h 	\
+	cally				\
 	cogl 				\
 	egl 				\
 	fruity				\
 	glx 				\
+	json 				\
 	osx 				\
 	x11 				\
-	json 				\
 	win32

 EXTRA_HFILES=\