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

diff --git a/source/blender/freestyle/intern/python/BPy_BBox.cpp b/source/blender/freestyle/intern/python/BPy_BBox.cpp
index 3e73e871c3e..0acd32bad58 100644
--- a/source/blender/freestyle/intern/python/BPy_BBox.cpp
+++ b/source/blender/freestyle/intern/python/BPy_BBox.cpp
@@ -6,10 +6,44 @@ extern "C" {
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 
-/*---------------  Python API function prototypes for BBox instance  -----------*/
-static int BBox___init__(BPy_BBox *self, PyObject *args, PyObject *kwds);
-static void BBox___dealloc__(BPy_BBox *self);
-static PyObject * BBox___repr__(BPy_BBox *self);
+//-------------------MODULE INITIALIZATION--------------------------------
+int BBox_Init( PyObject *module )
+{
+	if( module == NULL )
+		return -1;
+
+	if( PyType_Ready( &BBox_Type ) < 0 )
+		return -1;
+
+	Py_INCREF( &BBox_Type );
+	PyModule_AddObject(module, "BBox", (PyObject *)&BBox_Type);
+	return 0;
+}
+
+//------------------------INSTANCE METHODS ----------------------------------
+
+static char BBox___doc__[] =
+"Class for representing a bounding box.\n";
+
+static int BBox___init__(BPy_BBox *self, PyObject *args, PyObject *kwds)
+{
+	if(!( PyArg_ParseTuple(args, "") ))
+		return -1;
+	self->bb = new BBox< Vec3r>();
+	return 0;
+}
+
+static void BBox___dealloc__(BPy_BBox* self)
+{
+	delete self->bb;
+    Py_TYPE(self)->tp_free((PyObject*)self);
+}
+
+
+static PyObject * BBox___repr__(BPy_BBox* self)
+{
+    return PyUnicode_FromFormat("BBox - address: %p", self->bb );
+}
 
 /*----------------------BBox instance definitions ----------------------------*/
 static PyMethodDef BPy_BBox_methods[] = {
@@ -39,7 +73,7 @@ PyTypeObject BBox_Type = {
 	0,                              /* tp_setattro */
 	0,                              /* tp_as_buffer */
 	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
-	"BBox objects",                 /* tp_doc */
+	BBox___doc__,                   /* tp_doc */
 	0,                              /* tp_traverse */
 	0,                              /* tp_clear */
 	0,                              /* tp_richcompare */
@@ -59,43 +93,6 @@ PyTypeObject BBox_Type = {
 	PyType_GenericNew,              /* tp_new */
 };
 
-//-------------------MODULE INITIALIZATION--------------------------------
-int BBox_Init( PyObject *module )
-{
-	if( module == NULL )
-		return -1;
-
-	if( PyType_Ready( &BBox_Type ) < 0 )
-		return -1;
-
-	Py_INCREF( &BBox_Type );
-	PyModule_AddObject(module, "BBox", (PyObject *)&BBox_Type);
-	return 0;
-}
-
-//------------------------INSTANCE METHODS ----------------------------------
-
-int BBox___init__(BPy_BBox *self, PyObject *args, PyObject *kwds)
-{
-	if(!( PyArg_ParseTuple(args, "") ))
-		return -1;
-	self->bb = new BBox< Vec3r>();
-	return 0;
-}
-
-void BBox___dealloc__(BPy_BBox* self)
-{
-	delete self->bb;
-    Py_TYPE(self)->tp_free((PyObject*)self);
-}
-
-
-PyObject * BBox___repr__(BPy_BBox* self)
-{
-    return PyUnicode_FromFormat("BBox - address: %p", self->bb );
-}
-
-
 ///////////////////////////////////////////////////////////////////////////////////////////
 
 #ifdef __cplusplus