From 1f778dbefcaf825dcad1f70a9cc45e503ad74ed5 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Thu, 24 Jun 2021 15:57:33 +1000 Subject: Cleanup: use Blender's code style for doxygen commetns in freestyle --- .../freestyle/intern/stroke/AdvancedFunctions0D.h | 48 +++++++++++----------- 1 file changed, 24 insertions(+), 24 deletions(-) (limited to 'source/blender/freestyle/intern/stroke/AdvancedFunctions0D.h') diff --git a/source/blender/freestyle/intern/stroke/AdvancedFunctions0D.h b/source/blender/freestyle/intern/stroke/AdvancedFunctions0D.h index 17e419bed54..212187e598c 100644 --- a/source/blender/freestyle/intern/stroke/AdvancedFunctions0D.h +++ b/source/blender/freestyle/intern/stroke/AdvancedFunctions0D.h @@ -36,13 +36,13 @@ namespace Freestyle { namespace Functions0D { // DensityF0D -/*! Returns the density of the (result) image evaluated at an Interface0D. +/** Returns the density of the (result) image evaluated at an Interface0D. * This density is evaluated using a pixels square window around the evaluation point and * integrating these values using a gaussian. */ class DensityF0D : public UnaryFunction0D { public: - /*! Builds the functor from the gaussian sigma value. + /** Builds the functor from the gaussian sigma value. * \param sigma: * sigma indicates the x value for which the gaussian function is 0.5. * It leads to the window size value. (the larger, the smoother) @@ -52,13 +52,13 @@ class DensityF0D : public UnaryFunction0D { _filter.setSigma((float)sigma); } - /*! Returns the string "DensityF0D" */ + /** Returns the string "DensityF0D" */ string getName() const { return "DensityF0D"; } - /*! The () operator. */ + /** The () operator. */ int operator()(Interface0DIterator &iter); private: @@ -66,7 +66,7 @@ class DensityF0D : public UnaryFunction0D { }; // LocalAverageDepthF0D -/*! Returns the average depth around a point. +/** Returns the average depth around a point. * The result is obtained by querying the depth buffer on a window around that point. */ class LocalAverageDepthF0D : public UnaryFunction0D { @@ -74,31 +74,31 @@ class LocalAverageDepthF0D : public UnaryFunction0D { GaussianFilter _filter; public: - /*! Builds the functor from the size of the mask that will be used. */ + /** Builds the functor from the size of the mask that will be used. */ LocalAverageDepthF0D(real maskSize = 5.0f) : UnaryFunction0D() { _filter.setSigma((float)maskSize / 2.0f); } - /*! Returns the string "LocalAverageDepthF0D" */ + /** Returns the string "LocalAverageDepthF0D" */ string getName() const { return "LocalAverageDepthF0D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface0DIterator &iter); }; // ReadMapPixel -/*! Reads a pixel in a map. */ +/** Reads a pixel in a map. */ class ReadMapPixelF0D : public UnaryFunction0D { private: const char *_mapName; int _level; public: - /*! Builds the functor from name of the + /** Builds the functor from name of the * Map that must be read. * \param iMapName: * The name of the map. @@ -111,25 +111,25 @@ class ReadMapPixelF0D : public UnaryFunction0D { _level = level; } - /*! Returns the string "ReadMapPixelF0D" */ + /** Returns the string "ReadMapPixelF0D" */ string getName() const { return "ReadMapPixelF0D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface0DIterator &iter); }; // ReadSteerableViewMapPixel -/*! Reads a pixel in one of the level of one of the steerable viewmaps. */ +/** Reads a pixel in one of the level of one of the steerable viewmaps. */ class ReadSteerableViewMapPixelF0D : public UnaryFunction0D { private: unsigned _orientation; int _level; public: - /*! Builds the functor + /** Builds the functor * \param nOrientation: * The integer belonging to [0,4] indicating the orientation (E,NE,N,NW) we are interested in. * \param level: @@ -141,24 +141,24 @@ class ReadSteerableViewMapPixelF0D : public UnaryFunction0D { _level = level; } - /*! Returns the string "ReadSteerableViewMapPixelF0D" */ + /** Returns the string "ReadSteerableViewMapPixelF0D" */ string getName() const { return "ReadSteerableViewMapPixelF0D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface0DIterator &iter); }; // ReadCompleteViewMapPixel -/*! Reads a pixel in one of the level of the complete viewmap. */ +/** Reads a pixel in one of the level of the complete viewmap. */ class ReadCompleteViewMapPixelF0D : public UnaryFunction0D { private: int _level; public: - /*! Builds the functor + /** Builds the functor * \param level: * The level of the pyramid from which the pixel must be read. */ @@ -167,25 +167,25 @@ class ReadCompleteViewMapPixelF0D : public UnaryFunction0D { _level = level; } - /*! Returns the string "ReadCompleteViewMapPixelF0D" */ + /** Returns the string "ReadCompleteViewMapPixelF0D" */ string getName() const { return "ReadCompleteViewMapPixelF0D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface0DIterator &iter); }; // GetViewMapGradientNormF0D -/*! Returns the norm of the gradient of the global viewmap density image. */ +/** Returns the norm of the gradient of the global viewmap density image. */ class GetViewMapGradientNormF0D : public UnaryFunction0D { private: int _level; float _step; public: - /*! Builds the functor + /** Builds the functor * \param level: * The level of the pyramid from which the pixel must be read. */ @@ -195,13 +195,13 @@ class GetViewMapGradientNormF0D : public UnaryFunction0D { _step = (float)pow(2.0, _level); } - /*! Returns the string "GetOccludeeF0D" */ + /** Returns the string "GetOccludeeF0D" */ string getName() const { return "GetViewMapGradientNormF0D"; } - /*! the () operator. */ + /** the () operator. */ int operator()(Interface0DIterator &iter); }; -- cgit v1.2.3