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

diff --git a/source/blender/freestyle/intern/python/StrokeShader/BPy_GuidingLinesShader.cpp b/source/blender/freestyle/intern/python/StrokeShader/BPy_GuidingLinesShader.cpp
index 52da44be26d..4be1358147a 100644
--- a/source/blender/freestyle/intern/python/StrokeShader/BPy_GuidingLinesShader.cpp
+++ b/source/blender/freestyle/intern/python/StrokeShader/BPy_GuidingLinesShader.cpp
@@ -8,8 +8,43 @@ extern "C" {
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 
-/*---------------  Python API function prototypes for GuidingLinesShader instance  -----------*/
-static int GuidingLinesShader___init__( BPy_GuidingLinesShader* self, PyObject *args);
+//------------------------INSTANCE METHODS ----------------------------------
+
+static char GuidingLinesShader___doc__[] =
+"[Geometry shader]\n"
+"\n"
+".. method:: __init__(iOffset)\n"
+"\n"
+"   Builds a GuidingLinesShader object.\n"
+"\n"
+"   :arg iOffset: The line that replaces the stroke is initially in the\n"
+"      middle of the initial stroke bounding box.  iOffset is the value\n"
+"      of the displacement which is applied to this line along its\n"
+"      normal.\n"
+"   :type iOffset: float\n"
+"\n"
+".. method:: shade(s)\n"
+"\n"
+"   Shader to modify the Stroke geometry so that it corresponds to its\n"
+"   main direction line.  This shader must be used together with the\n"
+"   splitting operator using the curvature criterion. Indeed, the\n"
+"   precision of the approximation will depend on the size of the\n"
+"   stroke's pieces.  The bigger the pieces are, the rougher the\n"
+"   approximation is.\n"
+"\n"
+"   :arg s: A Stroke object.\n"
+"   :type s: :class:`Stroke`\n";
+
+static int GuidingLinesShader___init__( BPy_GuidingLinesShader* self, PyObject *args)
+{
+	float f;
+
+	if(!( PyArg_ParseTuple(args, "f", &f) ))
+		return -1;
+
+	self->py_ss.ss = new StrokeShaders::GuidingLinesShader(f);
+	return 0;
+}
 
 /*-----------------------BPy_GuidingLinesShader type definition ------------------------------*/
 
@@ -34,7 +69,7 @@ PyTypeObject GuidingLinesShader_Type = {
 	0,                              /* tp_setattro */
 	0,                              /* tp_as_buffer */
 	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
-	"GuidingLinesShader objects",   /* tp_doc */
+	GuidingLinesShader___doc__,     /* tp_doc */
 	0,                              /* tp_traverse */
 	0,                              /* tp_clear */
 	0,                              /* tp_richcompare */
@@ -54,19 +89,6 @@ PyTypeObject GuidingLinesShader_Type = {
 	0,                              /* tp_new */
 };
 
-//------------------------INSTANCE METHODS ----------------------------------
-
-int GuidingLinesShader___init__( BPy_GuidingLinesShader* self, PyObject *args)
-{
-	float f;
-
-	if(!( PyArg_ParseTuple(args, "f", &f) ))
-		return -1;
-
-	self->py_ss.ss = new StrokeShaders::GuidingLinesShader(f);
-	return 0;
-}
-
 ///////////////////////////////////////////////////////////////////////////////////////////
 
 #ifdef __cplusplus