[Bf-blender-cvs] [41d778f] master: Docstring updates and code cleanup by flokkievids (Folkert de Vries).

[Tamito Kajiyama]

Commit: 41d778fa5d160c32e0f917c5502b198878fa1c08
Author: Tamito Kajiyama
Date:   Sun Feb 2 20:58:01 2014 +0900
https://developer.blender.org/rB41d778fa5d160c32e0f917c5502b198878fa1c08

Docstring updates and code cleanup by flokkievids (Folkert de Vries).

===================================================================

M	source/blender/freestyle/intern/python/BPy_Convert.cpp
M	source/blender/freestyle/intern/python/Iterator/BPy_AdjacencyIterator.cpp
M	source/blender/freestyle/intern/python/Iterator/BPy_Interface0DIterator.cpp
M	source/blender/freestyle/intern/python/Iterator/BPy_StrokeVertexIterator.cpp
M	source/blender/freestyle/intern/python/Iterator/BPy_orientedViewEdgeIterator.cpp

===================================================================

diff --git a/source/blender/freestyle/intern/python/BPy_Convert.cpp b/source/blender/freestyle/intern/python/BPy_Convert.cpp
index 50dde3a..746d5e7 100644
--- a/source/blender/freestyle/intern/python/BPy_Convert.cpp
+++ b/source/blender/freestyle/intern/python/BPy_Convert.cpp
@@ -410,7 +410,7 @@ PyObject *BPy_AdjacencyIterator_from_AdjacencyIterator(AdjacencyIterator& a_it)
 	PyObject *py_a_it = AdjacencyIterator_Type.tp_new(&AdjacencyIterator_Type, 0, 0);
 	((BPy_AdjacencyIterator *)py_a_it)->a_it = new AdjacencyIterator(a_it);
 	((BPy_AdjacencyIterator *)py_a_it)->py_it.it = ((BPy_AdjacencyIterator *)py_a_it)->a_it;
-	((BPy_AdjacencyIterator *)py_a_it)->at_start= true;
+	((BPy_AdjacencyIterator *)py_a_it)->at_start = true;
 	return py_a_it;
 }
 
@@ -419,7 +419,7 @@ PyObject *BPy_Interface0DIterator_from_Interface0DIterator(Interface0DIterator&
 	PyObject *py_if0D_it = Interface0DIterator_Type.tp_new(&Interface0DIterator_Type, 0, 0);
 	((BPy_Interface0DIterator *)py_if0D_it)->if0D_it = new Interface0DIterator(if0D_it);
 	((BPy_Interface0DIterator *)py_if0D_it)->py_it.it = ((BPy_Interface0DIterator *)py_if0D_it)->if0D_it;
-	((BPy_Interface0DIterator *)py_if0D_it)->at_start= true;
+	((BPy_Interface0DIterator *)py_if0D_it)->at_start = true;
 	((BPy_Interface0DIterator *)py_if0D_it)->reversed = reversed;
 	return py_if0D_it;
 }
@@ -437,7 +437,7 @@ PyObject *BPy_StrokeVertexIterator_from_StrokeVertexIterator(StrokeInternal::Str
 	PyObject *py_sv_it = StrokeVertexIterator_Type.tp_new(&StrokeVertexIterator_Type, 0, 0);
 	((BPy_StrokeVertexIterator *)py_sv_it)->sv_it = new StrokeInternal::StrokeVertexIterator(sv_it);
 	((BPy_StrokeVertexIterator *)py_sv_it)->py_it.it = ((BPy_StrokeVertexIterator *)py_sv_it)->sv_it;
-	((BPy_StrokeVertexIterator *)py_sv_it)->at_start= true;
+	((BPy_StrokeVertexIterator *)py_sv_it)->at_start = true;
 	((BPy_StrokeVertexIterator *)py_sv_it)->reversed = reversed;
 	return py_sv_it;
 }
@@ -455,7 +455,7 @@ PyObject *BPy_orientedViewEdgeIterator_from_orientedViewEdgeIterator(ViewVertexI
 	PyObject *py_ove_it = orientedViewEdgeIterator_Type.tp_new(&orientedViewEdgeIterator_Type, 0, 0);
 	((BPy_orientedViewEdgeIterator *)py_ove_it)->ove_it = new ViewVertexInternal::orientedViewEdgeIterator(ove_it);
 	((BPy_orientedViewEdgeIterator *)py_ove_it)->py_it.it = ((BPy_orientedViewEdgeIterator *)py_ove_it)->ove_it;
-	((BPy_orientedViewEdgeIterator *)py_ove_it)->at_start= true;
+	((BPy_orientedViewEdgeIterator *)py_ove_it)->at_start = true;
 	((BPy_orientedViewEdgeIterator *)py_ove_it)->reversed = reversed;
 	return py_ove_it;
 }
diff --git a/source/blender/freestyle/intern/python/Iterator/BPy_AdjacencyIterator.cpp b/source/blender/freestyle/intern/python/Iterator/BPy_AdjacencyIterator.cpp
index 4fd0817..0999688 100644
--- a/source/blender/freestyle/intern/python/Iterator/BPy_AdjacencyIterator.cpp
+++ b/source/blender/freestyle/intern/python/Iterator/BPy_AdjacencyIterator.cpp
@@ -130,7 +130,7 @@ static PyObject *AdjacencyIterator_iternext(BPy_AdjacencyIterator *self)
 /*----------------------AdjacencyIterator get/setters ----------------------------*/
 
 PyDoc_STRVAR(AdjacencyIterator_object_doc,
-"The ViewEdge object currently pointed by this iterator.\n"
+"The ViewEdge object currently pointed to by this iterator.\n"
 "\n"
 ":type: :class:`ViewEdge`");
 
