diff options
author | Campbell Barton <campbell@blender.org> | 2022-04-11 04:41:00 +0300 |
---|---|---|
committer | Campbell Barton <campbell@blender.org> | 2022-04-11 05:03:09 +0300 |
commit | 5e47056e8d97e414c9dabacea71fac2bdc7d2818 (patch) | |
tree | 110a51be7cfb2f9eff9fd8db093975e29e1a3445 /source/blender/freestyle/intern | |
parent | 1c264ebdc089ea6afef7be4edeb1add4998a1099 (diff) |
Cleanup: malformed C-style comment blocks, spelling
- Missing star prefix.
- Unnecessary indentation.
- Blank line after dot-points
(otherwise doxygen merges with the previous dot-point).
- Use back-slash for doxygen commands.
- Correct spelling.
Diffstat (limited to 'source/blender/freestyle/intern')
-rw-r--r-- | source/blender/freestyle/intern/view_map/Interface1D.h | 55 |
1 files changed, 35 insertions, 20 deletions
diff --git a/source/blender/freestyle/intern/view_map/Interface1D.h b/source/blender/freestyle/intern/view_map/Interface1D.h index 5ab6fc794f9..47b3e827439 100644 --- a/source/blender/freestyle/intern/view_map/Interface1D.h +++ b/source/blender/freestyle/intern/view_map/Interface1D.h @@ -27,31 +27,46 @@ using namespace std; namespace Freestyle { // Integration method -/** The different integration methods that can be invoked to integrate into a single value the set +/** + * The different integration methods that can be invoked to integrate into a single value the set * of values obtained from each 0D element of a 1D element. */ typedef enum { - MEAN, /**< The value computed for the 1D element is the mean of the values obtained for the 0D - elements. */ - MIN, /**< The value computed for the 1D element is the minimum of the values obtained for the 0D - elements. */ - MAX, /**< The value computed for the 1D element is the maximum of the values obtained for the 0D - elements. */ - FIRST, /**< The value computed for the 1D element is the first of the values obtained for the 0D - elements. */ - LAST, /**< The value computed for the 1D element is the last of the values obtained for the 0D - elements. */ + /** + * The value computed for the 1D element is the mean of the values obtained for the 0D elements. + */ + MEAN, + /** + * The value computed for the 1D element is the minimum of the values obtained for the 0D + * elements. + */ + MIN, + /** + * The value computed for the 1D element is the maximum of the values obtained for the 0D + * elements. + */ + MAX, + /** + * The value computed for the 1D element is the first of the values obtained for the 0D + * elements. + */ + FIRST, + /** + * The value computed for the 1D element is the last of the values obtained for the 0D + * elements. + */ + LAST, } IntegrationType; -/** Returns a single value from a set of values evaluated at each 0D element of this 1D element. - * \param fun: - * The UnaryFunction0D used to compute a value at each Interface0D. - * \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: - * The Interface0DIterator pointing the end of the 0D elements of the 1D element. - * \param integration_type: - * The integration method used to compute a single value from a set of values. +/** + * Returns a single value from a set of values evaluated at each 0D element of this 1D element. + * + * \param fun: The UnaryFunction0D used to compute a value at each Interface0D. + * \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: The Interface0DIterator pointing the end of the 0D elements of the 1D element. + * \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. */ template<class T> |