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, 42 insertions, 19 deletions

diff --git a/source/blender/freestyle/intern/python/StrokeShader/BPy_ThicknessVariationPatternShader.cpp b/source/blender/freestyle/intern/python/StrokeShader/BPy_ThicknessVariationPatternShader.cpp
index 2759a9f9d13..f9472ae3444 100644
--- a/source/blender/freestyle/intern/python/StrokeShader/BPy_ThicknessVariationPatternShader.cpp
+++ b/source/blender/freestyle/intern/python/StrokeShader/BPy_ThicknessVariationPatternShader.cpp
@@ -9,8 +9,47 @@ extern "C" {
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 
-/*---------------  Python API function prototypes for ThicknessVariationPatternShader instance  -----------*/
-static int ThicknessVariationPatternShader___init__( BPy_ThicknessVariationPatternShader* self, PyObject *args);
+//------------------------INSTANCE METHODS ----------------------------------
+
+static char ThicknessVariationPatternShader___doc__[] =
+"[Thickness shader]\n"
+"\n"
+".. method:: __init__(pattern_name, iMinThickness, iMaxThickness, stretch)\n"
+"\n"
+"   Builds a ThicknessVariationPatternShader object.\n"
+"\n"
+"   :arg pattern_name: The texture file name.\n"
+"   :type pattern_name: string\n"
+"   :arg iMinThickness: The minimum thickness we don't want to exceed.\n"
+"   :type iMinThickness: float\n"
+"   :arg iMaxThickness: The maximum thickness we don't want to exceed.\n"
+"   :type iMaxThickness: float\n"
+"   :arg stretch: Tells whether the pattern texture must be stretched\n"
+"      or repeted to fit the stroke.\n"
+"   :type stretch: bool\n"
+"\n"
+".. method:: shade(s)\n"
+"\n"
+"   Applies a pattern (texture) to vary thickness. The new thicknesses\n"
+"   are the result of the multiplication of the pattern and the\n"
+"   original thickness.\n"
+"\n"
+"   :arg s: A Stroke object.\n"
+"   :type s: :class:`Stroke`\n";
+
+static int ThicknessVariationPatternShader___init__( BPy_ThicknessVariationPatternShader* self, PyObject *args)
+{
+	const char *s1;
+	float f2 = 1.0, f3 = 5.0;
+	PyObject *obj4 = 0;
+
+	if(!( PyArg_ParseTuple(args, "s|ffO", &s1, &f2, &f3, &obj4) ))
+		return -1;
+
+	bool b = (obj4) ? bool_from_PyBool(obj4) : true;
+	self->py_ss.ss = new StrokeShaders::ThicknessVariationPatternShader(s1, f2, f3, b);
+	return 0;
+}
 
 /*-----------------------BPy_ThicknessVariationPatternShader type definition ------------------------------*/
 
@@ -35,7 +74,7 @@ PyTypeObject ThicknessVariationPatternShader_Type = {
 	0,                              /* tp_setattro */
 	0,                              /* tp_as_buffer */
 	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
-	"ThicknessVariationPatternShader objects", /* tp_doc */
+	ThicknessVariationPatternShader___doc__, /* tp_doc */
 	0,                              /* tp_traverse */
 	0,                              /* tp_clear */
 	0,                              /* tp_richcompare */
@@ -55,22 +94,6 @@ PyTypeObject ThicknessVariationPatternShader_Type = {
 	0,                              /* tp_new */
 };
 
-//------------------------INSTANCE METHODS ----------------------------------
-
-int ThicknessVariationPatternShader___init__( BPy_ThicknessVariationPatternShader* self, PyObject *args)
-{
-	const char *s1;
-	float f2 = 1.0, f3 = 5.0;
-	PyObject *obj4 = 0;
-
-	if(!( PyArg_ParseTuple(args, "s|ffO", &s1, &f2, &f3, &obj4) ))
-		return -1;
-
-	bool b = (obj4) ? bool_from_PyBool(obj4) : true;
-	self->py_ss.ss = new StrokeShaders::ThicknessVariationPatternShader(s1, f2, f3, b);
-	return 0;
-}
-
 ///////////////////////////////////////////////////////////////////////////////////////////
 
 #ifdef __cplusplus