diff --git a/source/blender/freestyle/intern/python/Iterator/BPy_Interface0DIterator.cpp b/source/blender/freestyle/intern/python/Iterator/BPy_Interface0DIterator.cpp
index 030c290..c7c9e34 100644
--- a/source/blender/freestyle/intern/python/Iterator/BPy_Interface0DIterator.cpp
+++ b/source/blender/freestyle/intern/python/Iterator/BPy_Interface0DIterator.cpp
@@ -140,7 +140,7 @@ static PyObject *Interface0DIterator_iternext(BPy_Interface0DIterator *self)
 /*----------------------Interface0DIterator get/setters ----------------------------*/
 
 PyDoc_STRVAR(Interface0DIterator_object_doc,
-"The Interface0D object currently pointed by this iterator.\n"
+"The Interface0D object currently pointed to by this iterator.\n"
 "\n"
 ":type: :class:`Interface0D`");
 
diff --git a/source/blender/freestyle/intern/python/Iterator/BPy_StrokeVertexIterator.cpp b/source/blender/freestyle/intern/python/Iterator/BPy_StrokeVertexIterator.cpp
index fff6fbd..f796c8e 100644
--- a/source/blender/freestyle/intern/python/Iterator/BPy_StrokeVertexIterator.cpp
+++ b/source/blender/freestyle/intern/python/Iterator/BPy_StrokeVertexIterator.cpp
@@ -40,15 +40,15 @@ PyDoc_STRVAR(StrokeVertexIterator_doc,
 "\n"
 "Class defining an iterator designed to iterate over the\n"
 ":class:`StrokeVertex` of a :class:`Stroke`.  An instance of a\n"
-"StrokeVertexIterator can only be obtained from a Stroke by calling\n"
-"strokeVerticesBegin() or strokeVerticesEnd().  It is iterating over\n"
-"the same vertices as an :class:`Interface0DIterator`.  The difference\n"
-"resides in the object access.  Indeed, an Interface0DIterator allows\n"
-"only an access to an Interface0D whereas we could need to access the\n"
+"StrokeVertexIterator can be obtained from a Stroke by calling\n"
+"iter(), stroke_vertices_begin() or stroke_vertices_begin().  It is iterating\n"
+"over the same vertices as an :class:`Interface0DIterator`.  The difference\n"
+"resides in the object access: an Interface0DIterator only allows\n"
+"access to an Interface0D while one might need to access the\n"
 "specialized StrokeVertex type.  In this case, one should use a\n"
-"StrokeVertexIterator.  The castToInterface0DIterator() method is\n"
-"useful to get an Interface0DIterator from a StrokeVertexIterator in\n"
-"order to call any functions of the UnaryFunction0D type.\n"
+"StrokeVertexIterator.  To call functions of the UnaryFuntion0D type,\n"
+"a StrokeVertexIterator can be converted to an Interface0DIterator by\n"
+"by calling Interface0DIterator(it)."
 "\n"
 ".. method:: __init__()\n"
 "\n"
@@ -132,7 +132,7 @@ static PyObject *StrokeVertexIterator_iternext(BPy_StrokeVertexIterator *self)
 /*----------------------StrokeVertexIterator get/setters ----------------------------*/
 
 PyDoc_STRVAR(StrokeVertexIterator_object_doc,
-"The StrokeVertex object currently pointed by this iterator.\n"
+"The StrokeVertex object currently pointed to by this iterator.\n"
 "\n"
 ":type: :class:`StrokeVertex`");
 
diff --git a/source/blender/freestyle/intern/python/Iterator/BPy_orientedViewEdgeIterator.cpp b/source/blender/freestyle/intern/python/Iterator/BPy_orientedViewEdgeIterator.cpp
index 312c2fa..ec3e534 100644
--- a/source/blender/freestyle/intern/python/Iterator/BPy_orientedViewEdgeIterator.cpp
+++ b/source/blender/freestyle/intern/python/Iterator/BPy_orientedViewEdgeIterator.cpp
@@ -40,7 +40,7 @@ PyDoc_STRVAR(orientedViewEdgeIterator_doc,
 "Class representing an iterator over oriented ViewEdges around a\n"
 ":class:`ViewVertex`.  This iterator allows a CCW iteration (in the image\n"
 "plane).  An instance of an orientedViewEdgeIterator can only be\n"
-"obtained from a ViewVertex by calling edgesBegin() or edgesEnd().\n"
+"obtained from a ViewVertex by calling edges_begin() or edges_end().\n"
 "\n"
 ".. method:: __init__()\n"
 "\n"
@@ -121,7 +121,7 @@ static PyObject *orientedViewEdgeIterator_iternext(BPy_orientedViewEdgeIterator
 
 PyDoc_STRVAR(orientedViewEdgeIterator_object_doc,
 "The oriented ViewEdge (i.e., a tuple of the pointed ViewEdge and a boolean\n"
-"value) currently pointed by this iterator. If the boolean value is true,\n"
+"value) currently pointed to by this iterator. If the boolean value is true,\n"
 "the ViewEdge is incoming.\n"
 "\n"
 ":type: (:class:`directedViewEdge`, bool)");