From e0a1f20ca2a0c38015acde9d1e77fa8c3e484a6c Mon Sep 17 00:00:00 2001 From: Emmanuele Bassi Date: Mon, 5 Jul 2010 13:59:36 +0100 Subject: [PATCH] docs: Add Cally API reference --- .gitignore | 14 +++ configure.ac | 2 + doc/reference/Makefile.am | 2 +- doc/reference/cally/Makefile.am | 87 +++++++++++++++++ doc/reference/cally/cally-docs.xml.in | 130 ++++++++++++++++++++++++ doc/reference/cally/cally-sections.txt | 174 +++++++++++++++++++++++++++++++++ doc/reference/cally/cally.types | 9 ++ doc/reference/clutter/Makefile.am | 3 +- 8 files changed, 419 insertions(+), 2 deletions(-) create mode 100644 doc/reference/cally/Makefile.am create mode 100644 doc/reference/cally/cally-docs.xml.in create mode 100644 doc/reference/cally/cally-sections.txt create mode 100644 doc/reference/cally/cally.types diff --git a/.gitignore b/.gitignore index d37b79a..c12698e 100644 --- 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 diff --git a/configure.ac b/configure.ac index fc4a0be..9fe375d 100644 --- 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 diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am index 9c93f95..dc5b739 100644 --- a/doc/reference/Makefile.am +++ b/doc/reference/Makefile.am @@ -1 +1 @@ -SUBDIRS = cogl clutter +SUBDIRS = cogl clutter cally diff --git a/doc/reference/cally/Makefile.am b/doc/reference/cally/Makefile.am new file mode 100644 index 0000000..02d8195 --- /dev/null +++ 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 += diff --git a/doc/reference/cally/cally-docs.xml.in b/doc/reference/cally/cally-docs.xml.in new file mode 100644 index 0000000..e0a5bf3 --- /dev/null +++ b/doc/reference/cally/cally-docs.xml.in @@ -0,0 +1,130 @@ + + +]> + + + + Cally Reference Manual + for Clutter &version; + + + 2010 + Intel Corporation + + + + + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free + Documentation License, 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 GNU Free + Documentation License from the Free Software + Foundation by visiting their Web site or by writing + to: + +
+ The Free Software Foundation, Inc., + 59 Temple Place - Suite 330, + Boston, MA 02111-1307, + USA +
+ + + + + + Cally Reference + + + Base Classes + + + + + + + + + + + Utility API + + + + + + + + + + + Cally Actors and Objects + + + Object Hierarchy + + + + + + Object Index + + + + + + + Index of all symbols + + + + + Index of deprecated symbols + + + + + Index of new symbols in 1.4 + + + + + License + + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General + Public License as published by the Free Software + Foundation; either version 2 of the License, or (at your option) + any later version. + + + + 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 + GNU Library General Public License for + more details. + + + + You may obtain a copy of the GNU Library General + Public License from the Free Software Foundation by + visiting their Web + site or by writing to: + +
+ Free Software Foundation, Inc. + 59 Temple Place - Suite 330 + Boston, MA 02111-1307 + USA +
+ + + + diff --git a/doc/reference/cally/cally-sections.txt b/doc/reference/cally/cally-sections.txt new file mode 100644 index 0000000..bf275e9 --- /dev/null +++ b/doc/reference/cally/cally-sections.txt @@ -0,0 +1,174 @@ +
+cally-clone +CallyClone +CallyClone +CallyCloneClass +cally_clone_new + +CALLY_CLONE +CALLY_IS_CLONE +CALLY_TYPE_CLONE +CALLY_CLONE_CLASS +CALLY_IS_CLONE_CLASS +CALLY_CLONE_GET_CLASS + +CallyClonePrivate +cally_clone_get_type +
+ +
+cally-actor +CallyActor +CallyActor +CallyActorClass +CallyActionFunc +cally_actor_new +cally_actor_add_action +cally_actor_remove_action +cally_actor_remove_action_by_name + +CALLY_ACTOR +CALLY_IS_ACTOR +CALLY_TYPE_ACTOR +CALLY_ACTOR_CLASS +CALLY_IS_ACTOR_CLASS +CALLY_ACTOR_GET_CLASS + +CallyActorPrivate +cally_actor_get_type +
+ +
+cally-text +CallyText +CallyText +CallyTextClass +cally_text_new + +CALLY_TEXT +CALLY_IS_TEXT +CALLY_TYPE_TEXT +CALLY_TEXT_CLASS +CALLY_IS_TEXT_CLASS +CALLY_TEXT_GET_CLASS + +CallyTextPrivate +cally_text_get_type +
+ +
+cally-util +CallyUtil +CallyUtil +CallyUtilClass + +CALLY_UTIL +CALLY_IS_UTIL +CALLY_TYPE_UTIL +CALLY_UTIL_CLASS +CALLY_IS_UTIL_CLASS +CALLY_UTIL_GET_CLASS + +CallyUtilPrivate +cally_util_get_type +
+ +
+cally-texture +CallyTexture +CallyTexture +CallyTextureClass +cally_texture_new + +CALLY_TEXTURE +CALLY_IS_TEXTURE +CALLY_TYPE_TEXTURE +CALLY_TEXTURE_CLASS +CALLY_IS_TEXTURE_CLASS +CALLY_TEXTURE_GET_CLASS + +CallyTexturePrivate +cally_texture_get_type +
+ +
+cally-root +CallyRoot +CallyRoot +CallyRootClass +cally_root_new + +CALLY_ROOT +CALLY_IS_ROOT +CALLY_TYPE_ROOT +CALLY_ROOT_CLASS +CALLY_IS_ROOT_CLASS +CALLY_ROOT_GET_CLASS + +CallyRootPrivate +cally_root_get_type +
+ +
+cally-group +CallyGroup +CallyGroup +CallyGroupClass +cally_group_new + +CALLY_GROUP +CALLY_IS_GROUP +CALLY_TYPE_GROUP +CALLY_GROUP_CLASS +CALLY_IS_GROUP_CLASS +CALLY_GROUP_GET_CLASS + +CallyGroupPrivate +cally_group_get_type +
+ +
+cally-stage +CallyStage +CallyStage +CallyStageClass +cally_stage_new + +CALLY_STAGE +CALLY_IS_STAGE +CALLY_TYPE_STAGE +CALLY_STAGE_CLASS +CALLY_IS_STAGE_CLASS +CALLY_STAGE_GET_CLASS + +CallyStagePrivate +cally_stage_get_type +
+ +
+cally-rectangle +CallyRectangle +CallyRectangle +CallyRectangleClass +cally_rectangle_new + +CALLY_RECTANGLE +CALLY_IS_RECTANGLE +CALLY_TYPE_RECTANGLE +CALLY_RECTANGLE_CLASS +CALLY_IS_RECTANGLE_CLASS +CALLY_RECTANGLE_GET_CLASS + +CallyRectanglePrivate +cally_rectangle_get_type +
+ +
+cally +General API +cally_get_cally_initialized +cally_accessibility_init + +CALLY_ACCESSIBLE_FACTORY +CALLY_ACTOR_SET_FACTORY +
diff --git a/doc/reference/cally/cally.types b/doc/reference/cally/cally.types new file mode 100644 index 0000000..085efc2 --- /dev/null +++ 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 diff --git a/doc/reference/clutter/Makefile.am b/doc/reference/clutter/Makefile.am index 5b89cc0..041231f 100644 --- 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=\ -- 2.7.4