2010/2/8 Pablo Martí Gamboa <[email protected]> > Hi all, > > this last weekend I've been working on improving pyclutter docs, its a > daunting task so some help would be certainly welcome. > > I'll reply to this thread with every single patch > > -- > Pablo Martí > http://www.linkedin.com/in/pmarti || http://www.warp.es > python -c "print '706d6172746940776172702e6573'.decode('hex')" > >
-- Pablo Martí http://www.linkedin.com/in/pmarti || http://www.warp.es python -c "print '706d6172746940776172702e6573'.decode('hex')"
From 14bb2d02058bdd339d15759c44c2bd6734c3b8ca Mon Sep 17 00:00:00 2001 From: =?utf-8?q?Pablo=20Mart=C3=AD?= <[email protected]> Date: Mon, 8 Feb 2010 08:52:19 +0100 Subject: [PATCH 04/21] doc fixes for clutter.BehaviourEllipse --- docs/reference/clutter-clutterbehaviourellipse.xml | 176 +++++++++++-------- 1 files changed, 102 insertions(+), 74 deletions(-) diff --git a/docs/reference/clutter-clutterbehaviourellipse.xml b/docs/reference/clutter-clutterbehaviourellipse.xml index 18686d6..83486ce 100644 --- a/docs/reference/clutter-clutterbehaviourellipse.xml +++ b/docs/reference/clutter-clutterbehaviourellipse.xml @@ -20,13 +20,13 @@ <ooclass><classname><link linkend="class-clutterbehaviour">clutter.Behaviour</link></classname></ooclass> <constructorsynopsis language="python"> <methodname>__init__</methodname> - <methodparam><parameter>alpha</parameter></methodparam> - <methodparam><parameter>x</parameter></methodparam> - <methodparam><parameter>y</parameter></methodparam> - <methodparam><parameter>width</parameter></methodparam> - <methodparam><parameter>height</parameter></methodparam> - <methodparam><parameter>start</parameter></methodparam> - <methodparam><parameter>end</parameter></methodparam> + <methodparam><parameter role="keyword">alpha</parameter><initializer>None</initializer></methodparam> + <methodparam><parameter role="keyword">x</parameter><initializer>0</initializer></methodparam> + <methodparam><parameter role="keyword">y</parameter><initializer>0</initializer></methodparam> + <methodparam><parameter role="keyword">width</parameter><initializer>0</initializer></methodparam> + <methodparam><parameter role="keyword">height</parameter><initializer>0</initializer></methodparam> + <methodparam><parameter role="keyword">start</parameter><initializer>0.0</initializer></methodparam> + <methodparam><parameter role="keyword">end</parameter><initializer>0.0</initializer></methodparam> </constructorsynopsis> <methodsynopsis language="python"> <methodname><link linkend="method-clutterbehaviourellipse--set-center">set_center</link></methodname> @@ -83,10 +83,7 @@ </methodsynopsis> <methodsynopsis language="python"> <methodname><link linkend="method-clutterbehaviourellipse--get-tilt">get_tilt</link></methodname> - <methodparam><parameter>angle_tilt_x</parameter></methodparam> - <methodparam><parameter>angle_tilt_y</parameter></methodparam> - <methodparam><parameter>angle_tilt_z</parameter></methodparam> - </methodsynopsis> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> <methodname><link linkend="method-clutterbehaviourellipse--get-direction">get_direction</link></methodname> <methodparam></methodparam> </methodsynopsis> @@ -111,46 +108,46 @@ <programlisting><constructorsynopsis language="python"> <methodname>__init__</methodname> - <methodparam><parameter>alpha</parameter></methodparam> - <methodparam><parameter>x</parameter></methodparam> - <methodparam><parameter>y</parameter></methodparam> - <methodparam><parameter>width</parameter></methodparam> - <methodparam><parameter>height</parameter></methodparam> - <methodparam><parameter>start</parameter></methodparam> - <methodparam><parameter>end</parameter></methodparam> + <methodparam><parameter role="keyword">alpha</parameter></methodparam> + <methodparam><parameter role="keyword">x</parameter></methodparam> + <methodparam><parameter role="keyword">y</parameter></methodparam> + <methodparam><parameter role="keyword">width</parameter></methodparam> + <methodparam><parameter role="keyword">height</parameter></methodparam> + <methodparam><parameter role="keyword">start</parameter></methodparam> + <methodparam><parameter role="keyword">end</parameter></methodparam> </constructorsynopsis></programlisting> <variablelist> <varlistentry> - <term><parameter>alpha</parameter> :</term> - <listitem><simpara>a ClutterAlpha*</simpara></listitem> + <term><parameter role="keyword">alpha</parameter> :</term> + <listitem><simpara>a <link linkend="class-clutteralpha"><classname>clutter.Alpha</classname></link> or <parameter>None</parameter></simpara></listitem> </varlistentry> <varlistentry> - <term><parameter>x</parameter> :</term> - <listitem><simpara>a gint</simpara></listitem> + <term><parameter role="keyword">x</parameter> :</term> + <listitem><simpara>x coordinace of the center</simpara></listitem> </varlistentry> <varlistentry> - <term><parameter>y</parameter> :</term> - <listitem><simpara>a gint</simpara></listitem> + <term><parameter role="keyword">y</parameter> :</term> + <listitem><simpara>y coordinace of the center</simpara></listitem> </varlistentry> <varlistentry> - <term><parameter>width</parameter> :</term> - <listitem><simpara>a gint</simpara></listitem> + <term><parameter role="keyword">width</parameter> :</term> + <listitem><simpara>width of the ellipse</simpara></listitem> </varlistentry> <varlistentry> - <term><parameter>height</parameter> :</term> - <listitem><simpara>a gint</simpara></listitem> + <term><parameter role="keyword">height</parameter> :</term> + <listitem><simpara>height of the ellipse</simpara></listitem> </varlistentry> <varlistentry> - <term><parameter>start</parameter> :</term> - <listitem><simpara>a gdouble</simpara></listitem> + <term><parameter role="keyword">start</parameter> :</term> + <listitem><simpara>angle in degrees at which movement starts, between 0 and 360</simpara></listitem> </varlistentry> <varlistentry> - <term><parameter>end</parameter> :</term> - <listitem><simpara>a gdouble</simpara></listitem> + <term><parameter role="keyword">end</parameter> :</term> + <listitem><simpara>angle in degrees at which movement ends, between 0 and 360</simpara></listitem> </varlistentry> <varlistentry> <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a ClutterBehaviour*</simpara></listitem> + <listitem><simpara>the newly created <link linkend="class-clutterbehaviourellipse"><classname>clutter.BehaviourEllipse</classname></link></simpara></listitem> </varlistentry> </variablelist> @@ -171,13 +168,16 @@ <variablelist> <varlistentry> <term><parameter>x</parameter> :</term> - <listitem><simpara>a gint</simpara></listitem> + <listitem><simpara>x coordinace of centre</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>y</parameter> :</term> - <listitem><simpara>a gint</simpara></listitem> + <listitem><simpara>y coordinace of centre</simpara></listitem> </varlistentry> </variablelist> + <para> + Sets the center of the elliptical path to the point represented by knot. + </para> </refsect2> @@ -186,19 +186,16 @@ <programlisting><methodsynopsis language="python"> <methodname>get_center</methodname> - <methodparam><parameter>x</parameter></methodparam> - <methodparam><parameter>y</parameter></methodparam> </methodsynopsis></programlisting> <variablelist> <varlistentry> - <term><parameter>x</parameter> :</term> - <listitem><simpara>a gint*</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>y</parameter> :</term> - <listitem><simpara>a gint*</simpara></listitem> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>a 2-tuple with the X and Y coordinates of the center</simpara></listitem> </varlistentry> </variablelist> + <para> + Returns the center of the elliptical path path. + </para> </refsect2> @@ -212,9 +209,12 @@ <variablelist> <varlistentry> <term><parameter>width</parameter> :</term> - <listitem><simpara>a gint</simpara></listitem> + <listitem><simpara>width of the ellipse</simpara></listitem> </varlistentry> </variablelist> + <para> + Sets the width of the elliptical path. + </para> </refsect2> @@ -227,9 +227,12 @@ <variablelist> <varlistentry> <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a gint</simpara></listitem> + <listitem><simpara>the width of the path</simpara></listitem> </varlistentry> </variablelist> + <para> + Returns the width of the elliptical path. + </para> </refsect2> @@ -243,9 +246,12 @@ <variablelist> <varlistentry> <term><parameter>height</parameter> :</term> - <listitem><simpara>a gint</simpara></listitem> + <listitem><simpara>height of the ellipse</simpara></listitem> </varlistentry> </variablelist> + <para> + Sets the height of the elliptical path. + </para> </refsect2> @@ -258,9 +264,12 @@ <variablelist> <varlistentry> <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a gint</simpara></listitem> + <listitem><simpara>the height of the path</simpara></listitem> </varlistentry> </variablelist> + <para> + Returns the height of the elliptical path. + </para> </refsect2> @@ -274,9 +283,12 @@ <variablelist> <varlistentry> <term><parameter>angle_start</parameter> :</term> - <listitem><simpara>a gdouble</simpara></listitem> + <listitem><simpara>angle at which movement starts in degrees, between 0 and 360.</simpara></listitem> </varlistentry> </variablelist> + <para> + Sets the angle at which movement starts; angles >= 360 degress get clamped to the canonical interval (0, 360). + </para> </refsect2> @@ -289,9 +301,12 @@ <variablelist> <varlistentry> <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a gdouble</simpara></listitem> + <listitem><simpara>angle in degrees</simpara></listitem> </varlistentry> </variablelist> + <para> + Gets the angle at which movements starts. + </para> </refsect2> @@ -305,9 +320,12 @@ <variablelist> <varlistentry> <term><parameter>angle_end</parameter> :</term> - <listitem><simpara>a gdouble</simpara></listitem> + <listitem><simpara>angle at which movement ends in degrees, between 0 and 360.</simpara></listitem> </varlistentry> </variablelist> + <para> + Sets the angle at which movement ends; angles >= 360 degress get clamped to the canonical interval (0, 360). + </para> </refsect2> @@ -320,9 +338,12 @@ <variablelist> <varlistentry> <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a gdouble</simpara></listitem> + <listitem><simpara>angle in degrees</simpara></listitem> </varlistentry> </variablelist> + <para> + Gets the angle at which movements ends. + </para> </refsect2> @@ -337,13 +358,16 @@ <variablelist> <varlistentry> <term><parameter>axis</parameter> :</term> - <listitem><simpara>a ClutterRotateAxis</simpara></listitem> + <listitem><simpara>a clutter.RotateAxis enum</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>angle_tilt</parameter> :</term> - <listitem><simpara>a gdouble</simpara></listitem> + <listitem><simpara>tilt of the elipse around the center in the given axis in degrees.</simpara></listitem> </varlistentry> </variablelist> + <para> + Sets the angle at which the ellipse should be tilted around its center. + </para> </refsect2> @@ -357,13 +381,16 @@ <variablelist> <varlistentry> <term><parameter>axis</parameter> :</term> - <listitem><simpara>a ClutterRotateAxis</simpara></listitem> + <listitem><simpara>a clutter.RotateAxis enum</simpara></listitem> </varlistentry> <varlistentry> <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a gdouble</simpara></listitem> + <listitem><simpara>angle in degrees.</simpara></listitem> </varlistentry> </variablelist> + <para> + Returs the tilt of the ellipse around the center in the given axis. + </para> </refsect2> @@ -379,17 +406,20 @@ <variablelist> <varlistentry> <term><parameter>angle_tilt_x</parameter> :</term> - <listitem><simpara>a gdouble</simpara></listitem> + <listitem><simpara>tilt of the elipse around the center in X axis in degrees.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>angle_tilt_y</parameter> :</term> - <listitem><simpara>a gdouble</simpara></listitem> + <listitem><simpara>tilt of the elipse around the center in Y axis in degrees.</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>angle_tilt_z</parameter> :</term> - <listitem><simpara>a gdouble</simpara></listitem> + <listitem><simpara>tilt of the elipse around the center in Z axis in degrees.</simpara></listitem> </varlistentry> </variablelist> + <para> + Sets the angles at which the ellipse should be tilted around its center. + </para> </refsect2> @@ -398,24 +428,17 @@ <programlisting><methodsynopsis language="python"> <methodname>get_tilt</methodname> - <methodparam><parameter>angle_tilt_x</parameter></methodparam> - <methodparam><parameter>angle_tilt_y</parameter></methodparam> - <methodparam><parameter>angle_tilt_z</parameter></methodparam> + <methodparam></methodparam> </methodsynopsis></programlisting> <variablelist> <varlistentry> - <term><parameter>angle_tilt_x</parameter> :</term> - <listitem><simpara>a gdouble*</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>angle_tilt_y</parameter> :</term> - <listitem><simpara>a gdouble*</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>angle_tilt_z</parameter> :</term> - <listitem><simpara>a gdouble*</simpara></listitem> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>a 3-tuple containing angle_tilt_x, angle_tilt_y and angle_tilt_z</simpara></listitem> </varlistentry> </variablelist> + <para> + Returns the angles at which the ellipse should be tilted around its center. + </para> </refsect2> @@ -428,9 +451,12 @@ <variablelist> <varlistentry> <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a ClutterRotateDirection</simpara></listitem> + <listitem><simpara>a clutter.RotateDirection enum</simpara></listitem> </varlistentry> </variablelist> + <para> + Returns the clutter.ºRotateDirection value used by the ellipse behaviour. + </para> </refsect2> @@ -444,11 +470,13 @@ <variablelist> <varlistentry> <term><parameter>direction</parameter> :</term> - <listitem><simpara>a ClutterRotateDirection</simpara></listitem> + <listitem><simpara>a clutter.RotateDirection enum</simpara></listitem> </varlistentry> </variablelist> + <para> + Sets the rotation direction used by the ellipse behaviour. + </para> </refsect2> - </refsect1> </refentry> -- 1.6.3.3
