Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2018-12-12 04:50:58 +0300
committerCampbell Barton <ideasman42@gmail.com>2018-12-12 04:50:58 +0300
commite757c4a3bec8b0e8d198531a28327332af00a9ba (patch)
tree4707fd51cffdbe932123a29bbcfe4528fc9c2b55 /source/blender/freestyle/intern/view_map
parentba8d6ca3dd92eed5d679caa28f5446cd07b8a112 (diff)
Cleanup: use colon separator after parameter
Helps separate variable names from descriptive text. Was already used in some parts of the code, double space and dashes were used elsewhere.
Diffstat (limited to 'source/blender/freestyle/intern/view_map')
-rw-r--r--source/blender/freestyle/intern/view_map/FEdgeXDetector.h6
-rw-r--r--source/blender/freestyle/intern/view_map/Functions0D.h2
-rw-r--r--source/blender/freestyle/intern/view_map/Functions1D.h30
-rw-r--r--source/blender/freestyle/intern/view_map/Interface1D.h12
-rw-r--r--source/blender/freestyle/intern/view_map/Silhouette.h4
-rw-r--r--source/blender/freestyle/intern/view_map/SteerableViewMap.h20
-rw-r--r--source/blender/freestyle/intern/view_map/ViewMap.h4
-rw-r--r--source/blender/freestyle/intern/view_map/ViewMapIterators.h4
8 files changed, 41 insertions, 41 deletions
diff --git a/source/blender/freestyle/intern/view_map/FEdgeXDetector.h b/source/blender/freestyle/intern/view_map/FEdgeXDetector.h
index cbb47d387fb..99b7c127fff 100644
--- a/source/blender/freestyle/intern/view_map/FEdgeXDetector.h
+++ b/source/blender/freestyle/intern/view_map/FEdgeXDetector.h
@@ -93,7 +93,7 @@ public:
virtual void ProcessCreaseEdge(WXEdge *iEdge);
/*! Sets the minimum angle for detecting crease edges
- * \param angle
+ * \param angle:
* The angular threshold in degrees (between 0 and 180) for detecting crease edges. An edge is considered
* a crease edge if the angle between two faces sharing the edge is smaller than the given threshold.
*/
@@ -125,7 +125,7 @@ public:
virtual void postProcessSuggestiveContourShape(WXShape *iShape);
virtual void postProcessSuggestiveContourFace(WXFace *iFace);
/*! Sets the minimal derivative of the radial curvature for suggestive contours
- * \param dkr
+ * \param dkr:
* The minimal derivative of the radial curvature
*/
inline void setSuggestiveContourKrDerivativeEpsilon(float dkr)
@@ -190,7 +190,7 @@ public:
}
/*! Sets the radius of the geodesic sphere around each vertex (for the curvature computation)
- * \param r
+ * \param r:
* The radius of the sphere expressed as a ratio of the mean edge size
*/
inline void setSphereRadius(float r)
diff --git a/source/blender/freestyle/intern/view_map/Functions0D.h b/source/blender/freestyle/intern/view_map/Functions0D.h
index f0009fca6ea..035da76a6e4 100644
--- a/source/blender/freestyle/intern/view_map/Functions0D.h
+++ b/source/blender/freestyle/intern/view_map/Functions0D.h
@@ -103,7 +103,7 @@ public:
}
/*! The operator ().
- * \param iter
+ * \param iter:
* An Interface0DIterator pointing onto the point at which we wish to evaluate the function.
* \return the result of the function of type T.
*/
diff --git a/source/blender/freestyle/intern/view_map/Functions1D.h b/source/blender/freestyle/intern/view_map/Functions1D.h
index f3c8957a804..60b3192910f 100644
--- a/source/blender/freestyle/intern/view_map/Functions1D.h
+++ b/source/blender/freestyle/intern/view_map/Functions1D.h
@@ -81,7 +81,7 @@ public:
}
/*! Builds a UnaryFunction1D from an integration type.
- * \param iType
+ * \param iType:
* In case the result for the Interface1D would be obtained by evaluating a 0D function over the different
* Interface0D of the Interface1D, \a iType tells which integration method to use.
* The default integration method is the MEAN.
@@ -101,7 +101,7 @@ public:
}
/*! The operator ().
- * \param inter
+ * \param inter:
* The Interface1D on which we wish to evaluate the function.
* \return the result of the function of type T.
*/
@@ -195,7 +195,7 @@ private:
public:
/*! Builds the functor.
- * \param iType
+ * \param iType:
* The integration method used to compute a single value from a set of values.
*/
GetXF1D(IntegrationType iType) : UnaryFunction1D<double>(iType) {}
@@ -219,7 +219,7 @@ Functions0D::GetYF0D _func;
public:
/*! Builds the functor.
- * \param iType
+ * \param iType:
* The integration method used to compute a single value from a set of values.
*/
GetYF1D(IntegrationType iType = MEAN) : UnaryFunction1D<double>(iType) {}
@@ -243,7 +243,7 @@ private:
public:
/*! Builds the functor.
- * \param iType
+ * \param iType:
* The integration method used to compute a single value from a set of values.
*/
GetZF1D(IntegrationType iType = MEAN) : UnaryFunction1D<double>(iType) {}
@@ -267,7 +267,7 @@ private:
public:
/*! Builds the functor.
- * \param iType
+ * \param iType:
* The integration method used to compute a single value from a set of values.
*/
GetProjectedXF1D(IntegrationType iType = MEAN) : UnaryFunction1D<double>(iType) {}
@@ -291,7 +291,7 @@ private:
public:
/*! Builds the functor.
- * \param iType
+ * \param iType:
* The integration method used to compute a single value from a set of values.
*/
GetProjectedYF1D(IntegrationType iType = MEAN) : UnaryFunction1D<double>(iType) {}
@@ -315,7 +315,7 @@ private:
public:
/*! Builds the functor.
- * \param iType
+ * \param iType:
* The integration method used to compute a single value from a set of values.
*/
GetProjectedZF1D(IntegrationType iType = MEAN) : UnaryFunction1D<double>(iType) {}
@@ -339,7 +339,7 @@ private:
public:
/*! Builds the functor.
- * \param iType
+ * \param iType:
* The integration method used to compute a single value from a set of values.
*/
Orientation2DF1D(IntegrationType iType = MEAN) : UnaryFunction1D<Vec2f>(iType) {}
@@ -363,7 +363,7 @@ private:
public:
/*! Builds the functor.
- * \param iType
+ * \param iType:
* The integration method used to compute a single value from a set of values.
*/
Orientation3DF1D(IntegrationType iType = MEAN) : UnaryFunction1D<Vec3f>(iType) {}
@@ -390,7 +390,7 @@ private:
public:
/*! Builds the functor.
- * \param iType
+ * \param iType:
* The integration method used to compute a single value from a set of values.
*/
ZDiscontinuityF1D(IntegrationType iType = MEAN) : UnaryFunction1D<double>(iType) {}
@@ -418,7 +418,7 @@ private:
public:
/*! Builds the functor.
- * \param iType
+ * \param iType:
* The integration method used to compute a single value from a set of values.
*/
QuantitativeInvisibilityF1D(IntegrationType iType = MEAN) : UnaryFunction1D<unsigned int>(iType) {}
@@ -446,7 +446,7 @@ private:
public:
/*! Builds the functor.
- * \param iType
+ * \param iType:
* The integration method used to compute a single value from a set of values.
*/
CurveNatureF1D(IntegrationType iType = MEAN) : UnaryFunction1D<Nature::EdgeNature>(iType) {}
@@ -513,7 +513,7 @@ class Curvature2DAngleF1D : public UnaryFunction1D<double>
{
public:
/*! Builds the functor.
- * \param iType
+ * \param iType:
* The integration method used to compute a single value from a set of values.
*/
Curvature2DAngleF1D(IntegrationType iType = MEAN) : UnaryFunction1D<double>(iType) {}
@@ -541,7 +541,7 @@ class Normal2DF1D : public UnaryFunction1D<Vec2f>
{
public:
/*! Builds the functor.
- * \param iType
+ * \param iType:
* The integration method used to compute a single value from a set of values.
*/
Normal2DF1D(IntegrationType iType = MEAN) : UnaryFunction1D<Vec2f>(iType) {}
diff --git a/source/blender/freestyle/intern/view_map/Interface1D.h b/source/blender/freestyle/intern/view_map/Interface1D.h
index 7afa61ff496..d6f402bf153 100644
--- a/source/blender/freestyle/intern/view_map/Interface1D.h
+++ b/source/blender/freestyle/intern/view_map/Interface1D.h
@@ -60,14 +60,14 @@ typedef enum {
} IntegrationType;
/*! Returns a single value from a set of values evaluated at each 0D element of this 1D element.
- * \param fun
+ * \param fun:
* The UnaryFunction0D used to compute a value at each Interface0D.
- * \param it
+ * \param it:
* The Interface0DIterator used to iterate over the 0D elements of this 1D element. The integration will occur
* over the 0D elements starting from the one pointed by it.
- * \param it_end
+ * \param it_end:
* The Interface0DIterator pointing the end of the 0D elements of the 1D element.
- * \param integration_type
+ * \param integration_type:
* The integration method used to compute a single value from a set of values.
* \return the single value obtained for the 1D element.
*/
@@ -156,7 +156,7 @@ public:
/*! Returns an iterator over the Interface1D points, pointing to the first point. The difference with
* verticesBegin() is that here we can iterate over points of the 1D element at a any given sampling.
* Indeed, for each iteration, a virtual point is created.
- * \param t
+ * \param t:
* The sampling with which we want to iterate over points of this 1D element.
*/
virtual Interface0DIterator pointsBegin(float t = 0.0f);
@@ -164,7 +164,7 @@ public:
/*! Returns an iterator over the Interface1D points, pointing after the last point. The difference with
* verticesEnd() is that here we can iterate over points of the 1D element at a any given sampling.
* Indeed, for each iteration, a virtual point is created.
- * \param t
+ * \param t:
* The sampling with which we want to iterate over points of this 1D element.
*/
virtual Interface0DIterator pointsEnd(float t = 0.0f);
diff --git a/source/blender/freestyle/intern/view_map/Silhouette.h b/source/blender/freestyle/intern/view_map/Silhouette.h
index 44bce375a75..a18cf41797b 100644
--- a/source/blender/freestyle/intern/view_map/Silhouette.h
+++ b/source/blender/freestyle/intern/view_map/Silhouette.h
@@ -949,7 +949,7 @@ public:
/*! Returns an iterator over the FEdge points, pointing to the first point. The difference with verticesBegin()
* is that here we can iterate over points of the FEdge at a any given sampling.
* Indeed, for each iteration, a virtual point is created.
- * \param t
+ * \param t:
* The sampling with which we want to iterate over points of this FEdge.
*/
virtual inline Interface0DIterator pointsBegin(float t = 0.0f);
@@ -957,7 +957,7 @@ public:
/*! Returns an iterator over the FEdge points, pointing after the last point. The difference with verticesEnd()
* is that here we can iterate over points of the FEdge at a any given sampling.
* Indeed, for each iteration, a virtual point is created.
- * \param t
+ * \param t:
* The sampling with which we want to iterate over points of this FEdge.
*/
virtual inline Interface0DIterator pointsEnd(float t = 0.0f);
diff --git a/source/blender/freestyle/intern/view_map/SteerableViewMap.h b/source/blender/freestyle/intern/view_map/SteerableViewMap.h
index 0327b4a460e..1259d081209 100644
--- a/source/blender/freestyle/intern/view_map/SteerableViewMap.h
+++ b/source/blender/freestyle/intern/view_map/SteerableViewMap.h
@@ -82,27 +82,27 @@ public:
double ComputeWeight(const Vec2d& dir, unsigned iNOrientation);
/*! Returns the number of the SVM to which a direction belongs to.
- * \param dir
+ * \param dir:
* The direction
*/
unsigned getSVMNumber(const Vec2f& dir);
/*! Returns the number of the SVM to which a FEdge belongs most.
- * \param id
+ * \param id:
* The First element of the Id struct of the FEdge we're interested in.
*/
unsigned getSVMNumber(unsigned id);
/*! Builds _nbOrientations+1 pyramids of images from the _nbOrientations+1 base images of the steerable viewmap.
- * \param steerableBases
+ * \param steerableBases:
* The _nbOrientations+1 images constituting the basis for the steerable pyramid.
- * \param copy
+ * \param copy:
* If false, the data is not duplicated, and Canvas deals with the memory management of these
* _nbOrientations+1 images. If true, data is copied, and it's up to the caller to delete the images.
- * \param iNbLevels
+ * \param iNbLevels:
* The number of levels desired for each pyramid.
* If iNbLevels == 0, the complete pyramid is built.
- * \param iSigma
+ * \param iSigma:
* The sigma that will be used for the gaussian blur
*/
void buildImagesPyramids(GrayImage **steerableBases, bool copy = false, unsigned iNbLevels = 4,
@@ -110,7 +110,7 @@ public:
/*! Reads a pixel value in one of the VewMap density steerable pyramids.
* Returns a value between 0 and 1.
- * \param iOrientation
+ * \param iOrientation:
* the number telling which orientation we need to check.
* There are _nbOrientations+1 oriented ViewMaps:
* 0 -> the ViewMap containing every horizontal lines
@@ -118,11 +118,11 @@ public:
* 2 -> the ViewMap containing every vertical lines
* 3 -> the ViewMap containing every lines whose orientation is around 3PI/4
* 4 -> the complete ViewMap
- * \param iLevel
+ * \param iLevel:
* The level of the pyramid we want to read
- * \param x
+ * \param x:
* The abscissa of the desired pixel specified in level0 coordinate system. The origin is the lower left corner.
- * \param y
+ * \param y:
* The ordinate of the desired pixel specified in level0 coordinate system. The origin is the lower left corner.
*/
float readSteerableViewMapPixel(unsigned iOrientation, int iLevel, int x, int y);
diff --git a/source/blender/freestyle/intern/view_map/ViewMap.h b/source/blender/freestyle/intern/view_map/ViewMap.h
index 74fb875ffc6..0acc6ca39d8 100644
--- a/source/blender/freestyle/intern/view_map/ViewMap.h
+++ b/source/blender/freestyle/intern/view_map/ViewMap.h
@@ -1364,14 +1364,14 @@ public:
/*! Returns an Interface0DIterator to iterate over the points of this ViewEdge at a given resolution.
* The returned Interface0DIterator points on the first Point of the ViewEdge.
- * \param t
+ * \param t:
* the sampling value.
*/
virtual Interface0DIterator pointsBegin(float t = 0.0f);
/*! Returns an Interface0DIterator to iterate over the points of this ViewEdge at a given resolution.
* The returned Interface0DIterator points after the last Point of the ViewEdge.
- * \param t
+ * \param t:
* the sampling value.
*/
virtual Interface0DIterator pointsEnd(float t = 0.0f);
diff --git a/source/blender/freestyle/intern/view_map/ViewMapIterators.h b/source/blender/freestyle/intern/view_map/ViewMapIterators.h
index b10de13cef7..bec57bf36df 100644
--- a/source/blender/freestyle/intern/view_map/ViewMapIterators.h
+++ b/source/blender/freestyle/intern/view_map/ViewMapIterators.h
@@ -417,9 +417,9 @@ class ViewEdgeIterator : public Iterator
{
public:
/*! Builds a ViewEdgeIterator from a starting ViewEdge and its orientation.
- * \param begin
+ * \param begin:
* The ViewEdge from where to start the iteration.
- * \param orientation
+ * \param orientation:
* If true, we'll look for the next ViewEdge among the ViewEdges that surround the ending ViewVertex of begin.
* If false, we'll search over the ViewEdges surrounding the ending ViewVertex of begin.
*/