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.

2 files changed, 52 insertions, 28 deletions

diff --git a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_ViewShape/BPy_GetOccludeeF0D.cpp b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_ViewShape/BPy_GetOccludeeF0D.cpp
index e2ab9f8758a..d4af0b2f95d 100644
--- a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_ViewShape/BPy_GetOccludeeF0D.cpp
+++ b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_ViewShape/BPy_GetOccludeeF0D.cpp
@@ -8,8 +8,31 @@ extern "C" {
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 
-/*---------------  Python API function prototypes for GetOccludeeF0D instance  -----------*/
-static int GetOccludeeF0D___init__(BPy_GetOccludeeF0D* self, PyObject *args);
+//------------------------INSTANCE METHODS ----------------------------------
+
+static char GetOccludeeF0D___doc__[] =
+".. method:: __init__()\n"
+"\n"
+"   Builds a GetOccludeeF0D object.\n"
+"\n"
+".. method:: __call__(it)\n"
+"\n"
+"   Returns the :class:`ViewShape` that the Interface0D pointed by the\n"
+"   Interface0DIterator occludes.\n"
+"\n"
+"   :arg it: An Interface0DIterator object.\n"
+"   :type it: :class:`Interface0DIterator`\n"
+"   :return: The ViewShape occluded by the pointed Interface0D.\n"
+"   :rtype: :class:`ViewShape`\n";
+
+static int GetOccludeeF0D___init__( BPy_GetOccludeeF0D* self, PyObject *args )
+{
+	if( !PyArg_ParseTuple(args, "") )
+		return -1;
+	self->py_uf0D_viewshape.uf0D_viewshape = new Functions0D::GetOccludeeF0D();
+	self->py_uf0D_viewshape.uf0D_viewshape->py_uf0D = (PyObject *)self;
+	return 0;
+}
 
 /*-----------------------BPy_GetOccludeeF0D type definition ------------------------------*/
 
@@ -34,7 +57,7 @@ PyTypeObject GetOccludeeF0D_Type = {
 	0,                              /* tp_setattro */
 	0,                              /* tp_as_buffer */
 	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
-	"GetOccludeeF0D objects",       /* tp_doc */
+	GetOccludeeF0D___doc__,         /* tp_doc */
 	0,                              /* tp_traverse */
 	0,                              /* tp_clear */
 	0,                              /* tp_richcompare */
@@ -54,17 +77,6 @@ PyTypeObject GetOccludeeF0D_Type = {
 	0,                              /* tp_new */
 };
 
-//------------------------INSTANCE METHODS ----------------------------------
-
-int GetOccludeeF0D___init__( BPy_GetOccludeeF0D* self, PyObject *args )
-{
-	if( !PyArg_ParseTuple(args, "") )
-		return -1;
-	self->py_uf0D_viewshape.uf0D_viewshape = new Functions0D::GetOccludeeF0D();
-	self->py_uf0D_viewshape.uf0D_viewshape->py_uf0D = (PyObject *)self;
-	return 0;
-}
-
 ///////////////////////////////////////////////////////////////////////////////////////////
 
 #ifdef __cplusplus
diff --git a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_ViewShape/BPy_GetShapeF0D.cpp b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_ViewShape/BPy_GetShapeF0D.cpp
index 7a74a059e59..331ee590b91 100644
--- a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_ViewShape/BPy_GetShapeF0D.cpp
+++ b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_ViewShape/BPy_GetShapeF0D.cpp
@@ -8,8 +8,31 @@ extern "C" {
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 
-/*---------------  Python API function prototypes for GetShapeF0D instance  -----------*/
-static int GetShapeF0D___init__(BPy_GetShapeF0D* self, PyObject *args);
+//------------------------INSTANCE METHODS ----------------------------------
+
+static char GetShapeF0D___doc__[] =
+".. method:: __init__()\n"
+"\n"
+"   Builds a GetShapeF0D.cpp object.\n"
+"\n"
+".. method:: __call__(it)\n"
+"\n"
+"   Returns the :class:`ViewShape` containing the Interface0D pointed\n"
+"   by the Interface0DIterator.\n"
+"\n"
+"   :arg it: An Interface0DIterator object.\n"
+"   :type it: :class:`Interface0DIterator`\n"
+"   :return: The ViewShape containing the pointed Interface0D.\n"
+"   :rtype: :class:`ViewShape`\n";
+
+static int GetShapeF0D___init__( BPy_GetShapeF0D* self, PyObject *args )
+{
+	if( !PyArg_ParseTuple(args, "") )
+		return -1;
+	self->py_uf0D_viewshape.uf0D_viewshape = new Functions0D::GetShapeF0D();
+	self->py_uf0D_viewshape.uf0D_viewshape->py_uf0D = (PyObject *)self;
+	return 0;
+}
 
 /*-----------------------BPy_GetShapeF0D type definition ------------------------------*/
 
@@ -34,7 +57,7 @@ PyTypeObject GetShapeF0D_Type = {
 	0,                              /* tp_setattro */
 	0,                              /* tp_as_buffer */
 	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
-	"GetShapeF0D objects",          /* tp_doc */
+	GetShapeF0D___doc__,            /* tp_doc */
 	0,                              /* tp_traverse */
 	0,                              /* tp_clear */
 	0,                              /* tp_richcompare */
@@ -54,17 +77,6 @@ PyTypeObject GetShapeF0D_Type = {
 	0,                              /* tp_new */
 };
 
-//------------------------INSTANCE METHODS ----------------------------------
-
-int GetShapeF0D___init__( BPy_GetShapeF0D* self, PyObject *args )
-{
-	if( !PyArg_ParseTuple(args, "") )
-		return -1;
-	self->py_uf0D_viewshape.uf0D_viewshape = new Functions0D::GetShapeF0D();
-	self->py_uf0D_viewshape.uf0D_viewshape->py_uf0D = (PyObject *)self;
-	return 0;
-}
-
 ///////////////////////////////////////////////////////////////////////////////////////////
 
 #ifdef __cplusplus