This patch adds documentation of the Python Clutter bindings.
- Almost completely documented clutter.Actor
- Added proper parts and chapters to reference
- Added overview
Cheers,
Daniel Schierbeck
Index: docs/Makefile.am
===
--- docs/Makefile.am (revision 2038)
+++ docs/Makefile.am (working copy)
@@ -10,6 +10,7 @@
XMLFILES = \
reference/clutter-ref.xml \
+reference/clutter-overview.xml \
reference/clutter-cluttercolor.xml \
reference/clutter-clutteractor.xml \
$(NULL)
@@ -18,6 +19,12 @@
HTML_DATA = \
html/index.html\
html/index.sgml\
+ html/pt01.html \
+ html/pt02.html \
+ html/pt03.html \
+ html/pt04.html \
+ html/ch01.html \
+ html/ch02.html \
html/class-cluttercolor.html \
html/class-clutteractor.html \
html/pyclutter-$(REF_VERSION).devhelp
Index: docs/reference/clutter-cluttercolor.xml
===
--- docs/reference/clutter-cluttercolor.xml (revision 2038)
+++ docs/reference/clutter-cluttercolor.xml (working copy)
@@ -4,7 +4,7 @@
refentry id=class-cluttercolor
refnamediv
-refnameclutter.Color/refname
+refnameColors/refname
refpurposeColor management and manipulation./refpurpose
/refnamediv
@@ -26,8 +26,8 @@
/constructorsynopsis
methodsynopsis language=python
- methodnamelink linkend=method-clutter--parseparse/link/methodname
- methodparamparameter role=keywordname/parameter/methodparam
+ methodnamelink linkend=method-cluttercolor--foofoo/link/methodname
+ methodparamparameter role=keywordbar/parameter/methodparam
/methodsynopsis
/classsynopsis
/refsect1
@@ -48,9 +48,9 @@
!-- BEGIN OF CLUTTER DESCRIPTION --
!-- ** --
-refsect1 id=description-clutter-color
+refsect1 id=description-cluttercolor
titleDescription/title
- paralink linkend=class-cluttercolorclassnameClutterColor/classname/link is a simple
+ paralink linkend=class-cluttercolorclassnameclutter.Color/classname/link is a simple
type for representing colors./para
/refsect1
@@ -71,19 +71,19 @@
variablelist
varlistentry
termparameter role=keywordred/parameternbsp;:/term
- listitemsimparaAn integer between 0 and 255/simpara/listitem
+ listitemsimparared component, between 0 and 255/simpara/listitem
/varlistentry
varlistentry
termparameter role=keywordgreen/parameternbsp;:/term
- listitemsimparaAn integer between 0 and 255/simpara/listitem
+ listitemsimparagreen component, between 0 and 255/simpara/listitem
/varlistentry
varlistentry
termparameter role=keywordblue/parameternbsp;:/term
- listitemsimparaAn integer between 0 and 255/simpara/listitem
+ listitemsimparablue component, between 0 and 255/simpara/listitem
/varlistentry
varlistentry
termparameter role=keywordalpha/parameternbsp;:/term
- listitemsimparaAn integer between 0 and 255/simpara/listitem
+ listitemsimparaalpha component, between 0 and 255/simpara/listitem
/varlistentry
varlistentry
termemphasisReturns/emphasisnbsp;:/term
@@ -104,22 +104,25 @@
refsect1
titleMethods/title
- refsect2 id=method-clutter--parse
- titleclutter.Color.parse/title
+ refsect2 id=method-cluttercolor--foo
+ titleclutter.Color.foo/title
- programlistingmethodsynopsis language=python
-methodnameparse/methodname
-methodparam/methodparam
- /methodsynopsis/programlisting
+programlisting
+ methodsynopsis language=python
+methodnamefoo/methodname
+methodparamparameterbar/parameter/methodparam
+ /methodsynopsis
+/programlisting
variablelist
- varlistentry
- /varlistentry
+ varlistentry
+termparametervanizzle/parameternbsp;:/term
+listitemsimparatest/simpara/listitem
+ /varlistentry
/variablelist
para
- The methodnameget_auto_indent/methodname() method returns whether
- auto indentation of text is enabled.
+ Some text.
/para
/refsect2
/refsect1
Index: docs/reference/clutter-overview.xml
===
--- docs/reference/clutter-overview.xml (revision 0)
+++ docs/reference/clutter-overview.xml (revision 0)
@@ -0,0 +1,17 @@
+?xml version=1.0 standalone=no?
+!DOCTYPE refentry PUBLIC -//OASIS//DTD DocBook XML V4.1.2//EN
+http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd;
+
+partintro
+ paraClutter is a GObject based library for creating fast, visually rich
+graphical user interfaces./para
+ paraClutter semantics work by having a stage (a window) and then adding
+actors (widgets) to the stage and manipulating via the actor api. Actors
+can contain child actors (ClutterGroup for example) and be manipulated
+as a whole./para
+ paraAnimations and visual effects can be created via the use of timelines
+and behaviours. Timelines provide accurate frame based animations.
