From eef4077f18495d88a2426cfda3ec9a4dc461f798 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Wed, 6 Feb 2019 15:42:22 +1100 Subject: Cleanup: remove redundant doxygen \file argument Move \ingroup onto same line to be more compact and make it clear the file is in the group. --- source/blender/freestyle/intern/system/BaseIterator.h | 3 +-- source/blender/freestyle/intern/system/BaseObject.cpp | 3 +-- source/blender/freestyle/intern/system/BaseObject.h | 3 +-- source/blender/freestyle/intern/system/Cast.h | 3 +-- source/blender/freestyle/intern/system/Exception.cpp | 3 +-- source/blender/freestyle/intern/system/Exception.h | 3 +-- source/blender/freestyle/intern/system/FreestyleConfig.h | 3 +-- source/blender/freestyle/intern/system/Id.h | 3 +-- source/blender/freestyle/intern/system/Interpreter.h | 3 +-- source/blender/freestyle/intern/system/Iterator.cpp | 3 +-- source/blender/freestyle/intern/system/Iterator.h | 3 +-- source/blender/freestyle/intern/system/PointerSequence.h | 3 +-- source/blender/freestyle/intern/system/Precision.h | 3 +-- source/blender/freestyle/intern/system/ProgressBar.h | 3 +-- source/blender/freestyle/intern/system/PseudoNoise.cpp | 3 +-- source/blender/freestyle/intern/system/PseudoNoise.h | 3 +-- source/blender/freestyle/intern/system/PythonInterpreter.cpp | 3 +-- source/blender/freestyle/intern/system/PythonInterpreter.h | 3 +-- source/blender/freestyle/intern/system/RandGen.cpp | 3 +-- source/blender/freestyle/intern/system/RandGen.h | 3 +-- source/blender/freestyle/intern/system/RenderMonitor.h | 3 +-- source/blender/freestyle/intern/system/StringUtils.cpp | 3 +-- source/blender/freestyle/intern/system/StringUtils.h | 3 +-- source/blender/freestyle/intern/system/TimeStamp.cpp | 3 +-- source/blender/freestyle/intern/system/TimeStamp.h | 3 +-- source/blender/freestyle/intern/system/TimeUtils.h | 3 +-- 26 files changed, 26 insertions(+), 52 deletions(-) (limited to 'source/blender/freestyle/intern/system') diff --git a/source/blender/freestyle/intern/system/BaseIterator.h b/source/blender/freestyle/intern/system/BaseIterator.h index df79940c8f1..7a96e1de5fe 100644 --- a/source/blender/freestyle/intern/system/BaseIterator.h +++ b/source/blender/freestyle/intern/system/BaseIterator.h @@ -17,8 +17,7 @@ #ifndef __FREESTYLE_BASE_ITERATOR_H__ #define __FREESTYLE_BASE_ITERATOR_H__ -/** \file blender/freestyle/intern/system/BaseIterator.h - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Classes defining the basic "Iterator" design pattern */ diff --git a/source/blender/freestyle/intern/system/BaseObject.cpp b/source/blender/freestyle/intern/system/BaseObject.cpp index 0b88f071763..fd8529e53bf 100644 --- a/source/blender/freestyle/intern/system/BaseObject.cpp +++ b/source/blender/freestyle/intern/system/BaseObject.cpp @@ -14,8 +14,7 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/** \file blender/freestyle/intern/system/BaseObject.cpp - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Base Class for most shared objects (Node, Rep). Defines the addRef, release system. * \brief Inspired by COM IUnknown system. */ diff --git a/source/blender/freestyle/intern/system/BaseObject.h b/source/blender/freestyle/intern/system/BaseObject.h index d71d7815774..6cb3dd30f46 100644 --- a/source/blender/freestyle/intern/system/BaseObject.h +++ b/source/blender/freestyle/intern/system/BaseObject.h @@ -17,8 +17,7 @@ #ifndef __FREESTYLE_BASE_OBJECT_H__ #define __FREESTYLE_BASE_OBJECT_H__ -/** \file blender/freestyle/intern/system/BaseObject.h - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Base Class for most shared objects (Node, Rep). Defines the addRef, release system. * \brief Inspired by COM IUnknown system. */ diff --git a/source/blender/freestyle/intern/system/Cast.h b/source/blender/freestyle/intern/system/Cast.h index 78c53315366..ffc36372503 100644 --- a/source/blender/freestyle/intern/system/Cast.h +++ b/source/blender/freestyle/intern/system/Cast.h @@ -17,8 +17,7 @@ #ifndef __FREESTYLE_CAST_H__ #define __FREESTYLE_CAST_H__ -/** \file blender/freestyle/intern/system/Cast.h - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Cast function */ diff --git a/source/blender/freestyle/intern/system/Exception.cpp b/source/blender/freestyle/intern/system/Exception.cpp index 29ecd2ceb17..d386473d6be 100644 --- a/source/blender/freestyle/intern/system/Exception.cpp +++ b/source/blender/freestyle/intern/system/Exception.cpp @@ -14,8 +14,7 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/** \file blender/freestyle/intern/system/Exception.cpp - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Singleton to manage exceptions */ diff --git a/source/blender/freestyle/intern/system/Exception.h b/source/blender/freestyle/intern/system/Exception.h index 67e7e6414f8..3634a7a69da 100644 --- a/source/blender/freestyle/intern/system/Exception.h +++ b/source/blender/freestyle/intern/system/Exception.h @@ -17,8 +17,7 @@ #ifndef __FREESTYLE_EXCEPTION_H__ #define __FREESTYLE_EXCEPTION_H__ -/** \file blender/freestyle/intern/system/Exception.h - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Singleton to manage exceptions */ diff --git a/source/blender/freestyle/intern/system/FreestyleConfig.h b/source/blender/freestyle/intern/system/FreestyleConfig.h index a337d61c98f..a3660ac286d 100644 --- a/source/blender/freestyle/intern/system/FreestyleConfig.h +++ b/source/blender/freestyle/intern/system/FreestyleConfig.h @@ -17,8 +17,7 @@ #ifndef __FREESTYLE_CONFIG_H__ #define __FREESTYLE_CONFIG_H__ -/** \file blender/freestyle/intern/system/FreestyleConfig.h - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Configuration definitions */ diff --git a/source/blender/freestyle/intern/system/Id.h b/source/blender/freestyle/intern/system/Id.h index 5943f2522f0..0dc950bddea 100644 --- a/source/blender/freestyle/intern/system/Id.h +++ b/source/blender/freestyle/intern/system/Id.h @@ -17,8 +17,7 @@ #ifndef __FREESTYLE_ID_H__ #define __FREESTYLE_ID_H__ -/** \file blender/freestyle/intern/system/Id.h - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Identification system */ diff --git a/source/blender/freestyle/intern/system/Interpreter.h b/source/blender/freestyle/intern/system/Interpreter.h index 071fe48b920..6ac3c85fc87 100644 --- a/source/blender/freestyle/intern/system/Interpreter.h +++ b/source/blender/freestyle/intern/system/Interpreter.h @@ -17,8 +17,7 @@ #ifndef __FREESTYLE_INTERPRETER_H__ #define __FREESTYLE_INTERPRETER_H__ -/** \file blender/freestyle/intern/system/Interpreter.h - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Base Class of all script interpreters */ diff --git a/source/blender/freestyle/intern/system/Iterator.cpp b/source/blender/freestyle/intern/system/Iterator.cpp index d841dabbfdf..23bb26af93e 100644 --- a/source/blender/freestyle/intern/system/Iterator.cpp +++ b/source/blender/freestyle/intern/system/Iterator.cpp @@ -14,8 +14,7 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/** \file blender/freestyle/intern/system/Iterator.cpp - * \ingroup freestyle +/** \file \ingroup freestyle */ #include "Iterator.h" diff --git a/source/blender/freestyle/intern/system/Iterator.h b/source/blender/freestyle/intern/system/Iterator.h index f5f860f7433..65ae106a9f9 100644 --- a/source/blender/freestyle/intern/system/Iterator.h +++ b/source/blender/freestyle/intern/system/Iterator.h @@ -17,8 +17,7 @@ #ifndef __FREESTYLE_ITERATOR_H__ #define __FREESTYLE_ITERATOR_H__ -/** \file blender/freestyle/intern/system/Iterator.h - * \ingroup freestyle +/** \file \ingroup freestyle */ #include diff --git a/source/blender/freestyle/intern/system/PointerSequence.h b/source/blender/freestyle/intern/system/PointerSequence.h index dc108e40ceb..daa25d8d9ad 100644 --- a/source/blender/freestyle/intern/system/PointerSequence.h +++ b/source/blender/freestyle/intern/system/PointerSequence.h @@ -17,8 +17,7 @@ #ifndef __FREESTYLE_POINTER_SEQUENCE_H__ #define __FREESTYLE_POINTER_SEQUENCE_H__ -/** \file blender/freestyle/intern/system/PointerSequence.h - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Simple RAII wrappers for std:: sequential containers * * PointerSequence diff --git a/source/blender/freestyle/intern/system/Precision.h b/source/blender/freestyle/intern/system/Precision.h index 301e3ccf78b..c9d043754df 100644 --- a/source/blender/freestyle/intern/system/Precision.h +++ b/source/blender/freestyle/intern/system/Precision.h @@ -17,8 +17,7 @@ #ifndef __FREESTYLE_PRECISION_H__ #define __FREESTYLE_PRECISION_H__ -/** \file blender/freestyle/intern/system/Precision.h - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Define the float precision used in the program */ diff --git a/source/blender/freestyle/intern/system/ProgressBar.h b/source/blender/freestyle/intern/system/ProgressBar.h index b0eee2a0224..3311ed5735e 100644 --- a/source/blender/freestyle/intern/system/ProgressBar.h +++ b/source/blender/freestyle/intern/system/ProgressBar.h @@ -17,8 +17,7 @@ #ifndef __FREESTYLE_PROGRESS_BAR_H__ #define __FREESTYLE_PROGRESS_BAR_H__ -/** \file blender/freestyle/intern/system/ProgressBar.h - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Class to encapsulate a progress bar */ diff --git a/source/blender/freestyle/intern/system/PseudoNoise.cpp b/source/blender/freestyle/intern/system/PseudoNoise.cpp index 3a753fb2e1a..ac5a2974d1a 100644 --- a/source/blender/freestyle/intern/system/PseudoNoise.cpp +++ b/source/blender/freestyle/intern/system/PseudoNoise.cpp @@ -14,8 +14,7 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/** \file blender/freestyle/intern/system/PseudoNoise.cpp - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Class to define a pseudo Perlin noise */ diff --git a/source/blender/freestyle/intern/system/PseudoNoise.h b/source/blender/freestyle/intern/system/PseudoNoise.h index 86616bdee3f..a44aea28149 100644 --- a/source/blender/freestyle/intern/system/PseudoNoise.h +++ b/source/blender/freestyle/intern/system/PseudoNoise.h @@ -17,8 +17,7 @@ #ifndef __FREESTYLE_PSEUDO_NOISE_H__ #define __FREESTYLE_PSEUDO_NOISE_H__ -/** \file blender/freestyle/intern/system/PseudoNoise.h - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Class to define a pseudo Perlin noise */ diff --git a/source/blender/freestyle/intern/system/PythonInterpreter.cpp b/source/blender/freestyle/intern/system/PythonInterpreter.cpp index bbec6a70af6..819db7e936c 100644 --- a/source/blender/freestyle/intern/system/PythonInterpreter.cpp +++ b/source/blender/freestyle/intern/system/PythonInterpreter.cpp @@ -14,8 +14,7 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/** \file blender/freestyle/intern/system/PythonInterpreter.cpp - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Python Interpreter */ diff --git a/source/blender/freestyle/intern/system/PythonInterpreter.h b/source/blender/freestyle/intern/system/PythonInterpreter.h index 52ec49f8222..64af19c9549 100644 --- a/source/blender/freestyle/intern/system/PythonInterpreter.h +++ b/source/blender/freestyle/intern/system/PythonInterpreter.h @@ -17,8 +17,7 @@ #ifndef __FREESTYLE_PYTHON_INTERPRETER_H__ #define __FREESTYLE_PYTHON_INTERPRETER_H__ -/** \file blender/freestyle/intern/system/PythonInterpreter.h - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Python Interpreter */ diff --git a/source/blender/freestyle/intern/system/RandGen.cpp b/source/blender/freestyle/intern/system/RandGen.cpp index d6989037366..4dd859980c1 100644 --- a/source/blender/freestyle/intern/system/RandGen.cpp +++ b/source/blender/freestyle/intern/system/RandGen.cpp @@ -14,8 +14,7 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/** \file blender/freestyle/intern/system/RandGen.cpp - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Pseudo-random number generator */ diff --git a/source/blender/freestyle/intern/system/RandGen.h b/source/blender/freestyle/intern/system/RandGen.h index 05e93cb8a61..656321f591d 100644 --- a/source/blender/freestyle/intern/system/RandGen.h +++ b/source/blender/freestyle/intern/system/RandGen.h @@ -17,8 +17,7 @@ #ifndef __FREESTYLE_RAND_GEN_H__ #define __FREESTYLE_RAND_GEN_H__ -/** \file blender/freestyle/intern/system/RandGen.h - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Pseudo-random number generator */ diff --git a/source/blender/freestyle/intern/system/RenderMonitor.h b/source/blender/freestyle/intern/system/RenderMonitor.h index 10693d59ef5..93a15580ce9 100644 --- a/source/blender/freestyle/intern/system/RenderMonitor.h +++ b/source/blender/freestyle/intern/system/RenderMonitor.h @@ -17,8 +17,7 @@ #ifndef __FREESTYLE_RENDER_MONITOR_H__ #define __FREESTYLE_RENDER_MONITOR_H__ -/** \file blender/freestyle/intern/system/RenderMonitor.h - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Classes defining the basic "Iterator" design pattern */ diff --git a/source/blender/freestyle/intern/system/StringUtils.cpp b/source/blender/freestyle/intern/system/StringUtils.cpp index b3acf62a5da..69f192e755c 100644 --- a/source/blender/freestyle/intern/system/StringUtils.cpp +++ b/source/blender/freestyle/intern/system/StringUtils.cpp @@ -14,8 +14,7 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/** \file blender/freestyle/intern/system/StringUtils.cpp - * \ingroup freestyle +/** \file \ingroup freestyle * \brief String utilities */ diff --git a/source/blender/freestyle/intern/system/StringUtils.h b/source/blender/freestyle/intern/system/StringUtils.h index da40e8f506c..7eb42da6bdc 100644 --- a/source/blender/freestyle/intern/system/StringUtils.h +++ b/source/blender/freestyle/intern/system/StringUtils.h @@ -17,8 +17,7 @@ #ifndef __FREESTYLE_STRING_UTILS_H__ #define __FREESTYLE_STRING_UTILS_H__ -/** \file blender/freestyle/intern/system/StringUtils.h - * \ingroup freestyle +/** \file \ingroup freestyle * \brief String utilities */ diff --git a/source/blender/freestyle/intern/system/TimeStamp.cpp b/source/blender/freestyle/intern/system/TimeStamp.cpp index 8ccfe885e7d..73fa49c3f0a 100644 --- a/source/blender/freestyle/intern/system/TimeStamp.cpp +++ b/source/blender/freestyle/intern/system/TimeStamp.cpp @@ -14,8 +14,7 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ -/** \file blender/freestyle/intern/system/TimeStamp.cpp - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Class defining a singleton used as timestamp */ diff --git a/source/blender/freestyle/intern/system/TimeStamp.h b/source/blender/freestyle/intern/system/TimeStamp.h index 9d1a8a17386..a4e7d0f4faf 100644 --- a/source/blender/freestyle/intern/system/TimeStamp.h +++ b/source/blender/freestyle/intern/system/TimeStamp.h @@ -17,8 +17,7 @@ #ifndef __FREESTYLE_TIME_STAMP_H__ #define __FREESTYLE_TIME_STAMP_H__ -/** \file blender/freestyle/intern/system/TimeStamp.h - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Class defining a singleton used as timestamp */ diff --git a/source/blender/freestyle/intern/system/TimeUtils.h b/source/blender/freestyle/intern/system/TimeUtils.h index db9f44ab300..bf58a6a62cd 100644 --- a/source/blender/freestyle/intern/system/TimeUtils.h +++ b/source/blender/freestyle/intern/system/TimeUtils.h @@ -17,8 +17,7 @@ #ifndef __FREESTYLE_TIME_UTILS_H__ #define __FREESTYLE_TIME_UTILS_H__ -/** \file blender/freestyle/intern/system/TimeUtils.h - * \ingroup freestyle +/** \file \ingroup freestyle * \brief Class to measure elapsed time */ -- cgit v1.2.3