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

diff --git a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_float/BPy_ReadMapPixelF0D.cpp b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_float/BPy_ReadMapPixelF0D.cpp
index b7e656ca842..6826bda4c09 100644
--- a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_float/BPy_ReadMapPixelF0D.cpp
+++ b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_float/BPy_ReadMapPixelF0D.cpp
@@ -8,8 +8,39 @@ extern "C" {
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 
-/*---------------  Python API function prototypes for ReadMapPixelF0D instance  -----------*/
-static int ReadMapPixelF0D___init__(BPy_ReadMapPixelF0D* self, PyObject *args);
+//------------------------INSTANCE METHODS ----------------------------------
+
+static char ReadMapPixelF0D___doc__[] =
+".. method:: __init__(iMapName, level)\n"
+"\n"
+"   Builds a ReadMapPixelF0D object.\n"
+"\n"
+"   :arg iMapName: The name of the map to be read.\n"
+"   :type iMapName: string\n"
+"   :arg level: The level of the pyramid from which the pixel must be\n"
+"      read.\n"
+"   :type level: int\n"
+"\n"
+".. method:: __call__(it)\n"
+"\n"
+"   Reads a pixel in a map.\n"
+"\n"
+"   :arg it: An Interface0DIterator object.\n"
+"   :type it: :class:`Interface0DIterator`\n"
+"   :return: A pixel in a map.\n"
+"   :rtype: float\n";
+
+static int ReadMapPixelF0D___init__( BPy_ReadMapPixelF0D* self, PyObject *args)
+{
+	const char *s;
+	int i;
+
+	if( !PyArg_ParseTuple(args, "si", &s, &i) )
+		return -1;
+	self->py_uf0D_float.uf0D_float = new Functions0D::ReadMapPixelF0D(s,i);
+	self->py_uf0D_float.uf0D_float->py_uf0D = (PyObject *)self;
+	return 0;
+}
 
 /*-----------------------BPy_ReadMapPixelF0D type definition ------------------------------*/
 
@@ -34,7 +65,7 @@ PyTypeObject ReadMapPixelF0D_Type = {
 	0,                              /* tp_setattro */
 	0,                              /* tp_as_buffer */
 	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
-	"ReadMapPixelF0D objects",      /* tp_doc */
+	ReadMapPixelF0D___doc__,        /* tp_doc */
 	0,                              /* tp_traverse */
 	0,                              /* tp_clear */
 	0,                              /* tp_richcompare */
@@ -54,20 +85,6 @@ PyTypeObject ReadMapPixelF0D_Type = {
 	0,                              /* tp_new */
 };
 
-//------------------------INSTANCE METHODS ----------------------------------
-
-int ReadMapPixelF0D___init__( BPy_ReadMapPixelF0D* self, PyObject *args)
-{
-	const char *s;
-	int i;
-
-	if( !PyArg_ParseTuple(args, "si", &s, &i) )
-		return -1;
-	self->py_uf0D_float.uf0D_float = new Functions0D::ReadMapPixelF0D(s,i);
-	self->py_uf0D_float.uf0D_float->py_uf0D = (PyObject *)self;
-	return 0;
-}
-
 ///////////////////////////////////////////////////////////////////////////////////////////
 
 #ifdef __cplusplus