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 b3ad466372ffca00a846363e227d908dd95b6494 Mon Sep 17 00:00:00 2001 From: =?utf-8?q?Pablo=20Mart=C3=AD?= <[email protected]> Date: Mon, 8 Feb 2010 08:52:58 +0100 Subject: [PATCH 05/21] doc fixes for clutter.BehaviourPath --- docs/reference/clutter-clutterbehaviourpath.xml | 34 +++++++++------------- 1 files changed, 14 insertions(+), 20 deletions(-) diff --git a/docs/reference/clutter-clutterbehaviourpath.xml b/docs/reference/clutter-clutterbehaviourpath.xml index 7002b0e..edfcffd 100644 --- a/docs/reference/clutter-clutterbehaviourpath.xml +++ b/docs/reference/clutter-clutterbehaviourpath.xml @@ -22,7 +22,6 @@ <methodname>__init__</methodname> <methodparam><parameter>alpha</parameter></methodparam> <methodparam><parameter>knots</parameter></methodparam> - <methodparam><parameter>n_knots</parameter></methodparam> </constructorsynopsis> <methodsynopsis language="python"> <methodname><link linkend="method-clutterbehaviourpath--get-knots">get_knots</link></methodname> @@ -33,7 +32,7 @@ </methodsynopsis> <methodsynopsis language="python"> <methodname><link linkend="method-clutterbehaviourpath--append-knots">append_knots</link></methodname> - <methodparam><parameter>first_knot</parameter></methodparam> + <methodparam><parameter>knots</parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> <methodname><link linkend="method-clutterbehaviourpath--insert-knot">insert_knot</link></methodname> @@ -64,26 +63,21 @@ <programlisting><constructorsynopsis language="python"> <methodname>__init__</methodname> - <methodparam><parameter>alpha</parameter></methodparam> - <methodparam><parameter>knots</parameter></methodparam> - <methodparam><parameter>n_knots</parameter></methodparam> + <methodparam><parameter role="keyword">alpha</parameter></methodparam> + <methodparam><parameter role="keyword">knots</parameter></methodparam> </constructorsynopsis></programlisting> <variablelist> <varlistentry> <term><parameter>alpha</parameter> :</term> - <listitem><simpara>a ClutterAlpha*</simpara></listitem> + <listitem><simpara>a <link linkend="class-clutteralpha"><classname>clutter.Alpha</classname></link></simpara></listitem> </varlistentry> <varlistentry> <term><parameter>knots</parameter> :</term> - <listitem><simpara>a const-ClutterKnot*</simpara></listitem> - </varlistentry> - <varlistentry> - <term><parameter>n_knots</parameter> :</term> - <listitem><simpara>a guint</simpara></listitem> + <listitem><simpara>a tuple of tuples with the X and Y coordinates</simpara></listitem> </varlistentry> <varlistentry> <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a ClutterBehaviour*</simpara></listitem> + <listitem><simpara>a <link linkend="class-clutterbehaviourpath"><classname>clutter.BehaviourPath</classname></link></simpara></listitem> </varlistentry> </variablelist> @@ -102,7 +96,7 @@ <variablelist> <varlistentry> <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>a GSList*</simpara></listitem> + <listitem><simpara>a list</simpara></listitem> </varlistentry> </variablelist> </refsect2> @@ -118,7 +112,7 @@ <variablelist> <varlistentry> <term><parameter>knot</parameter> :</term> - <listitem><simpara>a const-ClutterKnot*</simpara></listitem> + <listitem><simpara>a <link linkend="class-clutterknot"><classname>clutter.Knot</classname></link></simpara></listitem> </varlistentry> </variablelist> </refsect2> @@ -129,12 +123,12 @@ <programlisting><methodsynopsis language="python"> <methodname>append_knots</methodname> - <methodparam><parameter>first_knot</parameter></methodparam> + <methodparam><parameter>knots</parameter></methodparam> </methodsynopsis></programlisting> <variablelist> <varlistentry> - <term><parameter>first_knot</parameter> :</term> - <listitem><simpara>a const-ClutterKnot*</simpara></listitem> + <term><parameter>knots</parameter> :</term> + <listitem><simpara>a tuple of tuples with the X and Y coordinates</simpara></listitem> </varlistentry> </variablelist> </refsect2> @@ -151,11 +145,11 @@ <variablelist> <varlistentry> <term><parameter>offset</parameter> :</term> - <listitem><simpara>a guint</simpara></listitem> + <listitem><simpara>an int</simpara></listitem> </varlistentry> <varlistentry> <term><parameter>knot</parameter> :</term> - <listitem><simpara>a const-ClutterKnot*</simpara></listitem> + <listitem><simpara>a <link linkend="class-clutterknot"><classname>clutter.Knot</classname></link></simpara></listitem> </varlistentry> </variablelist> </refsect2> @@ -171,7 +165,7 @@ <variablelist> <varlistentry> <term><parameter>offset</parameter> :</term> - <listitem><simpara>a guint</simpara></listitem> + <listitem><simpara>an int</simpara></listitem> </varlistentry> </variablelist> </refsect2> -- 1.6.3.3
