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, 57 insertions, 42 deletions

diff --git a/source/blender/freestyle/intern/python/BPy_UnaryFunction0D.cpp b/source/blender/freestyle/intern/python/BPy_UnaryFunction0D.cpp
index 8558daf0693..b254786897c 100644
--- a/source/blender/freestyle/intern/python/BPy_UnaryFunction0D.cpp
+++ b/source/blender/freestyle/intern/python/BPy_UnaryFunction0D.cpp
@@ -18,10 +18,63 @@ extern "C" {
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 
-/*---------------  Python API function prototypes for UnaryFunction0D instance  -----------*/
+//-------------------MODULE INITIALIZATION--------------------------------
+int UnaryFunction0D_Init( PyObject *module )
+{
+	if( module == NULL )
+		return -1;
 
-static void UnaryFunction0D___dealloc__(BPy_UnaryFunction0D *self);
-static PyObject * UnaryFunction0D___repr__(BPy_UnaryFunction0D *self);
+	if( PyType_Ready( &UnaryFunction0D_Type ) < 0 )
+		return -1;
+	Py_INCREF( &UnaryFunction0D_Type );
+	PyModule_AddObject(module, "UnaryFunction0D", (PyObject *)&UnaryFunction0D_Type);
+
+	UnaryFunction0DDouble_Init( module );
+	UnaryFunction0DEdgeNature_Init( module );
+	UnaryFunction0DFloat_Init( module );
+	UnaryFunction0DId_Init( module );
+	UnaryFunction0DMaterial_Init( module );
+	UnaryFunction0DUnsigned_Init( module );
+	UnaryFunction0DVec2f_Init( module );
+	UnaryFunction0DVec3f_Init( module );
+	UnaryFunction0DVectorViewShape_Init( module );
+	UnaryFunction0DViewShape_Init( module );
+	
+	return 0;
+}
+
+//------------------------INSTANCE METHODS ----------------------------------
+
+static char UnaryFunction0D___doc__[] =
+"Base class for Unary Functions (functors) working on\n"
+":class:`Interface0DIterator`.  A unary function will be used by\n"
+"invoking __call__() on an Interface0DIterator.  In Python, several\n"
+"different subclasses of UnaryFunction0D are used depending on the\n"
+"types of functors' return values.  For example, you would inherit from\n"
+"a :class:`UnaryFunction0DDouble` if you wish to define a function that\n"
+"returns a double value.  Available UnaryFunction0D subclasses are:\n"
+"\n"
+"* :class:`UnaryFunction0DDouble`\n"
+"* :class:`UnaryFunction0DEdgeNature`\n"
+"* :class:`UnaryFunction0DFloat`\n"
+"* :class:`UnaryFunction0DId`\n"
+"* :class:`UnaryFunction0DMaterial`\n"
+"* :class:`UnaryFunction0DUnsigned`\n"
+"* :class:`UnaryFunction0DVec2f`\n"
+"* :class:`UnaryFunction0DVec3f`\n"
+"* :class:`UnaryFunction0DVectorViewShape`\n"
+"* :class:`UnaryFunction0DViewShape`\n";
+
+static void UnaryFunction0D___dealloc__(BPy_UnaryFunction0D* self)
+{
+    Py_TYPE(self)->tp_free((PyObject*)self);
+}
+
+
+static PyObject * UnaryFunction0D___repr__(BPy_UnaryFunction0D* self)
+{
+    return PyUnicode_FromFormat("UnaryFunction0D");
+}
 
 /*-----------------------BPy_UnaryFunction0D type definition ------------------------------*/
 
@@ -46,7 +99,7 @@ PyTypeObject UnaryFunction0D_Type = {
 	0,                              /* tp_setattro */
 	0,                              /* tp_as_buffer */
 	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
-	"UnaryFunction0D objects",      /* tp_doc */
+	UnaryFunction0D___doc__,        /* tp_doc */
 	0,                              /* tp_traverse */
 	0,                              /* tp_clear */
 	0,                              /* tp_richcompare */
@@ -66,44 +119,6 @@ PyTypeObject UnaryFunction0D_Type = {
 	PyType_GenericNew,              /* tp_new */
 };
 
-//-------------------MODULE INITIALIZATION--------------------------------
-int UnaryFunction0D_Init( PyObject *module )
-{
-	if( module == NULL )
-		return -1;
-
-	if( PyType_Ready( &UnaryFunction0D_Type ) < 0 )
-		return -1;
-	Py_INCREF( &UnaryFunction0D_Type );
-	PyModule_AddObject(module, "UnaryFunction0D", (PyObject *)&UnaryFunction0D_Type);
-
-	UnaryFunction0DDouble_Init( module );
-	UnaryFunction0DEdgeNature_Init( module );
-	UnaryFunction0DFloat_Init( module );
-	UnaryFunction0DId_Init( module );
-	UnaryFunction0DMaterial_Init( module );
-	UnaryFunction0DUnsigned_Init( module );
-	UnaryFunction0DVec2f_Init( module );
-	UnaryFunction0DVec3f_Init( module );
-	UnaryFunction0DVectorViewShape_Init( module );
-	UnaryFunction0DViewShape_Init( module );
-	
-	return 0;
-}
-
-//------------------------INSTANCE METHODS ----------------------------------
-
-void UnaryFunction0D___dealloc__(BPy_UnaryFunction0D* self)
-{
-    Py_TYPE(self)->tp_free((PyObject*)self);
-}
-
-
-PyObject * UnaryFunction0D___repr__(BPy_UnaryFunction0D* self)
-{
-    return PyUnicode_FromFormat("UnaryFunction0D");
-}
-
 ///////////////////////////////////////////////////////////////////////////////////////////
 
 #ifdef __cplusplus