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, 48 insertions, 17 deletions

diff --git a/source/blender/freestyle/intern/python/StrokeShader/BPy_SmoothingShader.cpp b/source/blender/freestyle/intern/python/StrokeShader/BPy_SmoothingShader.cpp
index 6b931237afb..20be1575bb3 100644
--- a/source/blender/freestyle/intern/python/StrokeShader/BPy_SmoothingShader.cpp
+++ b/source/blender/freestyle/intern/python/StrokeShader/BPy_SmoothingShader.cpp
@@ -8,8 +8,53 @@ extern "C" {
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 
-/*---------------  Python API function prototypes for SmoothingShader instance  -----------*/
-static int SmoothingShader___init__( BPy_SmoothingShader* self, PyObject *args);
+//------------------------INSTANCE METHODS ----------------------------------
+
+static char SmoothingShader___doc__[] =
+"[Geometry shader]\n"
+"\n"
+".. method:: __init__(iNbIteration, iFactorPoint, ifactorCurvature, iFactorCurvatureDifference, iAnisoPoint, iAnisNormal, iAnisoCurvature, icarricatureFactor)\n"
+"\n"
+"   Builds a SmoothingShader object.\n"
+"\n"
+"   :arg iNbIteration: The number of iterations (400).\n"
+"   :type iNbIteration: int\n"
+"   :arg iFactorPoint: 0.0\n"
+"   :type iFactorPoint: float\n"
+"   :arg ifactorCurvature: 0.0\n"
+"   :type ifactorCurvature: float\n"
+"   :arg iFactorCurvatureDifference: 0.2\n"
+"   :type iFactorCurvatureDifference: float\n"
+"   :arg iAnisoPoint: \n"
+"   :type iAnisoPoint: float\n"
+"   :arg iAnisNormal: 0.0\n"
+"   :type iAnisNormal: float\n"
+"   :arg iAnisoCurvature: 0.0\n"
+"   :type iAnisoCurvature: float\n"
+"   :arg icarricatureFactor: 1.0\n"
+"   :type icarricatureFactor: float\n"
+"\n"
+".. method:: shade(s)\n"
+"\n"
+"   Smoothes the stroke by moving the vertices to make the stroke\n"
+"   smoother.  Uses curvature flow to converge towards a curve of\n"
+"   constant curvature.  The diffusion method we use is anisotropic to\n"
+"   prevent the diffusion accross corners.\n"
+"\n"
+"   :arg s: A Stroke object.\n"
+"   :type s: :class:`Stroke`\n";
+
+static int SmoothingShader___init__( BPy_SmoothingShader* self, PyObject *args)
+{
+	int i1;
+	double d2, d3, d4, d5, d6, d7, d8;
+
+	if(!( PyArg_ParseTuple(args, "iddddddd", &i1, &d2, &d3, &d4, &d5, &d6, &d7, &d8) ))
+		return -1;
+
+	self->py_ss.ss = new SmoothingShader(i1, d2, d3, d4, d5, d6, d7, d8);
+	return 0;
+}
 
 /*-----------------------BPy_SmoothingShader type definition ------------------------------*/
 
@@ -34,7 +79,7 @@ PyTypeObject SmoothingShader_Type = {
 	0,                              /* tp_setattro */
 	0,                              /* tp_as_buffer */
 	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
-	"SmoothingShader objects",      /* tp_doc */
+	SmoothingShader___doc__,        /* tp_doc */
 	0,                              /* tp_traverse */
 	0,                              /* tp_clear */
 	0,                              /* tp_richcompare */
@@ -54,20 +99,6 @@ PyTypeObject SmoothingShader_Type = {
 	0,                              /* tp_new */
 };
 
-//------------------------INSTANCE METHODS ----------------------------------
-
-int SmoothingShader___init__( BPy_SmoothingShader* self, PyObject *args)
-{
-	int i1;
-	double d2, d3, d4, d5, d6, d7, d8;
-
-	if(!( PyArg_ParseTuple(args, "iddddddd", &i1, &d2, &d3, &d4, &d5, &d6, &d7, &d8) ))
-		return -1;
-
-	self->py_ss.ss = new SmoothingShader(i1, d2, d3, d4, d5, d6, d7, d8);
-	return 0;
-}
-
 ///////////////////////////////////////////////////////////////////////////////////////////
 
 #ifdef __cplusplus