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

diff --git a/source/blender/freestyle/intern/python/StrokeShader/BPy_ConstantThicknessShader.cpp b/source/blender/freestyle/intern/python/StrokeShader/BPy_ConstantThicknessShader.cpp
index 2e94976c681..2db3685122f 100644
--- a/source/blender/freestyle/intern/python/StrokeShader/BPy_ConstantThicknessShader.cpp
+++ b/source/blender/freestyle/intern/python/StrokeShader/BPy_ConstantThicknessShader.cpp
@@ -8,8 +8,35 @@ extern "C" {
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 
-/*---------------  Python API function prototypes for ConstantThicknessShader instance  -----------*/
-static int ConstantThicknessShader___init__( BPy_ConstantThicknessShader* self, PyObject *args);
+//------------------------INSTANCE METHODS ----------------------------------
+
+static char ConstantThicknessShader___doc__[] =
+"[Thickness shader]\n"
+"\n"
+".. method:: __init__(thickness)\n"
+"\n"
+"   Builds a ConstantThicknessShader object.\n"
+"\n"
+"   :arg thickness: The thickness that must be assigned to the stroke.\n"
+"   :type thickness: float\n"
+"\n"
+".. method:: shade(s)\n"
+"\n"
+"   Assigns an absolute constant thickness to every vertex of the Stroke.\n"
+"\n"
+"   :arg s: A Stroke object.\n"
+"   :type s: :class:`Stroke`\n";
+
+static int ConstantThicknessShader___init__( BPy_ConstantThicknessShader* self, PyObject *args)
+{
+	float f;
+
+	if(!( PyArg_ParseTuple(args, "f", &f)  ))
+		return -1;
+
+	self->py_ss.ss = new StrokeShaders::ConstantThicknessShader(f);
+	return 0;
+}
 
 /*-----------------------BPy_ConstantThicknessShader type definition ------------------------------*/
 
@@ -34,7 +61,7 @@ PyTypeObject ConstantThicknessShader_Type = {
 	0,                              /* tp_setattro */
 	0,                              /* tp_as_buffer */
 	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
-	"ConstantThicknessShader objects", /* tp_doc */
+	ConstantThicknessShader___doc__, /* tp_doc */
 	0,                              /* tp_traverse */
 	0,                              /* tp_clear */
 	0,                              /* tp_richcompare */
@@ -54,19 +81,6 @@ PyTypeObject ConstantThicknessShader_Type = {
 	0,                              /* tp_new */
 };
 
-//------------------------INSTANCE METHODS ----------------------------------
-
-int ConstantThicknessShader___init__( BPy_ConstantThicknessShader* self, PyObject *args)
-{
-	float f;
-
-	if(!( PyArg_ParseTuple(args, "f", &f)  ))
-		return -1;
-
-	self->py_ss.ss = new StrokeShaders::ConstantThicknessShader(f);
-	return 0;
-}
-
 ///////////////////////////////////////////////////////////////////////////////////////////
 
 #ifdef __cplusplus