diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-14 10:35:23 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-14 10:35:23 +0300 |
commit | a207c1cdaf11864a413c5de3ade93f85a592b3cb (patch) | |
tree | 658b0676ffbaea37c9ec98689bdba8de5eae1d11 /source/blender/freestyle | |
parent | c097c7b855d4b01950494dc369e9def59486b0fd (diff) |
Cleanup: resolve parameter mis-matches in doc-strings
Renamed or removed parameters which no longer exist.
Diffstat (limited to 'source/blender/freestyle')
3 files changed, 8 insertions, 11 deletions
diff --git a/source/blender/freestyle/intern/image/GaussianFilter.h b/source/blender/freestyle/intern/image/GaussianFilter.h index 2cb3e7d7ac5..af537cf2d86 100644 --- a/source/blender/freestyle/intern/image/GaussianFilter.h +++ b/source/blender/freestyle/intern/image/GaussianFilter.h @@ -37,14 +37,16 @@ namespace Freestyle { class GaussianFilter { protected: /* The mask is a symmetrical 2d array (with respect to the middle point). - * Thus, M(i,j) = M(-i,j) = M(i,-j) = M(-i,-j). - * For this reason, to represent a NxN array (N odd), we only store a ((N+1)/2)x((N+1)/2) array. - */ + * Thus: `M(i,j) = M(-i,j) = M(i,-j) = M(-i,-j)`. + * For this reason, to represent a NxN array (N odd), + * we only store a `((N+1)/2)x((N+1)/2)` array. */ + + /** The sigma value of the gaussian function. */ float _sigma; float *_mask; int _bound; - // the real mask size (must be odd)(the size of the mask we store is - // ((_maskSize+1)/2)*((_maskSize+1)/2)) + /* the real mask size (must be odd)(the size of the mask we store is: + * `((_maskSize+1)/2)*((_maskSize+1)/2))`. */ int _maskSize; int _storedMaskSize; // (_maskSize+1)/2) @@ -65,8 +67,6 @@ class GaussianFilter { * The abscissa of the pixel where we want to evaluate the gaussian blur. * \param y: * The ordinate of the pixel where we want to evaluate the gaussian blur. - * \param sigma: - * The sigma value of the gaussian function. */ template<class Map> float getSmoothedPixel(Map *map, int x, int y); diff --git a/source/blender/freestyle/intern/stroke/AdvancedStrokeShaders.h b/source/blender/freestyle/intern/stroke/AdvancedStrokeShaders.h index 52cd037a73a..b41beb356c4 100644 --- a/source/blender/freestyle/intern/stroke/AdvancedStrokeShaders.h +++ b/source/blender/freestyle/intern/stroke/AdvancedStrokeShaders.h @@ -119,7 +119,7 @@ class SmoothingShader : public StrokeShader { * 0.2 * \param iAnisoPoint: * 0 - * \param iAnisNormal: + * \param iAnisoNormal: * 0 * \param iAnisoCurvature: * 0 diff --git a/source/blender/freestyle/intern/winged_edge/Curvature.h b/source/blender/freestyle/intern/winged_edge/Curvature.h index 0b3e90a8549..acbe4e8daf6 100644 --- a/source/blender/freestyle/intern/winged_edge/Curvature.h +++ b/source/blender/freestyle/intern/winged_edge/Curvature.h @@ -124,7 +124,6 @@ class Face_Curvature_Info { /** * \param v: a #WVertex. - * \param s: a #GtsSurface. * \param Kh: the Mean Curvature Normal at \a v. * * Computes the Discrete Mean Curvature Normal approximation at \a v. @@ -147,7 +146,6 @@ bool gts_vertex_mean_curvature_normal(WVertex *v, Vec3r &Kh); /** * \param v: a #WVertex. - * \param s: a #GtsSurface. * \param Kg: the Discrete Gaussian Curvature approximation at \a v. * * Computes the Discrete Gaussian Curvature approximation at \a v. @@ -181,7 +179,6 @@ void gts_vertex_principal_curvatures(real Kh, real Kg, real *K1, real *K2); /** * \param v: a #WVertex. - * \param s: a #GtsSurface. * \param Kh: mean curvature normal (a #Vec3r). * \param Kg: Gaussian curvature (a real). * \param e1: first principal curvature direction (direction of largest curvature). |