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, 151 insertions, 86 deletions

diff --git a/source/blender/freestyle/intern/python/BPy_SShape.cpp b/source/blender/freestyle/intern/python/BPy_SShape.cpp
index 9ab2fbac096..512a19359a5 100644
--- a/source/blender/freestyle/intern/python/BPy_SShape.cpp
+++ b/source/blender/freestyle/intern/python/BPy_SShape.cpp
@@ -12,79 +12,6 @@ extern "C" {
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 
-/*---------------  Python API function prototypes for SShape instance  -----------*/
-static int SShape___init__(BPy_SShape *self, PyObject *args, PyObject *kwds);
-static void SShape___dealloc__(BPy_SShape *self);
-static PyObject * SShape___repr__(BPy_SShape* self);
-
-static PyObject * SShape_AddEdge( BPy_SShape *self , PyObject *args);
-static PyObject * SShape_AddNewVertex( BPy_SShape *self , PyObject *args);
-static PyObject * SShape_setBBox( BPy_SShape *self , PyObject *args);
-static PyObject * SShape_ComputeBBox( BPy_SShape *self );
-static PyObject * SShape_bbox( BPy_SShape *self );
-static PyObject * SShape_getVertexList( BPy_SShape *self );
-static PyObject * SShape_getEdgeList( BPy_SShape *self );
-static PyObject * SShape_getId( BPy_SShape *self );
-static PyObject * SShape_setId( BPy_SShape *self , PyObject *args);
-
-/*----------------------SShape instance definitions ----------------------------*/
-static PyMethodDef BPy_SShape_methods[] = {
-	{"AddEdge", ( PyCFunction ) SShape_AddEdge, METH_VARARGS, "(FEdge fe) Adds a FEdge to the list of FEdges. "},
-	{"AddNewVertex", ( PyCFunction ) SShape_AddNewVertex, METH_VARARGS, "(SVertex sv) Adds a SVertex to the list of SVertex of this Shape. The SShape attribute of the SVertex is also set to 'this'."},
-	{"setBBox", ( PyCFunction ) SShape_setBBox, METH_VARARGS, "(BBox bb) Sets the Bounding Box of the Shape"},
-	{"ComputeBBox", ( PyCFunction ) SShape_ComputeBBox, METH_NOARGS, "() Compute the bbox of the SShape"},
-	{"bbox", ( PyCFunction ) SShape_bbox, METH_NOARGS, "() Returns the bounding box of the shape."},
-	{"getVertexList", ( PyCFunction ) SShape_getVertexList, METH_NOARGS, "() Returns the list of SVertex of the Shape"},
-	{"getEdgeList", ( PyCFunction ) SShape_getEdgeList, METH_NOARGS, "() Returns the list of FEdges of the Shape."},
-	{"getId", ( PyCFunction ) SShape_getId, METH_NOARGS, "() Returns the Id of the Shape. "},
-	{"setId", ( PyCFunction ) SShape_setId, METH_VARARGS, "(Id id) Sets the Id of the shape. "},
-	
-	{NULL, NULL, 0, NULL}
-};
-
-/*-----------------------BPy_SShape type definition ------------------------------*/
-
-PyTypeObject SShape_Type = {
-	PyVarObject_HEAD_INIT(NULL, 0)
-	"SShape",                       /* tp_name */
-	sizeof(BPy_SShape),             /* tp_basicsize */
-	0,                              /* tp_itemsize */
-	(destructor)SShape___dealloc__, /* tp_dealloc */
-	0,                              /* tp_print */
-	0,                              /* tp_getattr */
-	0,                              /* tp_setattr */
-	0,                              /* tp_reserved */
-	(reprfunc)SShape___repr__,      /* tp_repr */
-	0,                              /* tp_as_number */
-	0,                              /* tp_as_sequence */
-	0,                              /* tp_as_mapping */
-	0,                              /* tp_hash  */
-	0,                              /* tp_call */
-	0,                              /* tp_str */
-	0,                              /* tp_getattro */
-	0,                              /* tp_setattro */
-	0,                              /* tp_as_buffer */
-	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
-	"SShape objects",               /* tp_doc */
-	0,                              /* tp_traverse */
-	0,                              /* tp_clear */
-	0,                              /* tp_richcompare */
-	0,                              /* tp_weaklistoffset */
-	0,                              /* tp_iter */
-	0,                              /* tp_iternext */
-	BPy_SShape_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)SShape___init__,      /* tp_init */
-	0,                              /* tp_alloc */
-	PyType_GenericNew,              /* tp_new */
-};
-
 //-------------------MODULE INITIALIZATION--------------------------------
 int SShape_Init( PyObject *module )
 {
@@ -101,7 +28,22 @@ int SShape_Init( PyObject *module )
 
 //------------------------INSTANCE METHODS ----------------------------------
 
-int SShape___init__(BPy_SShape *self, PyObject *args, PyObject *kwds)
+static char SShape___doc__[] =
+"Class to define a feature shape.  It is the gathering of feature\n"
+"elements from an identified input shape.\n"
+"\n"
+".. method:: __init__()\n"
+"\n"
+"   Default constructor.\n"
+"\n"
+".. method:: __init__(iBrother)\n"
+"\n"
+"   Copy constructor.\n"
+"\n"
+"   :arg iBrother: An SShape object.\n"
+"   :type iBrother: :class:`SShape`\n";
+
+static int SShape___init__(BPy_SShape *self, PyObject *args, PyObject *kwds)
 {
 	PyObject *obj = NULL;
 
@@ -119,19 +61,27 @@ int SShape___init__(BPy_SShape *self, PyObject *args, PyObject *kwds)
     return 0;
 }
 
-void SShape___dealloc__(BPy_SShape *self)
+static void SShape___dealloc__(BPy_SShape *self)
 {
 	if( self->ss && !self->borrowed )
 		delete self->ss;
     Py_TYPE(self)->tp_free((PyObject*)self);
 }
 
-PyObject * SShape___repr__(BPy_SShape *self)
+static PyObject * SShape___repr__(BPy_SShape *self)
 {
     return PyUnicode_FromFormat("SShape - address: %p", self->ss );
 }
 
-PyObject * SShape_AddEdge( BPy_SShape *self , PyObject *args) {
+static char SShape_AddEdge___doc__[] =
+".. method:: AddEdge(iEdge)\n"
+"\n"
+"   Adds an FEdge to the list of FEdges.\n"
+"\n"
+"   :arg iEdge: An FEdge object.\n"
+"   :type iEdge: :class:`FEdge`\n";
+
+static PyObject * SShape_AddEdge( BPy_SShape *self , PyObject *args) {
 	PyObject *py_fe = 0;
 
 	if(!( PyArg_ParseTuple(args, "O!", &FEdge_Type, &py_fe) ))
@@ -142,7 +92,16 @@ PyObject * SShape_AddEdge( BPy_SShape *self , PyObject *args) {
 	Py_RETURN_NONE;
 }
 
-PyObject * SShape_AddNewVertex( BPy_SShape *self , PyObject *args) {
+static char SShape_AddNewVertex___doc__[] =
+".. method:: AddNewVertex(iv)\n"
+"\n"
+"   Adds an SVertex to the list of SVertex of this Shape.  The SShape\n"
+"   attribute of the SVertex is also set to this SShape.\n"
+"\n"
+"   :arg iv: An SVertex object.\n"
+"   :type iv: :class:`SVertex`\n";
+
+static PyObject * SShape_AddNewVertex( BPy_SShape *self , PyObject *args) {
 	PyObject *py_sv = 0;
 
 	if(!( PyArg_ParseTuple(args, "O!", &SVertex_Type, &py_sv) ))
@@ -153,7 +112,15 @@ PyObject * SShape_AddNewVertex( BPy_SShape *self , PyObject *args) {
 	Py_RETURN_NONE;
 }
 
-PyObject * SShape_setBBox( BPy_SShape *self , PyObject *args) {
+static char SShape_setBBox___doc__[] =
+".. method:: setBBox(iBBox)\n"
+"\n"
+"   Sets the bounding box of the SShape.\n"
+"\n"
+"   :arg iBBox: The bounding box of the SShape.\n"
+"   :type iBBox: :class:`BBox`\n";
+
+static PyObject * SShape_setBBox( BPy_SShape *self , PyObject *args) {
 	PyObject *py_bb = 0;
 
 	if(!( PyArg_ParseTuple(args, "O!", &BBox_Type, &py_bb) ))
@@ -164,19 +131,39 @@ PyObject * SShape_setBBox( BPy_SShape *self , PyObject *args) {
 	Py_RETURN_NONE;
 }
 
-PyObject * SShape_ComputeBBox( BPy_SShape *self ) {
+static char SShape_ComputeBBox___doc__[] =
+".. method:: ComputeBBox()\n"
+"\n"
+"   Compute the bbox of the SShape.\n";
+
+static PyObject * SShape_ComputeBBox( BPy_SShape *self ) {
 	self->ss->ComputeBBox();
 
 	Py_RETURN_NONE;
 }
 
-PyObject * SShape_bbox( BPy_SShape *self ) {
+static char SShape_bbox___doc__[] =
+".. method:: bbox()\n"
+"\n"
+"   Returns the bounding box of the SShape.\n"
+"\n"
+"   :return: the bounding box of the SShape.\n"
+"   :rtype: :class:`BBox`\n";
+
+static PyObject * SShape_bbox( BPy_SShape *self ) {
 	BBox<Vec3r> bb( self->ss->bbox() );
 	return BPy_BBox_from_BBox( bb );
 }
 
+static char SShape_getVertexList___doc__[] =
+".. method:: getVertexList()\n"
+"\n"
+"   Returns the list of vertices of the SShape.\n"
+"\n"
+"   :return: The list of vertices objects.\n"
+"   :rtype: List of :class:`SVertex` objects\n";
 
-PyObject * SShape_getVertexList( BPy_SShape *self ) {
+static PyObject * SShape_getVertexList( BPy_SShape *self ) {
 	PyObject *py_vertices = PyList_New(0);
 
 	vector< SVertex * > vertices = self->ss->getVertexList();
@@ -189,8 +176,15 @@ PyObject * SShape_getVertexList( BPy_SShape *self ) {
 	return py_vertices;
 }
 
+static char SShape_getEdgeList___doc__[] =
+".. method:: getEdgeList()\n"
+"\n"
+"   Returns the list of edges of the SShape.\n"
+"\n"
+"   :return: The list of edges of the SShape.\n"
+"   :rtype: List of :class:`FEdge` objects\n";
 
-PyObject * SShape_getEdgeList( BPy_SShape *self ) {
+static PyObject * SShape_getEdgeList( BPy_SShape *self ) {
 	PyObject *py_edges = PyList_New(0);
 
 	vector< FEdge * > edges = self->ss->getEdgeList();
@@ -203,12 +197,28 @@ PyObject * SShape_getEdgeList( BPy_SShape *self ) {
 	return py_edges;
 }
 
-PyObject * SShape_getId( BPy_SShape *self ) {
+static char SShape_getId___doc__[] =
+".. method:: getId()\n"
+"\n"
+"   Returns the Id of the SShape.\n"
+"\n"
+"   :return: The Id of the SShape.\n"
+"   :rtype: :class:`Id`\n";
+
+static PyObject * SShape_getId( BPy_SShape *self ) {
 	Id id( self->ss->getId() );
 	return BPy_Id_from_Id( id );
 }
 
-PyObject * SShape_setId( BPy_SShape *self , PyObject *args) {
+static char SShape_setId___doc__[] =
+".. method:: setId(id)\n"
+"\n"
+"   Sets the Id of the SShape.\n"
+"\n"
+"   :arg id: The Id of the SShape.\n"
+"   :type id: :class:`Id`\n";
+
+static PyObject * SShape_setId( BPy_SShape *self , PyObject *args) {
 	PyObject *py_id;
 
 	if(!( PyArg_ParseTuple(args, "O!", &Id_Type, &py_id) ))
@@ -219,11 +229,66 @@ PyObject * SShape_setId( BPy_SShape *self , PyObject *args) {
 	Py_RETURN_NONE;
 }
 
-
 // const Material & 	material (unsigned i) const
 // const vector< Material > & 	materials () const
 // void 	SetMaterials (const vector< Material > &iMaterials)
 
+/*----------------------SShape instance definitions ----------------------------*/
+static PyMethodDef BPy_SShape_methods[] = {
+	{"AddEdge", ( PyCFunction ) SShape_AddEdge, METH_VARARGS, SShape_AddEdge___doc__},
+	{"AddNewVertex", ( PyCFunction ) SShape_AddNewVertex, METH_VARARGS, SShape_AddNewVertex___doc__},
+	{"setBBox", ( PyCFunction ) SShape_setBBox, METH_VARARGS, SShape_setBBox___doc__},
+	{"ComputeBBox", ( PyCFunction ) SShape_ComputeBBox, METH_NOARGS, SShape_ComputeBBox___doc__},
+	{"bbox", ( PyCFunction ) SShape_bbox, METH_NOARGS, SShape_bbox___doc__},
+	{"getVertexList", ( PyCFunction ) SShape_getVertexList, METH_NOARGS, SShape_getVertexList___doc__},
+	{"getEdgeList", ( PyCFunction ) SShape_getEdgeList, METH_NOARGS, SShape_getEdgeList___doc__},
+	{"getId", ( PyCFunction ) SShape_getId, METH_NOARGS, SShape_getId___doc__},
+	{"setId", ( PyCFunction ) SShape_setId, METH_VARARGS, SShape_setId___doc__},
+	{NULL, NULL, 0, NULL}
+};
+
+/*-----------------------BPy_SShape type definition ------------------------------*/
+
+PyTypeObject SShape_Type = {
+	PyVarObject_HEAD_INIT(NULL, 0)
+	"SShape",                       /* tp_name */
+	sizeof(BPy_SShape),             /* tp_basicsize */
+	0,                              /* tp_itemsize */
+	(destructor)SShape___dealloc__, /* tp_dealloc */
+	0,                              /* tp_print */
+	0,                              /* tp_getattr */
+	0,                              /* tp_setattr */
+	0,                              /* tp_reserved */
+	(reprfunc)SShape___repr__,      /* tp_repr */
+	0,                              /* tp_as_number */
+	0,                              /* tp_as_sequence */
+	0,                              /* tp_as_mapping */
+	0,                              /* tp_hash  */
+	0,                              /* tp_call */
+	0,                              /* tp_str */
+	0,                              /* tp_getattro */
+	0,                              /* tp_setattro */
+	0,                              /* tp_as_buffer */
+	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
+	SShape___doc__,                 /* tp_doc */
+	0,                              /* tp_traverse */
+	0,                              /* tp_clear */
+	0,                              /* tp_richcompare */
+	0,                              /* tp_weaklistoffset */
+	0,                              /* tp_iter */
+	0,                              /* tp_iternext */
+	BPy_SShape_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)SShape___init__,      /* tp_init */
+	0,                              /* tp_alloc */
+	PyType_GenericNew,              /* tp_new */
+};
 
 ///////////////////////////////////////////////////////////////////////////////////////////