[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [31099] branches/soc-2010-nexyon: Py API Documentation:

Joerg Mueller nexyon at gmail.com
Fri Aug 6 10:48:40 CEST 2010


Revision: 31099
          http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=31099
Author:   nexyon
Date:     2010-08-06 10:48:40 +0200 (Fri, 06 Aug 2010)

Log Message:
-----------
Py API Documentation:
* Fix some minor errors my script found in mathutils and blf.
* Fixing optional parameters with default values in aud.

Modified Paths:
--------------
    branches/soc-2010-nexyon/intern/audaspace/Python/AUD_PyAPI.cpp
    branches/soc-2010-nexyon/source/blender/python/generic/blf_api.c
    branches/soc-2010-nexyon/source/blender/python/generic/mathutils_quat.c
    branches/soc-2010-nexyon/source/blender/python/generic/mathutils_vector.c

Modified: branches/soc-2010-nexyon/intern/audaspace/Python/AUD_PyAPI.cpp
===================================================================
--- branches/soc-2010-nexyon/intern/audaspace/Python/AUD_PyAPI.cpp	2010-08-06 08:27:07 UTC (rev 31098)
+++ branches/soc-2010-nexyon/intern/audaspace/Python/AUD_PyAPI.cpp	2010-08-06 08:48:40 UTC (rev 31099)
@@ -126,7 +126,7 @@
 }
 
 PyDoc_STRVAR(M_aud_Factory_sine_doc,
-			 "sine(frequency[, rate])\n\n"
+			 "sine(frequency, rate=44100)\n\n"
 			 "Creates a sine sound wave.\n\n"
 			 ":arg frequency: The frequency of the sine wave in Hz.\n"
 			 ":type frequency: float\n"
@@ -201,7 +201,7 @@
 }
 
 PyDoc_STRVAR(M_aud_Factory_lowpass_doc,
-			 "lowpass(frequency[, Q])\n\n"
+			 "lowpass(frequency, Q=0.5)\n\n"
 			 "Creates a second order lowpass filter.\n\n"
 			 ":arg frequency: The cut off trequency of the lowpass.\n"
 			 ":type frequency: float\n"
@@ -326,7 +326,7 @@
 }
 
 PyDoc_STRVAR(M_aud_Factory_highpass_doc,
-			 "highpass(frequency[, Q])\n\n"
+			 "highpass(frequency, Q=0.5)\n\n"
 			 "Creates a second order highpass filter.\n\n"
 			 ":arg frequency: The cut off trequency of the highpass.\n"
 			 ":type frequency: float\n"
@@ -756,7 +756,7 @@
 }
 
 PyDoc_STRVAR(M_aud_Factory_square_doc,
-			 "squre([threshold = 0])\n\n"
+			 "square(threshold = 0)\n\n"
 			 "Makes a square wave out of an audio wave.\n\n"
 			 ":arg threshold: Threshold value over which an amplitude counts non-zero.\n"
 			 ":type threshold: float\n"
@@ -795,7 +795,7 @@
 }
 
 PyDoc_STRVAR(M_aud_Factory_filter_doc,
-			 "filter(b[, a = (1)])\n\n"
+			 "filter(b, a = (1))\n\n"
 			 "Filters a sound with the supplied IIR filter coefficients.\n\n"
 			 ":arg b: The nominator filter coefficients.\n"
 			 ":type b: sequence of float\n"
@@ -2220,7 +2220,7 @@
 }
 
 PyDoc_STRVAR(M_aud_Device_play_doc,
-			 "play(sound[, keep])\n\n"
+			 "play(sound, keep=False)\n\n"
 			 "Plays a sound.\n\n"
 			 ":arg sound: The sound to play.\n"
 			 ":type sound: :class:`Factory`\n"

Modified: branches/soc-2010-nexyon/source/blender/python/generic/blf_api.c
===================================================================
--- branches/soc-2010-nexyon/source/blender/python/generic/blf_api.c	2010-08-06 08:27:07 UTC (rev 31098)
+++ branches/soc-2010-nexyon/source/blender/python/generic/blf_api.c	2010-08-06 08:48:40 UTC (rev 31099)
@@ -39,7 +39,7 @@
 "   :arg y: Y axis position to draw the text.\n"
 "   :type y: float\n"
 "   :arg z: Z axis position to draw the text.\n"
-"   :type x: float\n";
+"   :type z: float\n";
 
 static PyObject *py_blf_position(PyObject *self, PyObject *args)
 {
@@ -261,7 +261,7 @@
 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
 "   :type fontid: int\n"
 "   :arg angle: The angle for text drawing to use.\n"
-"   :type aspect: float\n";
+"   :type angle: float\n";
 
 static PyObject *py_blf_rotation(PyObject *self, PyObject *args)
 {

Modified: branches/soc-2010-nexyon/source/blender/python/generic/mathutils_quat.c
===================================================================
--- branches/soc-2010-nexyon/source/blender/python/generic/mathutils_quat.c	2010-08-06 08:27:07 UTC (rev 31098)
+++ branches/soc-2010-nexyon/source/blender/python/generic/mathutils_quat.c	2010-08-06 08:48:40 UTC (rev 31099)
@@ -109,7 +109,7 @@
 }
 //----------------------------Quaternion.toMatrix()------------------
 static char Quaternion_ToMatrix_doc[] =
-".. method:: to_matrix(other)\n"
+".. method:: to_matrix()\n"
 "\n"
 "   Return a matrix representation of the quaternion.\n"
 "\n"

Modified: branches/soc-2010-nexyon/source/blender/python/generic/mathutils_vector.c
===================================================================
--- branches/soc-2010-nexyon/source/blender/python/generic/mathutils_vector.c	2010-08-06 08:27:07 UTC (rev 31098)
+++ branches/soc-2010-nexyon/source/blender/python/generic/mathutils_vector.c	2010-08-06 08:48:40 UTC (rev 31099)
@@ -508,7 +508,8 @@
 "   :arg other: another vector to compare the angle with\n"
 "   :type other: :class:`Vector`\n"
 "   :arg fallback: return this value when the angle cant be calculated (zero length vector)\n"
-"   :return angle: angle in radians or fallback when given\n"
+"   :type fallback: any\n"
+"   :return: angle in radians or fallback when given\n"
 "   :rtype: float\n"
 "\n"
 "   .. note:: Zero length vectors raise an :exc:`AttributeError`.\n";
@@ -607,8 +608,9 @@
 "\n"
 "   Return the projection of this vector onto the *other*.\n"
 "\n"
+"   :arg other: second vector.\n"
 "   :type other: :class:`Vector`\n"
-"   :return projection: the parallel projection vector\n"
+"   :return: the parallel projection vector\n"
 "   :rtype: :class:`Vector`\n";
 
 static PyObject *Vector_Project(VectorObject *self, VectorObject *value)





More information about the Bf-blender-cvs mailing list