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, 51 insertions, 39 deletions

diff --git a/source/blender/freestyle/intern/python/BPy_UnaryFunction1D.cpp b/source/blender/freestyle/intern/python/BPy_UnaryFunction1D.cpp
index c05ba35422f..a9ca73003f5 100644
--- a/source/blender/freestyle/intern/python/BPy_UnaryFunction1D.cpp
+++ b/source/blender/freestyle/intern/python/BPy_UnaryFunction1D.cpp
@@ -15,10 +15,57 @@ extern "C" {
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 
-/*---------------  Python API function prototypes for UnaryFunction1D instance  -----------*/
+//-------------------MODULE INITIALIZATION--------------------------------
+int UnaryFunction1D_Init( PyObject *module )
+{
+	if( module == NULL )
+		return -1;
+
+	if( PyType_Ready( &UnaryFunction1D_Type ) < 0 )
+		return -1;
+	Py_INCREF( &UnaryFunction1D_Type );
+	PyModule_AddObject(module, "UnaryFunction1D", (PyObject *)&UnaryFunction1D_Type);
+
+	UnaryFunction1DDouble_Init( module );
+	UnaryFunction1DEdgeNature_Init( module );
+	UnaryFunction1DFloat_Init( module );
+	UnaryFunction1DUnsigned_Init( module );
+	UnaryFunction1DVec2f_Init( module );
+	UnaryFunction1DVec3f_Init( module );
+	UnaryFunction1DVectorViewShape_Init( module );
+	UnaryFunction1DVoid_Init( module );
+	return 0;
+}
+
+//------------------------INSTANCE METHODS ----------------------------------
+
+static char UnaryFunction1D___doc__[] =
+"Base class for Unary Functions (functors) working on\n"
+":class:`Interface1D`.  A unary function will be used by invoking\n"
+"__call__() on an Interface1D.  In Python, several different subclasses\n"
+"of UnaryFunction1D are used depending on the types of functors' return\n"
+"values.  For example, you would inherit from a\n"
+":class:`UnaryFunction1DDouble` if you wish to define a function that\n"
+"returns a double value.  Available UnaryFunction1D subclasses are:\n"
+"\n"
+"* :class:`UnaryFunction1DDouble`\n"
+"* :class:`UnaryFunction1DEdgeNature`\n"
+"* :class:`UnaryFunction1DFloat`\n"
+"* :class:`UnaryFunction1DUnsigned`\n"
+"* :class:`UnaryFunction1DVec2f`\n"
+"* :class:`UnaryFunction1DVec3f`\n"
+"* :class:`UnaryFunction1DVectorViewShape`\n"
+"* :class:`UnaryFunction1DVoid`\n";
+
+static void UnaryFunction1D___dealloc__(BPy_UnaryFunction1D* self)
+{
+    Py_TYPE(self)->tp_free((PyObject*)self);
+}
 
-static void UnaryFunction1D___dealloc__(BPy_UnaryFunction1D *self);
-static PyObject * UnaryFunction1D___repr__(BPy_UnaryFunction1D *self);
+static PyObject * UnaryFunction1D___repr__(BPy_UnaryFunction1D* self)
+{
+    return PyUnicode_FromFormat("UnaryFunction1D");
+}
 
 /*-----------------------BPy_UnaryFunction1D type definition ------------------------------*/
 
@@ -43,7 +90,7 @@ PyTypeObject UnaryFunction1D_Type = {
 	0,                              /* tp_setattro */
 	0,                              /* tp_as_buffer */
 	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
-	"UnaryFunction1D objects",      /* tp_doc */
+	UnaryFunction1D___doc__,        /* tp_doc */
 	0,                              /* tp_traverse */
 	0,                              /* tp_clear */
 	0,                              /* tp_richcompare */
@@ -63,41 +110,6 @@ PyTypeObject UnaryFunction1D_Type = {
 	PyType_GenericNew,              /* tp_new */
 };
 
-//-------------------MODULE INITIALIZATION--------------------------------
-int UnaryFunction1D_Init( PyObject *module )
-{
-	if( module == NULL )
-		return -1;
-
-	if( PyType_Ready( &UnaryFunction1D_Type ) < 0 )
-		return -1;
-	Py_INCREF( &UnaryFunction1D_Type );
-	PyModule_AddObject(module, "UnaryFunction1D", (PyObject *)&UnaryFunction1D_Type);
-
-	UnaryFunction1DDouble_Init( module );
-	UnaryFunction1DEdgeNature_Init( module );
-	UnaryFunction1DFloat_Init( module );
-	UnaryFunction1DUnsigned_Init( module );
-	UnaryFunction1DVec2f_Init( module );
-	UnaryFunction1DVec3f_Init( module );
-	UnaryFunction1DVectorViewShape_Init( module );
-	UnaryFunction1DVoid_Init( module );
-	return 0;
-}
-
-//------------------------INSTANCE METHODS ----------------------------------
-
-void UnaryFunction1D___dealloc__(BPy_UnaryFunction1D* self)
-{
-    Py_TYPE(self)->tp_free((PyObject*)self);
-}
-
-
-PyObject * UnaryFunction1D___repr__(BPy_UnaryFunction1D* self)
-{
-    return PyUnicode_FromFormat("UnaryFunction1D");
-}
-
 ///////////////////////////////////////////////////////////////////////////////////////////
 
 #ifdef __cplusplus