Major documentation updates. The original Freestyle API reference

(http://freestyle.sourceforge.net/doc/html/index.html) has been
incorporated into the Blender/Freestyle Python API implementation
in the form of Sphinx-based embedded docstrings.  Some C++-specific
descriptions of classes and functions were revised so that they are
suitable for Python programmers.  Missing docstrings were filled,
and sparse descriptions were extended.  By means of the new
documentation system for Blender, an up-to-date Freestyle Python
API reference will be part of the Blender 2.5 documentation.

1 files changed, 46 insertions, 16 deletions

diff --git a/source/blender/freestyle/intern/python/StrokeShader/BPy_IncreasingColorShader.cpp b/source/blender/freestyle/intern/python/StrokeShader/BPy_IncreasingColorShader.cpp
index 0efc0d8902b..892585bf842 100644
--- a/source/blender/freestyle/intern/python/StrokeShader/BPy_IncreasingColorShader.cpp
+++ b/source/blender/freestyle/intern/python/StrokeShader/BPy_IncreasingColorShader.cpp
@@ -8,8 +8,51 @@ extern "C" {
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 
-/*---------------  Python API function prototypes for IncreasingColorShader instance  -----------*/
-static int IncreasingColorShader___init__( BPy_IncreasingColorShader* self, PyObject *args);
+//------------------------INSTANCE METHODS ----------------------------------
+
+static char IncreasingColorShader___doc__[] =
+"[Color shader]\n"
+"\n"
+".. method:: __init__(iRm, iGm, iBm, iAlpham, iRM, iGM, iBM, iAlphaM)\n"
+"\n"
+"   Builds an IncreasingColorShader object.\n"
+"\n"
+"   :arg iRm: The first color red component.\n"
+"   :type iRm: float\n"
+"   :arg iGm: The first color green component.\n"
+"   :type iGm: float\n"
+"   :arg iBm: The first color blue component.\n"
+"   :type iBm: float\n"
+"   :arg iAlpham: The first color alpha value.\n"
+"   :type iAlpham: float\n"
+"   :arg iRM: The second color red component.\n"
+"   :type iRM: float\n"
+"   :arg iGM: The second color green component.\n"
+"   :type iGM: float\n"
+"   :arg iBM: The second color blue component.\n"
+"   :type iBM: float\n"
+"   :arg iAlphaM: The second color alpha value.\n"
+"   :type iAlphaM: float\n"
+"\n"
+".. method:: shade(s)\n"
+"\n"
+"   Assigns a varying color to the stroke.  The user specifies two\n"
+"   colors A and B.  The stroke color will change linearly from A to B\n"
+"   between the first and the last vertex.\n"
+"\n"
+"   :arg s: A Stroke object.\n"
+"   :type s: :class:`Stroke`\n";
+
+static int IncreasingColorShader___init__( BPy_IncreasingColorShader* self, PyObject *args)
+{
+	float f1, f2, f3, f4, f5, f6, f7, f8;
+
+	if(!( PyArg_ParseTuple(args, "ffffffff", &f1, &f2, &f3, &f4, &f5, &f6, &f7, &f8) ))
+		return -1;
+
+	self->py_ss.ss = new StrokeShaders::IncreasingColorShader(f1, f2, f3, f4, f5, f6, f7, f8);
+	return 0;
+}
 
 /*-----------------------BPy_IncreasingColorShader type definition ------------------------------*/
 
@@ -34,7 +77,7 @@ PyTypeObject IncreasingColorShader_Type = {
 	0,                              /* tp_setattro */
 	0,                              /* tp_as_buffer */
 	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
-	"IncreasingColorShader objects", /* tp_doc */
+	IncreasingColorShader___doc__,  /* tp_doc */
 	0,                              /* tp_traverse */
 	0,                              /* tp_clear */
 	0,                              /* tp_richcompare */
@@ -54,19 +97,6 @@ PyTypeObject IncreasingColorShader_Type = {
 	0,                              /* tp_new */
 };
 
-//------------------------INSTANCE METHODS ----------------------------------
-
-int IncreasingColorShader___init__( BPy_IncreasingColorShader* self, PyObject *args)
-{
-	float f1, f2, f3, f4, f5, f6, f7, f8;
-
-	if(!( PyArg_ParseTuple(args, "ffffffff", &f1, &f2, &f3, &f4, &f5, &f6, &f7, &f8) ))
-		return -1;
-
-	self->py_ss.ss = new StrokeShaders::IncreasingColorShader(f1, f2, f3, f4, f5, f6, f7, f8);
-	return 0;
-}
-
 ///////////////////////////////////////////////////////////////////////////////////////////
 
 #ifdef __cplusplus