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, 36 insertions, 16 deletions

diff --git a/source/blender/freestyle/intern/python/StrokeShader/BPy_ConstantColorShader.cpp b/source/blender/freestyle/intern/python/StrokeShader/BPy_ConstantColorShader.cpp
index c6310486b6c..2b21acabc42 100644
--- a/source/blender/freestyle/intern/python/StrokeShader/BPy_ConstantColorShader.cpp
+++ b/source/blender/freestyle/intern/python/StrokeShader/BPy_ConstantColorShader.cpp
@@ -8,8 +8,41 @@ extern "C" {
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 
-/*---------------  Python API function prototypes for ConstantColorShader instance  -----------*/
-static int ConstantColorShader___init__( BPy_ConstantColorShader* self, PyObject *args);
+//------------------------INSTANCE METHODS ----------------------------------
+
+static char ConstantColorShader___doc__[] =
+"[Color shader]\n"
+"\n"
+".. method:: __init__(iR, iG, iB, iAlpha=1.0)\n"
+"\n"
+"   Builds a ConstantColorShader object.\n"
+"\n"
+"   :arg iR: The red component.\n"
+"   :type iR: float\n"
+"   :arg iG: The green component.\n"
+"   :type iG: float\n"
+"   :arg iB: The blue component.\n"
+"   :type iB: float\n"
+"   :arg iAlpha: The alpha value.\n"
+"   :type iAlpha: float\n"
+"\n"
+".. method:: shade(s)\n"
+"\n"
+"   Assigns a constant color to every vertex of the Stroke.\n"
+"\n"
+"   :arg s: A Stroke object.\n"
+"   :type s: :class:`Stroke`\n";
+
+static int ConstantColorShader___init__( BPy_ConstantColorShader* self, PyObject *args)
+{
+	float f1, f2, f3, f4 = 1.0;
+
+	if(!( PyArg_ParseTuple(args, "fff|f", &f1, &f2, &f3, &f4) ))
+		return -1;
+
+	self->py_ss.ss = new StrokeShaders::ConstantColorShader(f1, f2, f3, f4);
+	return 0;
+}
 
 /*-----------------------BPy_ConstantColorShader type definition ------------------------------*/
 
@@ -34,7 +67,7 @@ PyTypeObject ConstantColorShader_Type = {
 	0,                              /* tp_setattro */
 	0,                              /* tp_as_buffer */
 	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
-	"ConstantColorShader objects",  /* tp_doc */
+	ConstantColorShader___doc__,    /* tp_doc */
 	0,                              /* tp_traverse */
 	0,                              /* tp_clear */
 	0,                              /* tp_richcompare */
@@ -54,19 +87,6 @@ PyTypeObject ConstantColorShader_Type = {
 	0,                              /* tp_new */
 };
 
-//------------------------INSTANCE METHODS ----------------------------------
-
-int ConstantColorShader___init__( BPy_ConstantColorShader* self, PyObject *args)
-{
-	float f1, f2, f3, f4 = 1.0;
-
-	if(!( PyArg_ParseTuple(args, "fff|f", &f1, &f2, &f3, &f4) ))
-		return -1;
-
-	self->py_ss.ss = new StrokeShaders::ConstantColorShader(f1, f2, f3, f4);
-	return 0;
-}
-
 ///////////////////////////////////////////////////////////////////////////////////////////
 
 #ifdef __cplusplus