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, 83 insertions, 62 deletions

diff --git a/source/blender/freestyle/intern/python/BPy_BinaryPredicate0D.cpp b/source/blender/freestyle/intern/python/BPy_BinaryPredicate0D.cpp
index c6b418d727a..4bc8a0cb8bb 100644
--- a/source/blender/freestyle/intern/python/BPy_BinaryPredicate0D.cpp
+++ b/source/blender/freestyle/intern/python/BPy_BinaryPredicate0D.cpp
@@ -9,63 +9,6 @@ extern "C" {
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 
-/*---------------  Python API function prototypes for BinaryPredicate0D instance  -----------*/
-static int BinaryPredicate0D___init__(BPy_BinaryPredicate0D *self, PyObject *args, PyObject *kwds);
-static void BinaryPredicate0D___dealloc__(BPy_BinaryPredicate0D *self);
-static PyObject * BinaryPredicate0D___repr__(BPy_BinaryPredicate0D *self);
-
-static PyObject * BinaryPredicate0D_getName( BPy_BinaryPredicate0D *self, PyObject *args);
-static PyObject * BinaryPredicate0D___call__( BPy_BinaryPredicate0D *self, PyObject *args, PyObject *kwds);
-
-/*----------------------BinaryPredicate0D instance definitions ----------------------------*/
-static PyMethodDef BPy_BinaryPredicate0D_methods[] = {
-	{"getName", ( PyCFunction ) BinaryPredicate0D_getName, METH_NOARGS, "() Returns the string of the name of the binary predicate."},
-	{NULL, NULL, 0, NULL}
-};
-
-/*-----------------------BPy_BinaryPredicate0D type definition ------------------------------*/
-
-PyTypeObject BinaryPredicate0D_Type = {
-	PyVarObject_HEAD_INIT(NULL, 0)
-	"BinaryPredicate0D",            /* tp_name */
-	sizeof(BPy_BinaryPredicate0D),  /* tp_basicsize */
-	0,                              /* tp_itemsize */
-	(destructor)BinaryPredicate0D___dealloc__, /* tp_dealloc */
-	0,                              /* tp_print */
-	0,                              /* tp_getattr */
-	0,                              /* tp_setattr */
-	0,                              /* tp_reserved */
-	(reprfunc)BinaryPredicate0D___repr__, /* tp_repr */
-	0,                              /* tp_as_number */
-	0,                              /* tp_as_sequence */
-	0,                              /* tp_as_mapping */
-	0,                              /* tp_hash  */
-	(ternaryfunc)BinaryPredicate0D___call__, /* tp_call */
-	0,                              /* tp_str */
-	0,                              /* tp_getattro */
-	0,                              /* tp_setattro */
-	0,                              /* tp_as_buffer */
-	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
-	"BinaryPredicate0D objects",    /* tp_doc */
-	0,                              /* tp_traverse */
-	0,                              /* tp_clear */
-	0,                              /* tp_richcompare */
-	0,                              /* tp_weaklistoffset */
-	0,                              /* tp_iter */
-	0,                              /* tp_iternext */
-	BPy_BinaryPredicate0D_methods,  /* tp_methods */
-	0,                              /* tp_members */
-	0,                              /* tp_getset */
-	0,                              /* tp_base */
-	0,                              /* tp_dict */
-	0,                              /* tp_descr_get */
-	0,                              /* tp_descr_set */
-	0,                              /* tp_dictoffset */
-	(initproc)BinaryPredicate0D___init__, /* tp_init */
-	0,                              /* tp_alloc */
-	PyType_GenericNew,              /* tp_new */
-};
-
 //-------------------MODULE INITIALIZATION--------------------------------
 int BinaryPredicate0D_Init( PyObject *module )
 {
@@ -82,7 +25,30 @@ int BinaryPredicate0D_Init( PyObject *module )
 
 //------------------------INSTANCE METHODS ----------------------------------
 
-int BinaryPredicate0D___init__(BPy_BinaryPredicate0D *self, PyObject *args, PyObject *kwds)
+static char BinaryPredicate0D___doc__[] =
+"Base class for binary predicates working on :class:`Interface0D`\n"
+"objects.  A BinaryPredicate0D is typically an ordering relation\n"
+"between two Interface0D objects.  The predicate evaluates a relation\n"
+"between the two Interface0D instances and returns a boolean value (true\n"
+"or false).  It is used by invoking the __call__() method.\n"
+"\n"
+".. method:: __init__()\n"
+"\n"
+"   Default constructor.\n"
+"\n"
+".. method:: __call__(inter1, inter2)\n"
+"\n"
+"   Must be overload by inherited classes.  It evaluates a relation\n"
+"   between two Interface0D objects.\n"
+"\n"
+"   :arg inter1: The first Interface0D object.\n"
+"   :type inter1: :class:`Interface0D`\n"
+"   :arg inter2: The second Interface0D object.\n"
+"   :type inter2: :class:`Interface0D`\n"
+"   :return: True or false.\n"
+"   :rtype: bool\n";
+
+static int BinaryPredicate0D___init__(BPy_BinaryPredicate0D *self, PyObject *args, PyObject *kwds)
 {
     if ( !PyArg_ParseTuple(args, "") )
         return -1;
@@ -92,7 +58,7 @@ int BinaryPredicate0D___init__(BPy_BinaryPredicate0D *self, PyObject *args, PyOb
 	return 0;
 }
 
-void BinaryPredicate0D___dealloc__(BPy_BinaryPredicate0D* self)
+static void BinaryPredicate0D___dealloc__(BPy_BinaryPredicate0D* self)
 {
 	if (self->bp0D)
 		delete self->bp0D;
@@ -100,18 +66,25 @@ void BinaryPredicate0D___dealloc__(BPy_BinaryPredicate0D* self)
 }
 
 
-PyObject * BinaryPredicate0D___repr__(BPy_BinaryPredicate0D* self)
+static PyObject * BinaryPredicate0D___repr__(BPy_BinaryPredicate0D* self)
 {
     return PyUnicode_FromFormat("type: %s - address: %p", self->bp0D->getName().c_str(), self->bp0D );
 }
 
+static char BinaryPredicate0D_getName___doc__[] =
+".. method:: getName()\n"
+"\n"
+"   Returns the name of the binary 0D predicate.\n"
+"\n"
+"   :return: The name of the binary 0D predicate.\n"
+"   :rtype: string\n";
 
-PyObject * BinaryPredicate0D_getName( BPy_BinaryPredicate0D *self, PyObject *args)
+static PyObject * BinaryPredicate0D_getName( BPy_BinaryPredicate0D *self, PyObject *args)
 {
 	return PyUnicode_FromFormat( self->bp0D->getName().c_str() );
 }
 
-PyObject * BinaryPredicate0D___call__( BPy_BinaryPredicate0D *self, PyObject *args, PyObject *kwds)
+static PyObject * BinaryPredicate0D___call__( BPy_BinaryPredicate0D *self, PyObject *args, PyObject *kwds)
 {
 	BPy_Interface0D *obj1, *obj2;
 
@@ -137,6 +110,54 @@ PyObject * BinaryPredicate0D___call__( BPy_BinaryPredicate0D *self, PyObject *ar
 
 }
 
+/*----------------------BinaryPredicate0D instance definitions ----------------------------*/
+static PyMethodDef BPy_BinaryPredicate0D_methods[] = {
+	{"getName", ( PyCFunction ) BinaryPredicate0D_getName, METH_NOARGS, BinaryPredicate0D_getName___doc__},
+	{NULL, NULL, 0, NULL}
+};
+
+/*-----------------------BPy_BinaryPredicate0D type definition ------------------------------*/
+
+PyTypeObject BinaryPredicate0D_Type = {
+	PyVarObject_HEAD_INIT(NULL, 0)
+	"BinaryPredicate0D",            /* tp_name */
+	sizeof(BPy_BinaryPredicate0D),  /* tp_basicsize */
+	0,                              /* tp_itemsize */
+	(destructor)BinaryPredicate0D___dealloc__, /* tp_dealloc */
+	0,                              /* tp_print */
+	0,                              /* tp_getattr */
+	0,                              /* tp_setattr */
+	0,                              /* tp_reserved */
+	(reprfunc)BinaryPredicate0D___repr__, /* tp_repr */
+	0,                              /* tp_as_number */
+	0,                              /* tp_as_sequence */
+	0,                              /* tp_as_mapping */
+	0,                              /* tp_hash  */
+	(ternaryfunc)BinaryPredicate0D___call__, /* tp_call */
+	0,                              /* tp_str */
+	0,                              /* tp_getattro */
+	0,                              /* tp_setattro */
+	0,                              /* tp_as_buffer */
+	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
+	BinaryPredicate0D___doc__,      /* tp_doc */
+	0,                              /* tp_traverse */
+	0,                              /* tp_clear */
+	0,                              /* tp_richcompare */
+	0,                              /* tp_weaklistoffset */
+	0,                              /* tp_iter */
+	0,                              /* tp_iternext */
+	BPy_BinaryPredicate0D_methods,  /* tp_methods */
+	0,                              /* tp_members */
+	0,                              /* tp_getset */
+	0,                              /* tp_base */
+	0,                              /* tp_dict */
+	0,                              /* tp_descr_get */
+	0,                              /* tp_descr_set */
+	0,                              /* tp_dictoffset */
+	(initproc)BinaryPredicate0D___init__, /* tp_init */
+	0,                              /* tp_alloc */
+	PyType_GenericNew,              /* tp_new */
+};
 
 ///////////////////////////////////////////////////////////////////////////////////////////