[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [31009] branches/soc-2010-nexyon/intern/ audaspace/Python/AUD_PyAPI.cpp: Audaspace Py API: Updated some outdated docs.

Joerg Mueller nexyon at gmail.com
Tue Aug 3 14:49:43 CEST 2010


Revision: 31009
          http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=31009
Author:   nexyon
Date:     2010-08-03 14:49:42 +0200 (Tue, 03 Aug 2010)

Log Message:
-----------
Audaspace Py API: Updated some outdated docs.

Modified Paths:
--------------
    branches/soc-2010-nexyon/intern/audaspace/Python/AUD_PyAPI.cpp

Modified: branches/soc-2010-nexyon/intern/audaspace/Python/AUD_PyAPI.cpp
===================================================================
--- branches/soc-2010-nexyon/intern/audaspace/Python/AUD_PyAPI.cpp	2010-08-03 12:39:13 UTC (rev 31008)
+++ branches/soc-2010-nexyon/intern/audaspace/Python/AUD_PyAPI.cpp	2010-08-03 12:49:42 UTC (rev 31009)
@@ -417,7 +417,9 @@
 			 ":rtype: aud.Factory\n\n"
 			 ".. note:: This is done by changing the sample rate of the "
 			 "underlying sound, which has to be an integer, so the factor "
-			 "value rounded and the factor may not be 100 % accurate.");
+			 "value rounded and the factor may not be 100 % accurate.\n\n"
+			 ".. note:: This is a filter function, you might consider using "
+			 "aud.Handle.pitch instead.");
 
 static PyObject *
 Factory_pitch(Factory* self, PyObject* args)
@@ -459,7 +461,7 @@
 			 ":rtype: aud.Factory\n\n"
 			 ".. note:: Should be in the range [0, 1] to avoid clipping.\n\n"
 			 ".. note:: This is a filter function, you might consider using "
-			 "aud.Handle.pitch instead.");
+			 "aud.Handle.volume instead.");
 
 static PyObject *
 Factory_volume(Factory* self, PyObject* args)
@@ -500,9 +502,7 @@
 			 ":arg length: Time in seconds how long the fading should last.\n"
 			 ":type length: float\n"
 			 ":return: The created aud.Factory object.\n"
-			 ":rtype: aud.Factory\n\n"
-			 ".. note:: This is a filter function, you might consider using "
-			 "aud.Handle.volume instead.");
+			 ":rtype: aud.Factory");
 
 static PyObject *
 Factory_fadein(Factory* self, PyObject* args)
@@ -663,8 +663,7 @@
 			 "pingpong()\n\n"
 			 "Plays a sound forward and then backward.\n\n"
 			 ":return: The created aud.Factory object.\n"
-			 ":rtype: aud.Factory\n\n"
-			 ".. note:: The sound has to be buffered to be played reverse.");
+			 ":rtype: aud.Factory");
 
 static PyObject *
 Factory_pingpong(Factory* self)
@@ -697,7 +696,8 @@
 			 "Plays a sound reversed.\n\n"
 			 ":return: The created aud.Factory object.\n"
 			 ":rtype: aud.Factory\n\n"
-			 ".. note:: The sound has to be buffered to be played reverse.");
+			 ".. note:: The sound has have a finite length and be seekable. "
+			 "It's recommended to buffer sounds that should be played reversed.");
 
 static PyObject *
 Factory_reverse(Factory* self)





More information about the Bf-blender-cvs mailing list