diff options
Diffstat (limited to 'source/blender/freestyle/intern/stroke/StrokeIterators.h')
-rw-r--r-- | source/blender/freestyle/intern/stroke/StrokeIterators.h | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/source/blender/freestyle/intern/stroke/StrokeIterators.h b/source/blender/freestyle/intern/stroke/StrokeIterators.h index d4cbffd535e..20c29b21c22 100644 --- a/source/blender/freestyle/intern/stroke/StrokeIterators.h +++ b/source/blender/freestyle/intern/stroke/StrokeIterators.h @@ -32,7 +32,7 @@ namespace StrokeInternal { // ///////////////////////////////////////////////// -/*! Class defining an iterator designed to iterate over the StrokeVertex of a Stroke. +/** Class defining an iterator designed to iterate over the StrokeVertex of a Stroke. * An instance of a StrokeVertexIterator can only be obtained from a Stroke by calling * strokeVerticesBegin() or strokeVerticesEnd(). It is iterating over the same vertices as an * Interface0DIterator. The difference resides in the object access. Indeed, an Interface0DIterator @@ -46,12 +46,12 @@ namespace StrokeInternal { */ class StrokeVertexIterator : public Interface0DIteratorNested { public: - /*! Default constructor. */ + /** Default constructor. */ StrokeVertexIterator() { } - /*! Copy constructor. */ + /** Copy constructor. */ StrokeVertexIterator(const StrokeVertexIterator &vi) { _it = vi._it; @@ -72,7 +72,7 @@ class StrokeVertexIterator : public Interface0DIteratorNested { { } - /*! Casts this StrokeVertexIterator into an Interface0DIterator. + /** Casts this StrokeVertexIterator into an Interface0DIterator. * Useful for any call to a function of the type UnaryFunction0D. */ inline Interface0DIterator castToInterface0DIterator() const @@ -81,7 +81,7 @@ class StrokeVertexIterator : public Interface0DIteratorNested { return ret; } - /*! operator= + /** operator= * \attention In the scripting language, you must call \code it2 = StrokeVertexIterator(it1) * \endcode instead of \code it2 = it1 \endcode where \a it1 and \a it2 are 2 * StrokeVertexIterator. Otherwise, incrementing \a it1 will also increment \a it2. @@ -94,13 +94,13 @@ class StrokeVertexIterator : public Interface0DIteratorNested { return *this; } - /*! Returns the string "StrokeVertexIterator". */ + /** Returns the string "StrokeVertexIterator". */ virtual string getExactTypeName() const { return "StrokeVertexIterator"; } - /*! Returns a reference to the pointed StrokeVertex. + /** Returns a reference to the pointed StrokeVertex. * In the scripting language, you must call "getObject()"instead. */ virtual StrokeVertex &operator*() @@ -108,7 +108,7 @@ class StrokeVertexIterator : public Interface0DIteratorNested { return **_it; } - /*! Returns a pointer to the pointed StrokeVertex. + /** Returns a pointer to the pointed StrokeVertex. * Can't be called in the scripting language. */ virtual StrokeVertex *operator->() @@ -116,14 +116,14 @@ class StrokeVertexIterator : public Interface0DIteratorNested { return &(operator*()); } - /*! Increments. In the scripting language, call "increment()". */ + /** Increments. In the scripting language, call "increment()". */ virtual StrokeVertexIterator &operator++() { increment(); return *this; } - /*! Increments. In the scripting language, call "increment()". */ + /** Increments. In the scripting language, call "increment()". */ virtual StrokeVertexIterator operator++(int) { StrokeVertexIterator ret(*this); @@ -131,14 +131,14 @@ class StrokeVertexIterator : public Interface0DIteratorNested { return ret; } - /*! Decrements. In the scripting language, call "decrement()". */ + /** Decrements. In the scripting language, call "decrement()". */ virtual StrokeVertexIterator &operator--() { decrement(); return *this; } - /*! Decrements. In the scripting language, call "decrement()". */ + /** Decrements. In the scripting language, call "decrement()". */ virtual StrokeVertexIterator operator--(int) { StrokeVertexIterator ret(*this); @@ -146,27 +146,27 @@ class StrokeVertexIterator : public Interface0DIteratorNested { return ret; } - /*! Increments. */ + /** Increments. */ virtual int increment() { ++_it; return 0; } - /*! Decrements. */ + /** Decrements. */ virtual int decrement() { --_it; return 0; } - /*! Returns true if the pointed StrokeVertex is the first of the Stroke. */ + /** Returns true if the pointed StrokeVertex is the first of the Stroke. */ bool isBegin() const { return _it == _begin; } - /*! Returns true if the pointed StrokeVertex is the final valid StrokeVertex of the Stroke. */ + /** Returns true if the pointed StrokeVertex is the final valid StrokeVertex of the Stroke. */ bool atLast() { if (_it == _end) { @@ -179,13 +179,13 @@ class StrokeVertexIterator : public Interface0DIteratorNested { return result; } - /*! Returns true if the pointed StrokeVertex is after the last StrokeVertex of the Stroke. */ + /** Returns true if the pointed StrokeVertex is after the last StrokeVertex of the Stroke. */ bool isEnd() const { return _it == _end; } - /*! operator == */ + /** operator == */ virtual bool operator==(const Interface0DIteratorNested &it) const { const StrokeVertexIterator *it_exact = dynamic_cast<const StrokeVertexIterator *>(&it); @@ -195,19 +195,19 @@ class StrokeVertexIterator : public Interface0DIteratorNested { return (_it == it_exact->_it); } - /*! Returns the curvilinear abscissa of the current point */ + /** Returns the curvilinear abscissa of the current point */ virtual float t() const { return (*_it)->curvilinearAbscissa(); } - /*! Returns the point's parameter in the stroke */ + /** Returns the point's parameter in the stroke */ virtual float u() const { return (*_it)->u(); } - /*! Cloning method */ + /** Cloning method */ virtual StrokeVertexIterator *copy() const { return new StrokeVertexIterator(*this); |