1 files changed, 104 insertions, 57 deletions

diff --git a/source/blender/freestyle/intern/python/Iterator/BPy_CurvePointIterator.cpp b/source/blender/freestyle/intern/python/Iterator/BPy_CurvePointIterator.cpp
index 0086a99a442..9af842b7612 100644
--- a/source/blender/freestyle/intern/python/Iterator/BPy_CurvePointIterator.cpp
+++ b/source/blender/freestyle/intern/python/Iterator/BPy_CurvePointIterator.cpp
@@ -9,20 +9,113 @@ extern "C" {
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 
-/*---------------  Python API function prototypes for CurvePointIterator instance  -----------*/
-static int CurvePointIterator___init__(BPy_CurvePointIterator *self, PyObject *args);
-static PyObject * CurvePointIterator_t( BPy_CurvePointIterator *self );
-static PyObject * CurvePointIterator_u( BPy_CurvePointIterator *self );
-static PyObject * CurvePointIterator_castToInterface0DIterator( BPy_CurvePointIterator *self );
+//------------------------INSTANCE METHODS ----------------------------------
+
+static char CurvePointIterator___doc__[] =
+"Class representing an iterator on a curve.  Allows an iterating\n"
+"outside initial vertices.  A CurvePoint is instanciated and returned\n"
+"by getObject().\n"
+"\n"
+".. method:: __init__(step=0.0)\n"
+"\n"
+"   Builds a CurvePointIterator object.\n"
+"\n"
+"   :arg step: A resampling resolution with which the curve is resampled.\n"
+"      If zero, no resampling is done (i.e., the iterator iterates over\n"
+"      initial vertices).\n"
+"   :type step: float\n"
+"\n"
+".. method:: __init__(brother)\n"
+"\n"
+"   Copy constructor.\n"
+"\n"
+"   :arg brother: A CurvePointIterator object.\n"
+"   :type brother: :class:`CurvePointIterator`\n";
+
+static int CurvePointIterator___init__(BPy_CurvePointIterator *self, PyObject *args )
+{	
+	PyObject *obj = 0;
+
+	if (! PyArg_ParseTuple(args, "|O", &obj) )
+	    return -1;
+
+	if( !obj ){
+		self->cp_it = new CurveInternal::CurvePointIterator();
+		
+	} else if( BPy_CurvePointIterator_Check(obj) ) {
+		self->cp_it = new CurveInternal::CurvePointIterator(*( ((BPy_CurvePointIterator *) obj)->cp_it ));
+	
+	} else if( PyFloat_Check(obj) ) {
+		self->cp_it = new CurveInternal::CurvePointIterator( PyFloat_AsDouble(obj) );
+			
+	} else {
+		PyErr_SetString(PyExc_TypeError, "invalid argument");
+		return -1;
+	}
 
-static PyObject * CurvePointIterator_getObject(BPy_CurvePointIterator *self);
+	self->py_it.it = self->cp_it;
+
+	return 0;
+}
+
+static char CurvePointIterator_t___doc__[] =
+".. method:: t()\n"
+"\n"
+"   Returns the curvilinear abscissa.\n"
+"\n"
+"   :return: The curvilinear abscissa.\n"
+"   :rtype: float\n";
+
+PyObject * CurvePointIterator_t( BPy_CurvePointIterator *self ) {
+	return PyFloat_FromDouble( self->cp_it->t() );
+}
+
+static char CurvePointIterator_u___doc__[] =
+".. method:: u()\n"
+"\n"
+"   Returns the point parameter in the curve (0<=u<=1).\n"
+"\n"
+"   :return: The point parameter.\n"
+"   :rtype: float\n";
+
+static PyObject * CurvePointIterator_u( BPy_CurvePointIterator *self ) {
+	return PyFloat_FromDouble( self->cp_it->u() );
+}
+
+static char CurvePointIterator_castToInterface0DIterator___doc__[] =
+".. method:: castToInterface0DIterator()\n"
+"\n"
+"   Returns an Interface0DIterator converted from this\n"
+"   CurvePointIterator.  Useful for any call to a function of the\n"
+"   UnaryFunction0D type.\n"
+"\n"
+"   :return: An Interface0DIterator object converted from the\n"
+"      iterator.\n"
+"   :rtype: :class:`Interface0DIterator`\n";
+
+static PyObject * CurvePointIterator_castToInterface0DIterator( BPy_CurvePointIterator *self ) {
+	Interface0DIterator it( self->cp_it->castToInterface0DIterator() );
+	return BPy_Interface0DIterator_from_Interface0DIterator( it, 0 );
+}
+
+static char CurvePointIterator_getObject___doc__[] =
+".. method:: getObject()\n"
+"\n"
+"   Returns a CurvePoint pointed by the iterator.\n"
+"\n"
+"   :return: \n"
+"   :rtype: :class:`CurvePoint`\n";
+
+static PyObject * CurvePointIterator_getObject(BPy_CurvePointIterator *self) {
+	return BPy_CurvePoint_from_CurvePoint( self->cp_it->operator*() );
+}
 
 /*----------------------CurvePointIterator instance definitions ----------------------------*/
 static PyMethodDef BPy_CurvePointIterator_methods[] = {
-	{"t", ( PyCFunction ) CurvePointIterator_t, METH_NOARGS, "() Returns the curvilinear abscissa."},
-	{"u", ( PyCFunction ) CurvePointIterator_u, METH_NOARGS, "() Returns the point parameter in the curve 0<=u<=1."},
-	{"castToInterface0DIterator", ( PyCFunction ) CurvePointIterator_castToInterface0DIterator, METH_NOARGS, "() Casts this CurvePointIterator into an Interface0DIterator. Useful for any call to a function of the type UnaryFunction0D."},
-	{"getObject", ( PyCFunction ) CurvePointIterator_getObject, METH_NOARGS, "() Get object referenced by the iterator"},
+	{"t", ( PyCFunction ) CurvePointIterator_t, METH_NOARGS, CurvePointIterator_t___doc__},
+	{"u", ( PyCFunction ) CurvePointIterator_u, METH_NOARGS, CurvePointIterator_u___doc__},
+	{"castToInterface0DIterator", ( PyCFunction ) CurvePointIterator_castToInterface0DIterator, METH_NOARGS, CurvePointIterator_castToInterface0DIterator___doc__},
+	{"getObject", ( PyCFunction ) CurvePointIterator_getObject, METH_NOARGS, CurvePointIterator_getObject___doc__},
 	{NULL, NULL, 0, NULL}
 };
 
@@ -49,7 +142,7 @@ PyTypeObject CurvePointIterator_Type = {
 	0,                              /* tp_setattro */
 	0,                              /* tp_as_buffer */
 	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
-	"CurvePointIterator objects",   /* tp_doc */
+	CurvePointIterator___doc__,     /* tp_doc */
 	0,                              /* tp_traverse */
 	0,                              /* tp_clear */
 	0,                              /* tp_richcompare */
@@ -69,52 +162,6 @@ PyTypeObject CurvePointIterator_Type = {
 	0,                              /* tp_new */
 };
 
-//------------------------INSTANCE METHODS ----------------------------------
-
-int CurvePointIterator___init__(BPy_CurvePointIterator *self, PyObject *args )
-{	
-	PyObject *obj = 0;
-
-	if (! PyArg_ParseTuple(args, "|O", &obj) )
-	    return -1;
-
-	if( !obj ){
-		self->cp_it = new CurveInternal::CurvePointIterator();
-		
-	} else if( BPy_CurvePointIterator_Check(obj) ) {
-		self->cp_it = new CurveInternal::CurvePointIterator(*( ((BPy_CurvePointIterator *) obj)->cp_it ));
-	
-	} else if( PyFloat_Check(obj) ) {
-		self->cp_it = new CurveInternal::CurvePointIterator( PyFloat_AsDouble(obj) );
-			
-	} else {
-		PyErr_SetString(PyExc_TypeError, "invalid argument");
-		return -1;
-	}
-
-	self->py_it.it = self->cp_it;
-
-	return 0;
-}
-
-PyObject * CurvePointIterator_t( BPy_CurvePointIterator *self ) {
-	return PyFloat_FromDouble( self->cp_it->t() );
-}
-
-PyObject * CurvePointIterator_u( BPy_CurvePointIterator *self ) {
-	return PyFloat_FromDouble( self->cp_it->u() );
-}
-
-PyObject * CurvePointIterator_castToInterface0DIterator( BPy_CurvePointIterator *self ) {
-	Interface0DIterator it( self->cp_it->castToInterface0DIterator() );
-	return BPy_Interface0DIterator_from_Interface0DIterator( it, 0 );
-}
-
-PyObject * CurvePointIterator_getObject(BPy_CurvePointIterator *self) {
-	return BPy_CurvePoint_from_CurvePoint( self->cp_it->operator*() );
-}
-
-
 ///////////////////////////////////////////////////////////////////////////////////////////
 
 #ifdef __cplusplus