diff options
| author | Aaron Carlisle <Blendify> | 2020-10-23 00:20:57 +0300 |
|---|---|---|
| committer | Aaron Carlisle <carlisle.b3d@gmail.com> | 2020-10-23 00:22:05 +0300 |
| commit | baa24f1c91d21e10f51881f8fad012f30f99e26f (patch) | |
| tree | e3872d6dd8d50ddb657d9610a2ce3b7a6a31bef9 | |
| parent | 956af161893f70198bd89d5ab338a24a011d30c2 (diff) | |
Pydoc: Fix sphinx compile warnings about freestyle
Sphinx expects functions and methods with the same name and different
parameters to be written using one directive. See:
https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#basic-markup
Unfortunately this makes giving different descriptions for each harder.
This was already a request for better support for this in sphinx, see:
https://github.com/sphinx-doc/sphinx/issues/7787
Reviewed By: campbellbarton
Differential Revision: https://developer.blender.org/D9170
35 files changed, 306 insertions, 541 deletions
diff --git a/source/blender/freestyle/intern/python/BPy_FrsMaterial.cpp b/source/blender/freestyle/intern/python/BPy_FrsMaterial.cpp index dbf1c12fb01..3efabbfbdf5 100644 --- a/source/blender/freestyle/intern/python/BPy_FrsMaterial.cpp +++ b/source/blender/freestyle/intern/python/BPy_FrsMaterial.cpp @@ -55,21 +55,14 @@ PyDoc_STRVAR( "Class defining a material.\n" "\n" ".. method:: __init__()\n" + " __init__(brother)\n" + " __init__(line, diffuse, ambient, specular, emission, shininess, priority)\n" "\n" - " Default constructor.\n" + " Creates a :class:`FrsMaterial` using either default constructor,\n" + " copy constructor, or an overloaded constructor\n" "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy constructor.\n" - "\n" - " :arg brother: A Material object.\n" + " :arg brother: A Material object to be used as a copy constructor.\n" " :type brother: :class:`Material`\n" - "\n" - ".. method:: __init__(line, diffuse, ambient, specular, emission, shininess, priority)\n" - "\n" - " Builds a Material from its line, diffuse, ambient, specular, emissive\n" - " colors, a shininess coefficient and line color priority.\n" - "\n" " :arg line: The line color.\n" " :type line: :class:`mathutils.Vector`, list or tuple of 4 float values\n" " :arg diffuse: The diffuse color.\n" diff --git a/source/blender/freestyle/intern/python/BPy_Id.cpp b/source/blender/freestyle/intern/python/BPy_Id.cpp index eb0eb661e3d..8f61f7f3e14 100644 --- a/source/blender/freestyle/intern/python/BPy_Id.cpp +++ b/source/blender/freestyle/intern/python/BPy_Id.cpp @@ -46,24 +46,21 @@ int Id_Init(PyObject *module) //------------------------INSTANCE METHODS ---------------------------------- -PyDoc_STRVAR(Id_doc, - "Class for representing an object Id.\n" - "\n" - ".. method:: __init__(first=0, second=0)\n" - "\n" - " Build the Id from two numbers.\n" - "\n" - " :arg first: The first number.\n" - " :type first: int\n" - " :arg second: The second number.\n" - " :type second: int\n" - "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy constructor.\n" - "\n" - " :arg brother: An Id object.\n" - " :type brother: :class:`Id`"); +PyDoc_STRVAR( + Id_doc, + "Class for representing an object Id.\n" + "\n" + ".. method:: __init__(brother)\n" + " __init__(first=0, second=0)\n" + "\n" + " Build the Id from two numbers or another :class:`Id` using the copy constructor.\n" + "\n" + " :arg brother: An Id object.\n" + " :type brother: :class:`Id`" + " :arg first: The first number.\n" + " :type first: int\n" + " :arg second: The second number.\n" + " :type second: int\n"); static int Id_init(BPy_Id *self, PyObject *args, PyObject *kwds) { diff --git a/source/blender/freestyle/intern/python/BPy_Operators.cpp b/source/blender/freestyle/intern/python/BPy_Operators.cpp index 56f95b8ecbb..1235786d5d3 100644 --- a/source/blender/freestyle/intern/python/BPy_Operators.cpp +++ b/source/blender/freestyle/intern/python/BPy_Operators.cpp @@ -101,6 +101,7 @@ static PyObject *Operators_select(BPy_Operators * /*self*/, PyObject *args, PyOb PyDoc_STRVAR(Operators_chain_doc, ".. staticmethod:: chain(it, pred, modifier)\n" + " chain(it, pred)\n" "\n" " Builds a set of chains from the current set of ViewEdges. Each\n" " ViewEdge of the current list starts a new chain. The chaining\n" @@ -116,28 +117,9 @@ PyDoc_STRVAR(Operators_chain_doc, " :type pred: :class:`UnaryPredicate1D`\n" " :arg modifier: A function that takes a ViewEdge as argument and\n" " that is used to modify the processed ViewEdge state (the\n" - " timestamp incrementation is a typical illustration of such a\n" - " modifier).\n" - " :type modifier: :class:`UnaryFunction1DVoid`\n" - "\n" - ".. staticmethod:: chain(it, pred)\n" - "\n" - " Builds a set of chains from the current set of ViewEdges. Each\n" - " ViewEdge of the current list starts a new chain. The chaining\n" - " operator then iterates over the ViewEdges of the ViewMap using the\n" - " user specified iterator. This operator only iterates using the\n" - " increment operator and is therefore unidirectional. This chaining\n" - " operator is different from the previous one because it doesn't take\n" - " any modifier as argument. Indeed, the time stamp (insuring that a\n" - " ViewEdge is processed one time) is automatically managed in this\n" - " case.\n" - "\n" - " :arg it: The iterator on the ViewEdges of the ViewMap. It contains\n" - " the chaining rule. \n" - " :type it: :class:`ViewEdgeIterator`\n" - " :arg pred: The predicate on the ViewEdge that expresses the\n" - " stopping condition.\n" - " :type pred: :class:`UnaryPredicate1D`"); + " timestamp incrementation is a typical illustration of such a modifier).\n" + " If this argument is not given, the time stamp is automatically managed.\n" + " :type modifier: :class:`UnaryFunction1DVoid`\n"); static PyObject *Operators_chain(BPy_Operators * /*self*/, PyObject *args, PyObject *kwds) { @@ -195,6 +177,7 @@ static PyObject *Operators_chain(BPy_Operators * /*self*/, PyObject *args, PyObj PyDoc_STRVAR(Operators_bidirectional_chain_doc, ".. staticmethod:: bidirectional_chain(it, pred)\n" + " bidirectional_chain(it)\n" "\n" " Builds a set of chains from the current set of ViewEdges. Each\n" " ViewEdge of the current list potentially starts a new chain. The\n" @@ -211,30 +194,10 @@ PyDoc_STRVAR(Operators_bidirectional_chain_doc, " :arg it: The ChainingIterator on the ViewEdges of the ViewMap. It\n" " contains the chaining rule.\n" " :type it: :class:`ChainingIterator`\n" - " :arg pred: The predicate on the ViewEdge that expresses the\n" - " stopping condition.\n" - " :type pred: :class:`UnaryPredicate1D`\n" - "\n" - ".. staticmethod:: bidirectional_chain(it)\n" - "\n" - " The only difference with the above bidirectional chaining algorithm\n" - " is that we don't need to pass a stopping criterion. This might be\n" - " desirable when the stopping criterion is already contained in the\n" - " iterator definition. Builds a set of chains from the current set of\n" - " ViewEdges. Each ViewEdge of the current list potentially starts a new\n" - " chain. The chaining operator then iterates over the ViewEdges of the\n" - " ViewMap using the user specified iterator. This operator iterates\n" - " both using the increment and decrement operators and is therefore\n" - " bidirectional. This operator works with a ChainingIterator which\n" - " contains the chaining rules. It is this last one which can be told to\n" - " chain only edges that belong to the selection or not to process twice\n" - " a ViewEdge during the chaining. Each time a ViewEdge is added to a\n" - " chain, its chaining time stamp is incremented. This allows you to\n" - " keep track of the number of chains to which a ViewEdge belongs to.\n" - "\n" - " :arg it: The ChainingIterator on the ViewEdges of the ViewMap. It\n" - " contains the chaining rule.\n" - " :type it: :class:`ChainingIterator`"); + " :arg pred: The predicate on the ViewEdge that expresses the stopping condition.\n" + " This parameter is optional, you make not want to pass a stopping criterion\n" + " when the stopping criterion is already contained in the iterator definition.\n" + " :type pred: :class:`UnaryPredicate1D`\n"); static PyObject *Operators_bidirectional_chain(BPy_Operators * /*self*/, PyObject *args, @@ -287,44 +250,34 @@ static PyObject *Operators_bidirectional_chain(BPy_Operators * /*self*/, PyDoc_STRVAR(Operators_sequential_split_doc, ".. staticmethod:: sequential_split(starting_pred, stopping_pred, sampling=0.0)\n" + " sequential_split(pred, sampling=0.0)\n" "\n" " Splits each chain of the current set of chains in a sequential way.\n" " The points of each chain are processed (with a specified sampling)\n" - " sequentially. Each time a user specified starting condition is\n" - " verified, a new chain begins and ends as soon as a user-defined\n" - " stopping predicate is verified. This allows chains overlapping rather\n" - " than chains partitioning. The first point of the initial chain is the\n" + " sequentially. The first point of the initial chain is the\n" " first point of one of the resulting chains. The splitting ends when\n" " no more chain can start.\n" "\n" + " .. tip::\n" + "\n" + " By specifiying a starting and stopping predicate allows\n" + " the chains to overlapp rather than chains partitioning.\n" + "\n" " :arg starting_pred: The predicate on a point that expresses the\n" - " starting condition.\n" + " starting condition. Each time this condition is verified, a new chain begins\n" " :type starting_pred: :class:`UnaryPredicate0D`\n" " :arg stopping_pred: The predicate on a point that expresses the\n" - " stopping condition.\n" + " stopping condition. The chain ends as soon as this predicate is verified.\n" " :type stopping_pred: :class:`UnaryPredicate0D`\n" + " :arg pred: The predicate on a point that expresses the splitting condition.\n" + " Each time the condition is verified, the chain is split into two chains.\n" + " The resulting set of chains is a partition of the initial chain\n" + " :type pred: :class:`UnaryPredicate0D`\n" " :arg sampling: The resolution used to sample the chain for the\n" " predicates evaluation. (The chain is not actually resampled;\n" " a virtual point only progresses along the curve using this\n" " resolution.)\n" - " :type sampling: float\n" - "\n" - ".. staticmethod:: sequential_split(pred, sampling=0.0)\n" - "\n" - " Splits each chain of the current set of chains in a sequential way.\n" - " The points of each chain are processed (with a specified sampling)\n" - " sequentially and each time a user specified condition is verified,\n" - " the chain is split into two chains. The resulting set of chains is a\n" - " partition of the initial chain\n" - "\n" - " :arg pred: The predicate on a point that expresses the splitting\n" - " condition.\n" - " :type pred: :class:`UnaryPredicate0D`\n" - " :arg sampling: The resolution used to sample the chain for the\n" - " predicate evaluation. (The chain is not actually resampled; a\n" - " virtual point only progresses along the curve using this\n" - " resolution.)\n" - " :type sampling: float"); + " :type sampling: float\n"); static PyObject *Operators_sequential_split(BPy_Operators * /*self*/, PyObject *args, @@ -389,61 +342,41 @@ static PyObject *Operators_sequential_split(BPy_Operators * /*self*/, Py_RETURN_NONE; } -PyDoc_STRVAR(Operators_recursive_split_doc, - ".. staticmethod:: recursive_split(func, pred_1d, sampling=0.0)\n" - "\n" - " Splits the current set of chains in a recursive way. We process the\n" - " points of each chain (with a specified sampling) to find the point\n" - " minimizing a specified function. The chain is split in two at this\n" - " point and the two new chains are processed in the same way. The\n" - " recursivity level is controlled through a predicate 1D that expresses\n" - " a stopping condition on the chain that is about to be processed.\n" - "\n" - " :arg func: The Unary Function evaluated at each point of the chain.\n" - " The splitting point is the point minimizing this function.\n" - " :type func: :class:`UnaryFunction0DDouble`\n" - " :arg pred_1d: The Unary Predicate expressing the recursivity stopping\n" - " condition. This predicate is evaluated for each curve before it\n" - " actually gets split. If pred_1d(chain) is true, the curve won't be\n" - " split anymore.\n" - " :type pred_1d: :class:`UnaryPredicate1D`\n" - " :arg sampling: The resolution used to sample the chain for the\n" - " predicates evaluation. (The chain is not actually resampled, a\n" - " virtual point only progresses along the curve using this\n" - " resolution.)\n" - " :type sampling: float\n" - "\n" - ".. staticmethod:: recursive_split(func, pred_0d, pred_1d, sampling=0.0)\n" - "\n" - " Splits the current set of chains in a recursive way. We process the\n" - " points of each chain (with a specified sampling) to find the point\n" - " minimizing a specified function. The chain is split in two at this\n" - " point and the two new chains are processed in the same way. The user\n" - " can specify a 0D predicate to make a first selection on the points\n" - " that can potentially be split. A point that doesn't verify the 0D\n" - " predicate won't be candidate in realizing the min. The recursivity\n" - " level is controlled through a predicate 1D that expresses a stopping\n" - " condition on the chain that is about to be processed.\n" - "\n" - " :arg func: The Unary Function evaluated at each point of the chain.\n" - " The splitting point is the point minimizing this function.\n" - " :type func: :class:`UnaryFunction0DDouble`\n" - " :arg pred_0d: The Unary Predicate 0D used to select the candidate\n" - " points where the split can occur. For example, it is very likely\n" - " that would rather have your chain splitting around its middle\n" - " point than around one of its extremities. A 0D predicate working\n" - " on the curvilinear abscissa allows to add this kind of constraints.\n" - " :type pred_0d: :class:`UnaryPredicate0D`\n" - " :arg pred_1d: The Unary Predicate expressing the recursivity stopping\n" - " condition. This predicate is evaluated for each curve before it\n" - " actually gets split. If pred_1d(chain) is true, the curve won't be\n" - " split anymore.\n" - " :type pred_1d: :class:`UnaryPredicate1D`\n" - " :arg sampling: The resolution used to sample the chain for the\n" - " predicates evaluation. (The chain is not actually resampled; a\n" - " virtual point only progresses along the curve using this\n" - " resolution.)\n" - " :type sampling: float"); +PyDoc_STRVAR( + Operators_recursive_split_doc, + ".. staticmethod:: recursive_split(func, pred_1d, sampling=0.0)\n" + " recursive_split(func, pred_0d, pred_1d, sampling=0.0)\n" + "\n" + " Splits the current set of chains in a recursive way. We process the\n" + " points of each chain (with a specified sampling) to find the point\n" + " minimizing a specified function. The chain is split in two at this\n" + " point and the two new chains are processed in the same way. The\n" + " recursivity level is controlled through a predicate 1D that expresses\n" + " a stopping condition on the chain that is about to be processed.\n" + "\n" + " The user can also specify a 0D predicate to make a first selection on the points\n" + " that can potentially be split. A point that doesn't verify the 0D\n" + " predicate won't be candidate in realizing the min.\n" + "\n" + " :arg func: The Unary Function evaluated at each point of the chain.\n" + " The splitting point is the point minimizing this function.\n" + " :type func: :class:`UnaryFunction0DDouble`\n" + " :arg pred_0d: The Unary Predicate 0D used to select the candidate\n" + " points where the split can occur. For example, it is very likely\n" + " that would rather have your chain splitting around its middle\n" + " point than around one of its extremities. A 0D predicate working\n" + " on the curvilinear abscissa allows to add this kind of constraints.\n" + " :type pred_0d: :class:`UnaryPredicate0D`\n" + " :arg pred_1d: The Unary Predicate expressing the recursivity stopping\n" + " condition. This predicate is evaluated for each curve before it\n" + " actually gets split. If pred_1d(chain) is true, the curve won't be\n" + " split anymore.\n" + " :type pred_1d: :class:`UnaryPredicate1D`\n" + " :arg sampling: The resolution used to sample the chain for the\n" + " predicates evaluation. (The chain is not actually resampled; a\n" + " virtual point only progresses along the curve using this\n" + " resolution.)\n" + " :type sampling: float\n"); static PyObject *Operators_recursive_split(BPy_Operators * /*self*/, PyObject *args, diff --git a/source/blender/freestyle/intern/python/BPy_SShape.cpp b/source/blender/freestyle/intern/python/BPy_SShape.cpp index 9712dccfa5e..b1d5f8f4aac 100644 --- a/source/blender/freestyle/intern/python/BPy_SShape.cpp +++ b/source/blender/freestyle/intern/python/BPy_SShape.cpp @@ -50,20 +50,18 @@ int SShape_Init(PyObject *module) /*----------------------SShape methods ----------------------------*/ -PyDoc_STRVAR(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__(brother)\n" - "\n" - " Copy constructor.\n" - "\n" - " :arg brother: An SShape object.\n" - " :type brother: :class:`SShape`"); +PyDoc_STRVAR( + 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" + " __init__(brother)\n" + "\n" + " Creates a :class:`SShape` class using either a default constructor or copy constructor.\n" + "\n" + " :arg brother: An SShape object.\n" + " :type brother: :class:`SShape`"); static int SShape_init(BPy_SShape *self, PyObject *args, PyObject *kwds) { diff --git a/source/blender/freestyle/intern/python/BPy_StrokeAttribute.cpp b/source/blender/freestyle/intern/python/BPy_StrokeAttribute.cpp index 214385f74ad..3718fddcf20 100644 --- a/source/blender/freestyle/intern/python/BPy_StrokeAttribute.cpp +++ b/source/blender/freestyle/intern/python/BPy_StrokeAttribute.cpp @@ -53,20 +53,16 @@ PyDoc_STRVAR(StrokeAttribute_doc, "Vertex.\n" "\n" ".. method:: __init__()\n" + " __init__(brother)\n" + " __init__(red, green, blue, alpha, thickness_right, thickness_left)\n" + " __init__(attribute1, attribute2, t)\n" "\n" - " Default constructor.\n" + " Creates a :class:`StrokeAttribute` object using either a default constructor,\n" + " copy constructor, overloaded constructor, or and interpolation constructor\n" + " to interpolate between two :class:`StrokeAttribute` objects.\n" "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy constructor.\n" - "\n" - " :arg brother: A StrokeAttribute object.\n" + " :arg brother: A StrokeAttribute object to be used as a copy constructor.\n" " :type brother: :class:`StrokeAttribute`\n" - "\n" - ".. method:: __init__(red, green, blue, alpha, thickness_right, thickness_left)\n" - "\n" - " Build a stroke vertex attribute from a set of parameters.\n" - "\n" " :arg red: Red component of a stroke color.\n" " :type red: float\n" " :arg green: Green component of a stroke color.\n" @@ -79,12 +75,6 @@ PyDoc_STRVAR(StrokeAttribute_doc, " :type thickness_right: float\n" " :arg thickness_left: Stroke thickness on the left.\n" " :type thickness_left: float\n" - "\n" - ".. method:: __init__(attribute1, attribute2, t)\n" - "\n" - " Interpolation constructor. Build a StrokeAttribute from two\n" - " StrokeAttribute objects and an interpolation parameter.\n" - "\n" " :arg attribute1: The first StrokeAttribute object.\n" " :type attribute1: :class:`StrokeAttribute`\n" " :arg attribute2: The second StrokeAttribute object.\n" diff --git a/source/blender/freestyle/intern/python/BPy_ViewShape.cpp b/source/blender/freestyle/intern/python/BPy_ViewShape.cpp index 2adcae13e6d..7d8b5ef6fa9 100644 --- a/source/blender/freestyle/intern/python/BPy_ViewShape.cpp +++ b/source/blender/freestyle/intern/python/BPy_ViewShape.cpp @@ -55,20 +55,14 @@ PyDoc_STRVAR(ViewShape_doc, "and :class:`ViewEdge`) that are issued from the same input shape.\n" "\n" ".. method:: __init__()\n" + " __init__(brother)\n" + " __init__(sshape)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy constructor.\n" + " Builds a :class:`ViewShape` using the default constructor,\n" + " copy constructor, or from a :class:`SShape`.\n" "\n" " :arg brother: A ViewShape object.\n" " :type brother: :class:`ViewShape`\n" - "\n" - ".. method:: __init__(sshape)\n" - "\n" - " Builds a ViewShape from an SShape.\n" - "\n" " :arg sshape: An SShape object.\n" " :type sshape: :class:`SShape`"); diff --git a/source/blender/freestyle/intern/python/Interface0D/BPy_CurvePoint.cpp b/source/blender/freestyle/intern/python/Interface0D/BPy_CurvePoint.cpp index 81dd79ff270..7b3571c479f 100644 --- a/source/blender/freestyle/intern/python/Interface0D/BPy_CurvePoint.cpp +++ b/source/blender/freestyle/intern/python/Interface0D/BPy_CurvePoint.cpp @@ -44,40 +44,28 @@ PyDoc_STRVAR(CurvePoint_doc, "given resolution.\n" "\n" ".. method:: __init__()\n" + " __init__(brother)\n" + " __init__(first_vertex, second_vertex, t2d)\n" + " __init__(first_point, second_point, t2d)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy constructor.\n" + " Builds a CurvePoint using the default constructor, copy constructor,\n" + " or one of the overloaded constructors. The over loaded constructors\n" + " can either take two :class:`SVertex` or two :class:`CurvePoint`\n" + " objects and an interpolation parameter\n" "\n" " :arg brother: A CurvePoint object.\n" " :type brother: :class:`CurvePoint`\n" - "\n" - ".. method:: __init__(first_vertex, second_vertex, t2d)\n" - "\n" - " Builds a CurvePoint from two SVertex objects and an interpolation parameter.\n" - "\n" " :arg first_vertex: The first SVertex.\n" " :type first_vertex: :class:`SVertex`\n" " :arg second_vertex: The second SVertex.\n" " :type second_vertex: :class:`SVertex`\n" - " :arg t2d: A 2D interpolation parameter used to linearly interpolate\n" - " first_vertex and second_vertex.\n" - " :type t2d: float\n" - "\n" - ".. method:: __init__(first_point, second_point, t2d)\n" - "\n" - " Builds a CurvePoint from two CurvePoint objects and an interpolation\n" - " parameter.\n" - "\n" " :arg first_point: The first CurvePoint.\n" " :type first_point: :class:`CurvePoint`\n" " :arg second_point: The second CurvePoint.\n" " :type second_point: :class:`CurvePoint`\n" - " :arg t2d: The 2D interpolation parameter used to linearly interpolate\n" - " first_point and second_point.\n" - " :type t2d: float"); + " :arg t2d: A 2D interpolation parameter used to linearly interpolate\n" + " first_vertex and second_vertex or first_point and second_point.\n" + " :type t2d: float\n"); static int CurvePoint_init(BPy_CurvePoint *self, PyObject *args, PyObject *kwds) { diff --git a/source/blender/freestyle/intern/python/Interface0D/BPy_SVertex.cpp b/source/blender/freestyle/intern/python/Interface0D/BPy_SVertex.cpp index c01f1f17000..63725c6b0e8 100644 --- a/source/blender/freestyle/intern/python/Interface0D/BPy_SVertex.cpp +++ b/source/blender/freestyle/intern/python/Interface0D/BPy_SVertex.cpp @@ -38,20 +38,15 @@ PyDoc_STRVAR(SVertex_doc, "Class to define a vertex of the embedding.\n" "\n" ".. method:: __init__()\n" + " __init__(brother)\n" + " __init__(point_3d, id)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy constructor.\n" + " Builds a :class:`SVertex` using the default constructor,\n" + " copy constructor or the overloaded constructor which builds" + " a :class:`SVertex` from 3D coordinates and an Id.\n" "\n" " :arg brother: A SVertex object.\n" " :type brother: :class:`SVertex`\n" - "\n" - ".. method:: __init__(point_3d, id)\n" - "\n" - " Builds a SVertex from 3D coordinates and an Id.\n" - "\n" " :arg point_3d: A three-dimensional vector.\n" " :type point_3d: :class:`mathutils.Vector`\n" " :arg id: An Id object.\n" diff --git a/source/blender/freestyle/intern/python/Interface0D/CurvePoint/BPy_StrokeVertex.cpp b/source/blender/freestyle/intern/python/Interface0D/CurvePoint/BPy_StrokeVertex.cpp index 519bd72db3b..5c1a8f8482f 100644 --- a/source/blender/freestyle/intern/python/Interface0D/CurvePoint/BPy_StrokeVertex.cpp +++ b/source/blender/freestyle/intern/python/Interface0D/CurvePoint/BPy_StrokeVertex.cpp @@ -40,46 +40,29 @@ PyDoc_STRVAR( "Class to define a stroke vertex.\n" "\n" ".. method:: __init__()\n" + " __init__(brother)\n" + " __init__(first_vertex, second_vertex, t3d)\n" + " __init__(point)\n" + " __init__(svertex)\n" + " __init__(svertex, attribute)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy constructor.\n" + " Builds a :class:`StrokeVertex` using the default constructor,\n" + " copy constructor, from 2 :class:`StrokeVertex` and an interpolation parameter,\n" + " from a CurvePoint, from a SVertex, or a :class:`SVertex`" + " and a :class:`StrokeAttribute` object.\n" "\n" " :arg brother: A StrokeVertex object.\n" " :type brother: :class:`StrokeVertex`\n" - "\n" - ".. method:: __init__(first_vertex, second_vertex, t3d)\n" - "\n" - " Build a stroke vertex from 2 stroke vertices and an interpolation\n" - " parameter.\n" - "\n" " :arg first_vertex: The first StrokeVertex.\n" " :type first_vertex: :class:`StrokeVertex`\n" " :arg second_vertex: The second StrokeVertex.\n" " :type second_vertex: :class:`StrokeVertex`\n" " :arg t3d: An interpolation parameter.\n" " :type t3d: float\n" - "\n" - ".. method:: __init__(point)\n" - "\n" - " Build a stroke vertex from a CurvePoint\n" - "\n" " :arg point: A CurvePoint object.\n" " :type point: :class:`CurvePoint`\n" - "\n" - ".. method:: __init__(svertex)\n" - "\n" - " Build a stroke vertex from a SVertex\n" - "\n" " :arg svertex: An SVertex object.\n" " :type svertex: :class:`SVertex`\n" - "\n" - ".. method:: __init__(svertex, attribute)\n" - "\n" - " Build a stroke vertex from an SVertex and a StrokeAttribute object.\n" - "\n" " :arg svertex: An SVertex object.\n" " :type svertex: :class:`SVertex`\n" " :arg attribute: A StrokeAttribute object.\n" diff --git a/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_NonTVertex.cpp b/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_NonTVertex.cpp index 9295e4f424b..ff53f5bfcbe 100644 --- a/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_NonTVertex.cpp +++ b/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_NonTVertex.cpp @@ -31,22 +31,20 @@ extern "C" { /*----------------------NonTVertex methods ----------------------------*/ -PyDoc_STRVAR(NonTVertex_doc, - "Class hierarchy: :class:`Interface0D` > :class:`ViewVertex` > :class:`NonTVertex`\n" - "\n" - "View vertex for corners, cusps, etc. associated to a single SVertex.\n" - "Can be associated to 2 or more view edges.\n" - "\n" - ".. method:: __init__()\n" - "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(svertex)\n" - "\n" - " Build a NonTVertex from a SVertex.\n" - "\n" - " :arg svertex: An SVertex object.\n" - " :type svertex: :class:`SVertex`"); +PyDoc_STRVAR( + NonTVertex_doc, + "Class hierarchy: :class:`Interface0D` > :class:`ViewVertex` > :class:`NonTVertex`\n" + "\n" + "View vertex for corners, cusps, etc. associated to a single SVertex.\n" + "Can be associated to 2 or more view edges.\n" + "\n" + ".. method:: __init__()\n" + " __init__(svertex)\n" + "\n" + " Builds a :class:`NonTVertex` using the default constructor or a :class:`SVertex`.\n" + "\n" + " :arg svertex: An SVertex object.\n" + " :type svertex: :class:`SVertex`"); /* Note: No copy constructor in Python because the C++ copy constructor is 'protected'. */ diff --git a/source/blender/freestyle/intern/python/Interface1D/BPy_FEdge.cpp b/source/blender/freestyle/intern/python/Interface1D/BPy_FEdge.cpp index 187ab94360a..e04a89bad3b 100644 --- a/source/blender/freestyle/intern/python/Interface1D/BPy_FEdge.cpp +++ b/source/blender/freestyle/intern/python/Interface1D/BPy_FEdge.cpp @@ -48,20 +48,13 @@ PyDoc_STRVAR(FEdge_doc, "from one to the other.\n" "\n" ".. method:: FEdge()\n" + " FEdge(brother)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: FEdge(brother)\n" - "\n" - " Copy constructor.\n" + " Builds an :class:`FEdge` using the default constructor,\n" + " copy constructor, or between two :class:`SVertex` objects.\n" "\n" " :arg brother: An FEdge object.\n" " :type brother: :class:`FEdge`\n" - "\n" - ".. method:: FEdge(first_vertex, second_vertex)\n" - "\n" - " Builds an FEdge going from the first vertex to the second.\n" - "\n" " :arg first_vertex: The first SVertex.\n" " :type first_vertex: :class:`SVertex`\n" " :arg second_vertex: The second SVertex.\n" diff --git a/source/blender/freestyle/intern/python/Interface1D/BPy_FrsCurve.cpp b/source/blender/freestyle/intern/python/Interface1D/BPy_FrsCurve.cpp index 788dfa78992..78c0ee051d6 100644 --- a/source/blender/freestyle/intern/python/Interface1D/BPy_FrsCurve.cpp +++ b/source/blender/freestyle/intern/python/Interface1D/BPy_FrsCurve.cpp @@ -41,20 +41,14 @@ PyDoc_STRVAR(FrsCurve_doc, "specialization of a Curve.\n" "\n" ".. method:: __init__()\n" + " __init__(brother)\n" + " __init__(id)\n" "\n" - " Default Constructor.\n" - "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy Constructor.\n" + " Builds a :class:`FrsCurve` using a default constructor,\n" + " copy constructor or from an :class:`Id`.\n" "\n" " :arg brother: A Curve object.\n" " :type brother: :class:`Curve`\n" - "\n" - ".. method:: __init__(id)\n" - "\n" - " Builds a Curve from its Id.\n" - "\n" " :arg id: An Id object.\n" " :type id: :class:`Id`"); diff --git a/source/blender/freestyle/intern/python/Interface1D/BPy_Stroke.cpp b/source/blender/freestyle/intern/python/Interface1D/BPy_Stroke.cpp index b31efe1f923..910f9cdfa07 100644 --- a/source/blender/freestyle/intern/python/Interface1D/BPy_Stroke.cpp +++ b/source/blender/freestyle/intern/python/Interface1D/BPy_Stroke.cpp @@ -50,12 +50,9 @@ PyDoc_STRVAR(Stroke_doc, "defines the stroke's shape and appearance at this vertex position.\n" "\n" ".. method:: Stroke()\n" + " Stroke(brother)\n" "\n" - " Default constructor\n" - "\n" - ".. method:: Stroke(brother)\n" - "\n" - " Copy constructor"); + " Creates a :class:`Stroke` using the default constructor or copy constructor\n"); static int Stroke_init(BPy_Stroke *self, PyObject *args, PyObject *kwds) { @@ -127,21 +124,18 @@ static PyObject *Stroke_compute_sampling(BPy_Stroke *self, PyObject *args, PyObj PyDoc_STRVAR(Stroke_resample_doc, ".. method:: resample(n)\n" + " resample(sampling)\n" "\n" - " Resamples the stroke so that it eventually has N points. That means\n" - " it is going to add N-vertices_size, where vertices_size is the\n" - " number of points we already have. If vertices_size >= N, no\n" - " resampling is done.\n" + " Resamples the stroke so using one of two methods with the goal\n" + " of creating a stroke with fewer points and the same shape.\n" "\n" - " :arg n: The number of vertices we eventually want in our stroke.\n" + " :arg n: Resamples the stroke so that it eventually has N points. That means\n" + " it is going to add N-vertices_size, where vertices_size is the\n" + " number of points we already have. If vertices_size >= N, no\n" + " resampling is done.\n" " :type n: int\n" - "\n" - ".. method:: resample(sampling)\n" - "\n" - " Resamples the stroke with a given sampling. If the sampling is\n" - " smaller than the actual sampling value, no resampling is done.\n" - "\n" - " :arg sampling: The new sampling value.\n" + " :arg sampling: Resamples the stroke with a given sampling value. If the\n" + " sampling is smaller than the actual sampling value, no resampling is done.\n" " :type sampling: float"); static PyObject *Stroke_resample(BPy_Stroke *self, PyObject *args, PyObject *kwds) diff --git a/source/blender/freestyle/intern/python/Interface1D/BPy_ViewEdge.cpp b/source/blender/freestyle/intern/python/Interface1D/BPy_ViewEdge.cpp index 58c2ba69c79..e9160d7a5c7 100644 --- a/source/blender/freestyle/intern/python/Interface1D/BPy_ViewEdge.cpp +++ b/source/blender/freestyle/intern/python/Interface1D/BPy_ViewEdge.cpp @@ -36,23 +36,21 @@ extern "C" { /*----------------------ViewEdge methods ----------------------------*/ -PyDoc_STRVAR(ViewEdge_doc, - "Class hierarchy: :class:`Interface1D` > :class:`ViewEdge`\n" - "\n" - "Class defining a ViewEdge. A ViewEdge in an edge of the image graph.\n" - "it connects two :class:`ViewVertex` objects. It is made by connecting\n" - "a set of FEdges.\n" - "\n" - ".. method:: __init__()\n" - "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy constructor.\n" - "\n" - " :arg brother: A ViewEdge object.\n" - " :type brother: :class:`ViewEdge`"); +PyDoc_STRVAR( + ViewEdge_doc, + "Class hierarchy: :class:`Interface1D` > :class:`ViewEdge`\n" + "\n" + "Class defining a ViewEdge. A ViewEdge in an edge of the image graph.\n" + "it connects two :class:`ViewVertex` objects. It is made by connecting\n" + "a set of FEdges.\n" + "\n" + ".. method:: __init__()\n" + " __init__(brother)\n" + "\n" + " Builds a :class:`ViewEdge` using the default constructor or the copy constructor.\n" + "\n" + " :arg brother: A ViewEdge object.\n" + " :type brother: :class:`ViewEdge`"); static int ViewEdge_init(BPy_ViewEdge *self, PyObject *args, PyObject *kwds) { diff --git a/source/blender/freestyle/intern/python/Interface1D/Curve/BPy_Chain.cpp b/source/blender/freestyle/intern/python/Interface1D/Curve/BPy_Chain.cpp index 9cdc344081e..028e36145b9 100644 --- a/source/blender/freestyle/intern/python/Interface1D/Curve/BPy_Chain.cpp +++ b/source/blender/freestyle/intern/python/Interface1D/Curve/BPy_Chain.cpp @@ -40,20 +40,14 @@ PyDoc_STRVAR(Chain_doc, "Splitting and Creation processes.\n" "\n" ".. method:: __init__()\n" + " __init__(brother)\n" + " __init__(id)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy constructor.\n" + " Builds a :class:`Chain` using the default constructor,\n" + " copy constructor or from an :class:`Id`.\n" "\n" " :arg brother: A Chain object.\n" " :type brother: :class:`Chain`\n" - "\n" - ".. method:: __init__(id)\n" - "\n" - " Builds a chain from its Id.\n" - "\n" " :arg id: An Id object.\n" " :type id: :class:`Id`"); diff --git a/source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSharp.cpp b/source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSharp.cpp index c329a3badd5..018e0449552 100644 --- a/source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSharp.cpp +++ b/source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSharp.cpp @@ -42,20 +42,14 @@ PyDoc_STRVAR(FEdgeSharp_doc, "a is None.\n" "\n" ".. method:: __init__()\n" + " __init__(brother)\n" + " __init__(first_vertex, second_vertex)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy constructor.\n" + " Builds an :class:`FEdgeSharp` using the default constructor,\n" + " copy constructor, or between two :class:`SVertex` objects.\n" "\n" " :arg brother: An FEdgeSharp object.\n" " :type brother: :class:`FEdgeSharp`\n" - "\n" - ".. method:: __init__(first_vertex, second_vertex)\n" - "\n" - " Builds an FEdgeSharp going from the first vertex to the second.\n" - "\n" " :arg first_vertex: The first SVertex object.\n" " :type first_vertex: :class:`SVertex`\n" " :arg second_vertex: The second SVertex object.\n" diff --git a/source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSmooth.cpp b/source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSmooth.cpp index 3fb739b18db..014f0411356 100644 --- a/source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSmooth.cpp +++ b/source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSmooth.cpp @@ -39,20 +39,14 @@ PyDoc_STRVAR(FEdgeSmooth_doc, "a suggestive contour.\n" "\n" ".. method:: __init__()\n" + " __init__(brother)\n" + " __init__(first_vertex, second_vertex)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy constructor.\n" + " Builds an :class:`FEdgeSmooth` using the default constructor,\n" + " copy constructor, or between two :class:`SVertex`.\n" "\n" " :arg brother: An FEdgeSmooth object.\n" " :type brother: :class:`FEdgeSmooth`\n" - "\n" - ".. method:: __init__(first_vertex, second_vertex)\n" - "\n" - " Builds an FEdgeSmooth going from the first to the second.\n" - "\n" " :arg first_vertex: The first SVertex object.\n" " :type first_vertex: :class:`SVertex`\n" " :arg second_vertex: The second SVertex object.\n" diff --git a/source/blender/freestyle/intern/python/Iterator/BPy_AdjacencyIterator.cpp b/source/blender/freestyle/intern/python/Iterator/BPy_AdjacencyIterator.cpp index 90e751333b9..dc32b73fda1 100644 --- a/source/blender/freestyle/intern/python/Iterator/BPy_AdjacencyIterator.cpp +++ b/source/blender/freestyle/intern/python/Iterator/BPy_AdjacencyIterator.cpp @@ -41,20 +41,14 @@ PyDoc_STRVAR( "traverse() method of the ChainingIterator.\n" "\n" ".. method:: __init__()\n" + " __init__(brother)\n" + " __init__(vertex, restrict_to_selection=True, restrict_to_unvisited=True)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy constructor.\n" + " Builds an :class:`AdjacencyIterator` using the default constructor,\n" + " copy constructor or the overloaded constructor.\n" "\n" " :arg brother: An AdjacencyIterator object.\n" " :type brother: :class:`AdjacencyIterator`\n" - "\n" - ".. method:: __init__(vertex, restrict_to_selection=True, restrict_to_unvisited=True)\n" - "\n" - " Builds a AdjacencyIterator object.\n" - "\n" " :arg vertex: The vertex which is the next crossing.\n" " :type vertex: :class:`ViewVertex`\n" " :arg restrict_to_selection: Indicates whether to force the chaining\n" diff --git a/source/blender/freestyle/intern/python/Iterator/BPy_ChainPredicateIterator.cpp b/source/blender/freestyle/intern/python/Iterator/BPy_ChainPredicateIterator.cpp index 1703fc2bddb..9c534a3463c 100644 --- a/source/blender/freestyle/intern/python/Iterator/BPy_ChainPredicateIterator.cpp +++ b/source/blender/freestyle/intern/python/Iterator/BPy_ChainPredicateIterator.cpp @@ -33,55 +33,52 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- -PyDoc_STRVAR(ChainPredicateIterator_doc, - - "Class hierarchy: :class:`freestyle.types.Iterator` >\n" - ":class:`freestyle.types.ViewEdgeIterator` >\n" - ":class:`freestyle.types.ChainingIterator` >\n" - ":class:`ChainPredicateIterator`\n" - "\n" - "A \"generic\" user-controlled ViewEdge iterator. This iterator is in\n" - "particular built from a unary predicate and a binary predicate.\n" - "First, the unary predicate is evaluated for all potential next\n" - "ViewEdges in order to only keep the ones respecting a certain\n" - "constraint. Then, the binary predicate is evaluated on the current\n" - "ViewEdge together with each ViewEdge of the previous selection. The\n" - "first ViewEdge respecting both the unary predicate and the binary\n" - "predicate is kept as the next one. If none of the potential next\n" - "ViewEdge respects these two predicates, None is returned.\n" - "\n" - ".. method:: __init__(upred, bpred, restrict_to_selection=True, " - "restrict_to_unvisited=True, begin=None, " - "orientation=True)\n" - "\n" - " Builds a ChainPredicateIterator from a unary predicate, a binary\n" - " predicate, a starting ViewEdge and its orientation.\n" - "\n" - " :arg upred: The unary predicate that the next ViewEdge must satisfy.\n" - " :type upred: :class:`freestyle.types.UnaryPredicate1D`\n" - " :arg bpred: The binary predicate that the next ViewEdge must\n" - " satisfy together with the actual pointed ViewEdge.\n" - " :type bpred: :class:`freestyle.types.BinaryPredicate1D`\n" - " :arg restrict_to_selection: Indicates whether to force the chaining\n" - " to stay within the set of selected ViewEdges or not.\n" - " :type restrict_to_selection: bool\n" - " :arg restrict_to_unvisited: Indicates whether a ViewEdge that has\n" - " already been chained must be ignored ot not.\n" - " :type restrict_to_unvisited: bool\n" - " :arg begin: The ViewEdge from where to start the iteration.\n" - " :type begin: :class:`freestyle.types.ViewEdge` or None\n" - " :arg orientation: If true, we'll look for the next ViewEdge among\n" - " the ViewEdges that surround the ending ViewVertex of begin. If\n" - " false, we'll search over the ViewEdges surrounding the ending\n" - " ViewVertex of begin.\n" - " :type orientation: bool\n" - "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy constructor.\n" - "\n" - " :arg brother: A ChainPredicateIterator object.\n" - " :type brother: :class:`ChainPredicateIterator`"); +PyDoc_STRVAR( + ChainPredicateIterator_doc, + + "Class hierarchy: :class:`freestyle.types.Iterator` >\n" + ":class:`freestyle.types.ViewEdgeIterator` >\n" + ":class:`freestyle.types.ChainingIterator` >\n" + ":class:`ChainPredicateIterator`\n" + "\n" + "A \"generic\" user-controlled ViewEdge iterator. This iterator is in\n" + "particular built from a unary predicate and a binary predicate.\n" + "First, the unary predicate is evaluated for all potential next\n" + "ViewEdges in order to only keep the ones respecting a certain\n" + "constraint. Then, the binary predicate is evaluated on the current\n" + "ViewEdge together with each ViewEdge of the previous selection. The\n" + "first ViewEdge respecting both the unary predicate and the binary\n" + "predicate is kept as the next one. If none of the potential next\n" + "ViewEdge respects these two predicates, None is returned.\n" + "\n" + ".. method:: __init__(upred, bpred, restrict_to_selection=True, " + " restrict_to_unvisited=True, begin=None, " + " orientation=True)\n" + " __init__(brother)\n" + "\n" + " Builds a ChainPredicateIterator from a unary predicate, a binary\n" + " predicate, a starting ViewEdge and its orientation or using the copy constructor.\n" + "\n" + " :arg upred: The unary predicate that the next ViewEdge must satisfy.\n" + " :type upred: :class:`freestyle.types.UnaryPredicate1D`\n" + " :arg bpred: The binary predicate that the next ViewEdge must\n" + " satisfy together with the actual pointed ViewEdge.\n" + " :type bpred: :class:`freestyle.types.BinaryPredicate1D`\n" + " :arg restrict_to_selection: Indicates whether to force the chaining\n" + " to stay within the set of selected ViewEdges or not.\n" + " :type restrict_to_selection: bool\n" + " :arg restrict_to_unvisited: Indicates whether a ViewEdge that has\n" + " already been chained must be ignored ot not.\n" + " :type restrict_to_unvisited: bool\n" + " :arg begin: The ViewEdge from where to start the iteration.\n" + " :type begin: :class:`freestyle.types.ViewEdge` or None\n" + " :arg orientation: If true, we'll look for the next ViewEdge among\n" + " the ViewEdges that surround the ending ViewVertex of begin. If\n" + " false, we'll search over the ViewEdges surrounding the ending\n" + " ViewVertex of begin.\n" + " :type orientation: bool\n" + " :arg brother: A ChainPredicateIterator object.\n" + " :type brother: :class:`ChainPredicateIterator`"); static int check_begin(PyObject *obj, void *v) { diff --git a/source/blender/freestyle/intern/python/Iterator/BPy_ChainSilhouetteIterator.cpp b/source/blender/freestyle/intern/python/Iterator/BPy_ChainSilhouetteIterator.cpp index d8ad82d667c..9fa84d5f6b8 100644 --- a/source/blender/freestyle/intern/python/Iterator/BPy_ChainSilhouetteIterator.cpp +++ b/source/blender/freestyle/intern/python/Iterator/BPy_ChainSilhouetteIterator.cpp @@ -48,9 +48,10 @@ PyDoc_STRVAR(ChainSilhouetteIterator_doc, "precedence of the silhouette over the crease criterion.\n" "\n" ".. method:: __init__(restrict_to_selection=True, begin=None, orientation=True)\n" + " __init__(brother)\n" "\n" " Builds a ChainSilhouetteIterator from the first ViewEdge used for\n" - " iteration and its orientation.\n" + " iteration and its orientation or the copy constructor.\n" "\n" " :arg restrict_to_selection: Indicates whether to force the chaining\n" " to stay within the set of selected ViewEdges or not.\n" @@ -62,11 +63,6 @@ PyDoc_STRVAR(ChainSilhouetteIterator_doc, " false, we'll search over the ViewEdges surrounding the ending\n" " ViewVertex of begin.\n" " :type orientation: bool\n" - "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy constructor.\n" - "\n" " :arg brother: A ChainSilhouetteIterator object.\n" " :type brother: :class:`ChainSilhouetteIterator`"); diff --git a/source/blender/freestyle/intern/python/Iterator/BPy_ChainingIterator.cpp b/source/blender/freestyle/intern/python/Iterator/BPy_ChainingIterator.cpp index dbd6e8dd09d..d24e1dc527d 100644 --- a/source/blender/freestyle/intern/python/Iterator/BPy_ChainingIterator.cpp +++ b/source/blender/freestyle/intern/python/Iterator/BPy_ChainingIterator.cpp @@ -46,11 +46,12 @@ PyDoc_STRVAR( "they will be included in the adjacency iterator (i.e, the adjacent\n" "iterator will only stop on \"valid\" edges).\n" "\n" - ".. method:: __init__(restrict_to_selection=True, restrict_to_unvisited=True, begin=None, " - "orientation=True)\n" + ".. method:: __init__(restrict_to_selection=True, restrict_to_unvisited=True," + " begin=None, orientation=True)\n" + " __init__(brother)\n" "\n" " Builds a Chaining Iterator from the first ViewEdge used for\n" - " iteration and its orientation.\n" + " iteration and its orientation or by using the copy constructor.\n" "\n" " :arg restrict_to_selection: Indicates whether to force the chaining\n" " to stay within the set of selected ViewEdges or not.\n" @@ -63,11 +64,6 @@ PyDoc_STRVAR( " :arg orientation: The direction to follow to explore the graph. If\n" " true, the direction indicated by the first ViewEdge is used.\n" " :type orientation: bool\n" - "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy constructor.\n" - "\n" " :arg brother: \n" " :type brother: ChainingIterator"); diff --git a/source/blender/freestyle/intern/python/Iterator/BPy_CurvePointIterator.cpp b/source/blender/freestyle/intern/python/Iterator/BPy_CurvePointIterator.cpp index 6c496b0308b..8eac657316e 100644 --- a/source/blender/freestyle/intern/python/Iterator/BPy_CurvePointIterator.cpp +++ b/source/blender/freestyle/intern/python/Iterator/BPy_CurvePointIterator.cpp @@ -39,20 +39,14 @@ PyDoc_STRVAR(CurvePointIterator_doc, "through the .object attribute.\n" "\n" ".. method:: __init__()\n" + " __init__(brother)\n" + " __init__(step=0.0)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy constructor.\n" + " Builds a CurvePointIterator object using either the default constructor,\n" + " copy constructor, or the overloaded constructor.\n" "\n" " :arg brother: A CurvePointIterator object.\n" " :type brother: :class:`CurvePointIterator`\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" diff --git a/source/blender/freestyle/intern/python/Iterator/BPy_Interface0DIterator.cpp b/source/blender/freestyle/intern/python/Iterator/BPy_Interface0DIterator.cpp index 734ed0117f4..f7afc7695ae 100644 --- a/source/blender/freestyle/intern/python/Iterator/BPy_Interface0DIterator.cpp +++ b/source/blender/freestyle/intern/python/Iterator/BPy_Interface0DIterator.cpp @@ -38,17 +38,13 @@ PyDoc_STRVAR(Interface0DIterator_doc, "this iterator is always obtained from a 1D element.\n" "\n" ".. method:: __init__(brother)\n" + " __init__(it)\n" "\n" - " Copy constructor.\n" + " Construct a nested Interface0DIterator using either the copy constructor\n" + " or the constructor that takes an he argument of a Function0D.\n" "\n" " :arg brother: An Interface0DIterator object.\n" " :type brother: :class:`Interface0DIterator`\n" - "\n" - ".. method:: __init__(it)\n" - "\n" - " Construct a nested Interface0DIterator that can be the argument of\n" - " a Function0D.\n" - "\n" " :arg it: An iterator object to be nested.\n" " :type it: :class:`SVertexIterator`, :class:`CurvePointIterator`, or\n" " :class:`StrokeVertexIterator`"); diff --git a/source/blender/freestyle/intern/python/Iterator/BPy_SVertexIterator.cpp b/source/blender/freestyle/intern/python/Iterator/BPy_SVertexIterator.cpp index 4a5927ff6eb..83c504081c1 100644 --- a/source/blender/freestyle/intern/python/Iterator/BPy_SVertexIterator.cpp +++ b/source/blender/freestyle/intern/python/Iterator/BPy_SVertexIterator.cpp @@ -32,39 +32,33 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- -PyDoc_STRVAR(SVertexIterator_doc, - "Class hierarchy: :class:`Iterator` > :class:`SVertexIterator`\n" - "\n" - "Class representing an iterator over :class:`SVertex` of a\n" - ":class:`ViewEdge`. An instance of an SVertexIterator can be obtained\n" - "from a ViewEdge by calling verticesBegin() or verticesEnd().\n" - "\n" - ".. method:: __init__()\n" - "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy constructor.\n" - "\n" - " :arg brother: An SVertexIterator object.\n" - " :type brother: :class:`SVertexIterator`\n" - "\n" - ".. method:: __init__(vertex, begin, previous_edge, next_edge, t)\n" - "\n" - " Build an SVertexIterator that starts iteration from an SVertex\n" - " object v.\n" - "\n" - " :arg vertex: The SVertex from which the iterator starts iteration.\n" - " :type vertex: :class:`SVertex`\n" - " :arg begin: The first SVertex of a ViewEdge.\n" - " :type begin: :class:`SVertex`\n" - " :arg previous_edge: The previous FEdge coming to vertex.\n" - " :type previous_edge: :class:`FEdge`\n" - " :arg next_edge: The next FEdge going out from vertex.\n" - " :type next_edge: :class:`FEdge`\n" - " :arg t: The curvilinear abscissa at vertex.\n" - " :type t: float"); +PyDoc_STRVAR( + SVertexIterator_doc, + "Class hierarchy: :class:`Iterator` > :class:`SVertexIterator`\n" + "\n" + "Class representing an iterator over :class:`SVertex` of a\n" + ":class:`ViewEdge`. An instance of an SVertexIterator can be obtained\n" + "from a ViewEdge by calling verticesBegin() or verticesEnd().\n" + "\n" + ".. method:: __init__()\n" + " __init__(brother)\n" + " __init__(vertex, begin, previous_edge, next_edge, t)" + "\n" + " Build an SVertexIterator using either the default constructor, copy constructor,\n" + " or the overloaded constructor that starts iteration from an SVertex object vertex.\n" + "\n" + " :arg brother: An SVertexIterator object.\n" + " :type brother: :class:`SVertexIterator`\n" + " :arg vertex: The SVertex from which the iterator starts iteration.\n" + " :type vertex: :class:`SVertex`\n" + " :arg begin: The first SVertex of a ViewEdge.\n" + " :type begin: :class:`SVertex`\n" + " :arg previous_edge: The previous FEdge coming to vertex.\n" + " :type previous_edge: :class:`FEdge`\n" + " :arg next_edge: The next FEdge going out from vertex.\n" + " :type next_edge: :class:`FEdge`\n" + " :arg t: The curvilinear abscissa at vertex.\n" + " :type t: float"); static int SVertexIterator_init(BPy_SVertexIterator *self, PyObject *args, PyObject *kwds) { diff --git a/source/blender/freestyle/intern/python/Iterator/BPy_StrokeVertexIterator.cpp b/source/blender/freestyle/intern/python/Iterator/BPy_StrokeVertexIterator.cpp index cda4031240b..e1b24e768e3 100644 --- a/source/blender/freestyle/intern/python/Iterator/BPy_StrokeVertexIterator.cpp +++ b/source/blender/freestyle/intern/python/Iterator/BPy_StrokeVertexIterator.cpp @@ -48,12 +48,10 @@ PyDoc_STRVAR(StrokeVertexIterator_doc, "by calling Interface0DIterator(it).\n" "\n" ".. method:: __init__()\n" + " __init__(brother)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy constructor.\n" + " Creates a :class:`StrokeVertexIterator` using either the\n" + " default constructor or the copy constructor.\n" "\n" " :arg brother: A StrokeVertexIterator object.\n" " :type brother: :class:`StrokeVertexIterator`"); diff --git a/source/blender/freestyle/intern/python/Iterator/BPy_ViewEdgeIterator.cpp b/source/blender/freestyle/intern/python/Iterator/BPy_ViewEdgeIterator.cpp index 3d0ed5d5a4d..20134057864 100644 --- a/source/blender/freestyle/intern/python/Iterator/BPy_ViewEdgeIterator.cpp +++ b/source/blender/freestyle/intern/python/Iterator/BPy_ViewEdgeIterator.cpp @@ -40,9 +40,10 @@ PyDoc_STRVAR(ViewEdgeIterator_doc, "on a given ViewEdge.\n" "\n" ".. method:: __init__(begin=None, orientation=True)\n" + " __init__(brother)\n" "\n" " Builds a ViewEdgeIterator from a starting ViewEdge and its\n" - " orientation.\n" + " orientation or the copy constructor.\n" "\n" " :arg begin: The ViewEdge from where to start the iteration.\n" " :type begin: :class:`ViewEdge` or None\n" @@ -51,11 +52,6 @@ PyDoc_STRVAR(ViewEdgeIterator_doc, " false, we'll search over the ViewEdges surrounding the ending\n" " ViewVertex of begin.\n" " :type orientation: bool\n" - "\n" - ".. method:: __init__(brother)\n" - "\n" - " Copy constructor.\n" - "\n" " :arg brother: A ViewEdgeIterator object.\n" " :type brother: :class:`ViewEdgeIterator`"); diff --git a/source/blender/freestyle/intern/python/Iterator/BPy_orientedViewEdgeIterator.cpp b/source/blender/freestyle/intern/python/Iterator/BPy_orientedViewEdgeIterator.cpp index fe6210468d1..30b7b3ccde5 100644 --- a/source/blender/freestyle/intern/python/Iterator/BPy_orientedViewEdgeIterator.cpp +++ b/source/blender/freestyle/intern/python/Iterator/BPy_orientedViewEdgeIterator.cpp @@ -39,12 +39,10 @@ PyDoc_STRVAR(orientedViewEdgeIterator_doc, "obtained from a ViewVertex by calling edges_begin() or edges_end().\n" "\n" ".. method:: __init__()\n" + " __init__(iBrother)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(iBrother)\n" - "\n" - " Copy constructor.\n" + " Creates an :class:`orientedViewEdgeIterator` using either the\n" + " default constructor or the copy constructor.\n" "\n" " :arg iBrother: An orientedViewEdgeIterator object.\n" " :type iBrother: :class:`orientedViewEdgeIterator`"); diff --git a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DDouble.cpp b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DDouble.cpp index 88705c41204..b59e27dcea9 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DDouble.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DDouble.cpp @@ -160,13 +160,10 @@ static char UnaryFunction1DDouble___doc__[] = ":class:`Interface1D` and return a float value.\n" "\n" ".. method:: __init__()\n" + " __init__(integration_type)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(integration_type)\n" - "\n" - " Builds a unary 1D function using the integration method given as\n" - " argument.\n" + " Builds a unary 1D function using the default constructor\n" + " or the integration method given as an argument.\n" "\n" " :arg integration_type: An integration method.\n" " :type integration_type: :class:`IntegrationType`\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DEdgeNature.cpp b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DEdgeNature.cpp index 3cfc5464296..2f5a59f9c7a 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DEdgeNature.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DEdgeNature.cpp @@ -65,13 +65,10 @@ static char UnaryFunction1DEdgeNature___doc__[] = ":class:`Interface1D` and return a :class:`Nature` object.\n" "\n" ".. method:: __init__()\n" + " __init__(integration_type)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(integration_type)\n" - "\n" - " Builds a unary 1D function using the integration method given as\n" - " argument.\n" + " Builds a unary 1D function using the default constructor\n" + " or the integration method given as an argument.\n" "\n" " :arg integration_type: An integration method.\n" " :type integration_type: :class:`IntegrationType`\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DFloat.cpp b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DFloat.cpp index 4fdc68a2e89..e11d21b6c8e 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DFloat.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DFloat.cpp @@ -56,13 +56,10 @@ static char UnaryFunction1DFloat___doc__[] = ":class:`Interface1D` and return a float value.\n" "\n" ".. method:: __init__()\n" + " __init__(integration_type)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(integration_type)\n" - "\n" - " Builds a unary 1D function using the integration method given as\n" - " argument.\n" + " Builds a unary 1D function using the default constructor\n" + " or the integration method given as an argument.\n" "\n" " :arg integration_type: An integration method.\n" " :type integration_type: :class:`IntegrationType`\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DUnsigned.cpp b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DUnsigned.cpp index 218afa3ff10..e04a5b9d7f4 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DUnsigned.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DUnsigned.cpp @@ -65,13 +65,10 @@ static char UnaryFunction1DUnsigned___doc__[] = ":class:`Interface1D` and return an int value.\n" "\n" ".. method:: __init__()\n" + " __init__(integration_type)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(integration_type)\n" - "\n" - " Builds a unary 1D function using the integration method given as\n" - " argument.\n" + " Builds a unary 1D function using the default constructor\n" + " or the integration method given as an argument.\n" "\n" " :arg integration_type: An integration method.\n" " :type integration_type: :class:`IntegrationType`\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec2f.cpp b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec2f.cpp index 939ccfb8905..f8d75640811 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec2f.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec2f.cpp @@ -71,13 +71,10 @@ static char UnaryFunction1DVec2f___doc__[] = ":class:`Interface1D` and return a 2D vector.\n" "\n" ".. method:: __init__()\n" + " __init__(integration_type)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(integration_type)\n" - "\n" - " Builds a unary 1D function using the integration method given as\n" - " argument.\n" + " Builds a unary 1D function using the default constructor\n" + " or the integration method given as an argument.\n" "\n" " :arg integration_type: An integration method.\n" " :type integration_type: :class:`IntegrationType`\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec3f.cpp b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec3f.cpp index 02b6373cce4..9f71fb3840b 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec3f.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVec3f.cpp @@ -64,13 +64,10 @@ static char UnaryFunction1DVec3f___doc__[] = ":class:`Interface1D` and return a 3D vector.\n" "\n" ".. method:: __init__()\n" + " __init__(integration_type)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(integration_type)\n" - "\n" - " Builds a unary 1D function using the integration method given as\n" - " argument.\n" + " Builds a unary 1D function using the default constructor\n" + " or the integration method given as an argument.\n" "\n" " :arg integration_type: An integration method.\n" " :type integration_type: :class:`IntegrationType`\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVectorViewShape.cpp b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVectorViewShape.cpp index b2020e9f554..cb4982f4532 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVectorViewShape.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVectorViewShape.cpp @@ -80,13 +80,10 @@ static char UnaryFunction1DVectorViewShape___doc__[] = "objects.\n" "\n" ".. method:: __init__()\n" + " __init__(integration_type)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(integration_type)\n" - "\n" - " Builds a unary 1D function using the integration method given as\n" - " argument.\n" + " Builds a unary 1D function using the default constructor\n" + " or the integration method given as an argument.\n" "\n" " :arg integration_type: An integration method.\n" " :type integration_type: :class:`IntegrationType`\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVoid.cpp b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVoid.cpp index 7b25daa24f9..46564cdaeca 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVoid.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction1D/BPy_UnaryFunction1DVoid.cpp @@ -79,13 +79,10 @@ static char UnaryFunction1DVoid___doc__[] = ":class:`Interface1D`.\n" "\n" ".. method:: __init__()\n" + " __init__(integration_type)\n" "\n" - " Default constructor.\n" - "\n" - ".. method:: __init__(integration_type)\n" - "\n" - " Builds a unary 1D function using the integration method given as\n" - " argument.\n" + " Builds a unary 1D function using either a default constructor\n" + " or the integration method given as an argument.\n" "\n" " :arg integration_type: An integration method.\n" " :type integration_type: :class:`IntegrationType`\n"; |