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

diff --git a/source/blender/freestyle/intern/python/StrokeShader/BPy_PolygonalizationShader.cpp b/source/blender/freestyle/intern/python/StrokeShader/BPy_PolygonalizationShader.cpp
index e03334e6418..7c0c758a318 100644
--- a/source/blender/freestyle/intern/python/StrokeShader/BPy_PolygonalizationShader.cpp
+++ b/source/blender/freestyle/intern/python/StrokeShader/BPy_PolygonalizationShader.cpp
@@ -8,8 +8,42 @@ extern "C" {
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 
-/*---------------  Python API function prototypes for PolygonalizationShader instance  -----------*/
-static int PolygonalizationShader___init__( BPy_PolygonalizationShader* self, PyObject *args);
+//------------------------INSTANCE METHODS ----------------------------------
+
+static char PolygonalizationShader___doc__[] =
+"[Geometry shader]\n"
+"\n"
+".. method:: __init__(iError)\n"
+"\n"
+"   Builds a PolygonalizationShader object.\n"
+"\n"
+"   :arg iError: The error we want our polygonal approximation to have\n"
+"      with respect to the original geometry.  The smaller, the closer\n"
+"      the new stroke is to the orinal one.  This error corresponds to\n"
+"      the maximum distance between the new stroke and the old one.\n"
+"   :type iError: float\n"
+"\n"
+".. method:: shade(s)\n"
+"\n"
+"   Modifies the Stroke geometry so that it looks more \"polygonal\".\n"
+"   The basic idea is to start from the minimal stroke approximation\n"
+"   consisting in a line joining the first vertex to the last one and\n"
+"   to subdivide using the original stroke vertices until a certain\n"
+"   error is reached.\n"
+"\n"
+"   :arg s: A Stroke object.\n"
+"   :type s: :class:`Stroke`\n";
+
+static int PolygonalizationShader___init__( BPy_PolygonalizationShader* self, PyObject *args)
+{
+	float f;
+
+	if(!( PyArg_ParseTuple(args, "f", &f) ))
+		return -1;
+
+	self->py_ss.ss = new StrokeShaders::PolygonalizationShader(f);
+	return 0;
+}
 
 /*-----------------------BPy_PolygonalizationShader type definition ------------------------------*/
 
@@ -34,7 +68,7 @@ PyTypeObject PolygonalizationShader_Type = {
 	0,                              /* tp_setattro */
 	0,                              /* tp_as_buffer */
 	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
-	"PolygonalizationShader objects", /* tp_doc */
+	PolygonalizationShader___doc__, /* tp_doc */
 	0,                              /* tp_traverse */
 	0,                              /* tp_clear */
 	0,                              /* tp_richcompare */
@@ -54,19 +88,6 @@ PyTypeObject PolygonalizationShader_Type = {
 	0,                              /* tp_new */
 };
 
-//------------------------INSTANCE METHODS ----------------------------------
-
-int PolygonalizationShader___init__( BPy_PolygonalizationShader* self, PyObject *args)
-{
-	float f;
-
-	if(!( PyArg_ParseTuple(args, "f", &f) ))
-		return -1;
-
-	self->py_ss.ss = new StrokeShaders::PolygonalizationShader(f);
-	return 0;
-}
-
 ///////////////////////////////////////////////////////////////////////////////////////////
 
 #ifdef __cplusplus