Merge branch 'documentation' into 'master'

Documentation maintenance

See merge request walberla/walberla!479

src/field/StabilityChecker.h

@@ -13,7 +13,7 @@
 //  You should have received a copy of the GNU General Public License along
 //  with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
 //
-//! \file StabilityCheckerer.h
+//! \file StabilityChecker.h
 //! \ingroup field
 //! \author Florian Schornbaum <florian.schornbaum@fau.de>
 //

src/field/allocation/FieldAllocator.h

@@ -62,12 +62,14 @@ namespace field {
          /**
           * \brief Allocate memory for a field of given sizes and initializes reference counter with one
           *
-          * \param size*       The size of the field. size0*size1*size2*size*3 is the minimum amount of
+          * \param size0,size1,size2,size3
+          *                    The size of the field. size0*size1*size2*size3 is the minimum amount of
           *                    memory that has to be allocated. size0 is the size of the outermost (slowest)
           *                    coordinate, size3 the size of the fastest.
           *
-          * \param allocSize*  Output parameters. The actual size of the allocation may be bigger. Here
-          *                    allocSize can be bigger than size if alignment >0. There is no allocSize0,
+          * \param allocSize1,allocSize2,allocSize3
+          *                    Output parameters. The actual size of the allocation may be bigger. Here
+          *                    allocSize* can be bigger than size* if alignment >0. There is no allocSize0,
           *                    since extra allocations (padding) for the outer coordinate do not make sense.
           */
          T * allocate (  uint_t size0, uint_t size1, uint_t size2, uint_t size3,
@@ -116,7 +118,7 @@ namespace field {
          /**
           * \brief Increments the reference count for the given pointer
           *
-          * \param allocatedPointer a pointer that was returned by the allocate function
+          * \param mem a pointer that was returned by the allocate function
           *
           * The reference counter is the number of field objects that currently use the allocated
           * memory region
@@ -141,11 +143,11 @@ namespace field {
          /**
           * \brief Decrements the reference count for the given pointer
           *
-          * \param allocatedPointer a pointer that was returned by the allocate function
+          * \param mem a pointer that was returned by the allocate function
           *
           * A memory region is freed only when the reference count is zero.
-          * \return true if memory was freed,
-          *         false if some other field still uses the memory
+          * \return \a true if memory was freed,
+          *         \a false if some other field still uses the memory
           */
          bool decrementReferenceCount( T * mem )
          {

src/field/communication/ReducePackInfo.h

@@ -13,7 +13,7 @@
 //  You should have received a copy of the GNU General Public License along
 //  with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
 //
-//! \file ReduceFieldPackInfo.h
+//! \file ReducePackInfo.h
 //! \ingroup field
 //! \author Matthias Markl <matthias.markl@fau.de>
 //! \brief Stores/reduces ghost layers to/from a communication buffer

src/field/communication/StencilRestrictedPackInfo.h

@@ -13,7 +13,7 @@
 //  You should have received a copy of the GNU General Public License along
 //  with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
 //
-//! \file PdfFieldPackInfo.h
+//! \file StencilRestrictedPackInfo.h
 //! \ingroup lbm
 //! \author Martin Bauer <martin.bauer@fau.de>
 //! \author Florian Schornbaum <florian.schornbaum@fau.de>

src/field/iterators/FieldIterator.impl.h

@@ -304,6 +304,7 @@ inline bool FieldIterator<T,fs>::operator!=( const FieldIterator<T,fs>& it ) con
 //**********************************************************************************************************************
 /*!\brief Neighbor access relative to current position
  * \param d Direction enumeration which defines deltas for x,y,z
+ * \param cf Delta for f
  **********************************************************************************************************************/
 template <typename T, uint_t fs>
 inline T & FieldIterator<T,fs>::neighbor( stencil::Direction d, cell_idx_t cf ) const
@@ -315,6 +316,8 @@ inline T & FieldIterator<T,fs>::neighbor( stencil::Direction d, cell_idx_t cf )
 
 //**********************************************************************************************************************
 /*!\brief uint_t variant of above function
+ * \param d Direction enumeration which defines deltas for x,y,z
+ * \param cf Delta for f
  **********************************************************************************************************************/
 template <typename T, uint_t fs>
 inline T & FieldIterator<T,fs>::neighbor( stencil::Direction d, uint_t cf ) const
@@ -325,7 +328,10 @@ inline T & FieldIterator<T,fs>::neighbor( stencil::Direction d, uint_t cf ) cons
 
 //**********************************************************************************************************************
 /*!\brief Neighbor access relative to current position
- * \param d Direction enumeration which defines deltas for x,y,z,f
+ * \param cx Delta for x
+ * \param cy Delta for y
+ * \param cz Delta for z
+ * \param cf Delta for f
  **********************************************************************************************************************/
 template <typename T, uint_t fs>
 inline T & FieldIterator<T,fs>::neighbor( cell_idx_t cx, cell_idx_t cy, cell_idx_t cz, cell_idx_t cf ) const
@@ -346,6 +352,10 @@ inline T & FieldIterator<T,fs>::neighbor( cell_idx_t cx, cell_idx_t cy, cell_idx
 //**********************************************************************************************************************
 /*!\brief Neighbor variant that takes unsigned int as f parameter,
  *        needed since the stencil toIdx() is an unsigned int
+ * \param cx Delta for x
+ * \param cy Delta for y
+ * \param cz Delta for z
+ * \param cf Delta for f
  **********************************************************************************************************************/
 template <typename T, uint_t fs>
 inline T & FieldIterator<T,fs>::neighbor( cell_idx_t cx, cell_idx_t cy, cell_idx_t cz, uint_t cf ) const
@@ -358,6 +368,7 @@ inline T & FieldIterator<T,fs>::neighbor( cell_idx_t cx, cell_idx_t cy, cell_idx
 //**********************************************************************************************************************
 /*!\brief For beginXYZ iterators, one often needs a specific f
  * Assumes that iterator stands at f==0
+ * \param cf Delta for f
  **********************************************************************************************************************/
 template <typename T, uint_t fs>
 inline  T & FieldIterator<T,fs>::getF( cell_idx_t cf ) const
@@ -373,6 +384,7 @@ inline  T & FieldIterator<T,fs>::getF( cell_idx_t cf ) const
 //**********************************************************************************************************************
 /*!\brief Equivalent to neighbor(cell_idx_t) see above.
  *        Takes an uint_t instead a cell_idx_t, since stencil::toIndex() returns uint_t
+ * \param cf Delta for f
  **********************************************************************************************************************/
 template <typename T, uint_t fs>
 inline  T & FieldIterator<T,fs>::getF( uint_t cf ) const

src/field/vtk/VTKWriter.h

@@ -60,8 +60,8 @@ namespace field {
 * \param continuousNumbering  important when writeFrequency > 1,  if true the simulation steps are numbered continuously
 *                             otherwise they are numbered after the timestep
 * \param binary               switch for binary output
-* \param litteEndian          byte order
-* \param simultaneousIOOps    number of simultaneous IO operations, 0 means all processes write concurrently
+* \param littleEndian         byte order
+* \param simultaneousIOOperations    number of simultaneous IO operations, 0 means all processes write concurrently
 *                             limiting the number of simultaneous IO operations makes sense for huge number of processes
 *                             in order to not overload the file system
 * \param requiredStates       see selectable concept

src/gather/CellGatherPackInfo.h

@@ -64,7 +64,7 @@ public:
    *
    * \param bs          StructuredBlockStorage containing the field
    * \param fieldID     BlockDataID of the field that should be collected
-   * \param container   Container of cells in global coordinates, order of cells is important for output
+   * \param containerOfGlobalCells   Container of cells in global coordinates, order of cells is important for output
    * \param dp          data processor where gathered data is delivered to
    */
    //*******************************************************************************************************************

src/geometry/bodies/Ellipsoid.h

@@ -50,7 +50,7 @@ namespace geometry {
       /*************************************************************************************************************//**
       *  Ellipsoid constructor
       *
-      *  \param midpoin t   midpoint of the ellipsoid
+      *  \param midpoint    midpoint of the ellipsoid
       *  \param axis1       the first semi-axis of the ellipsoid ( associated with radius1 )
       *                     not required to be normalized, is normalized internally
       *  \param axis2       second semi-axis (must not be parallel to axis1 ) should ideally be perpendicular to axis1

src/geometry/initializer/BoundaryFromImage.impl.h

@@ -13,7 +13,7 @@
 //  You should have received a copy of the GNU General Public License along
 //  with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
 //
-//! \file BoundaryFromImage.impl
+//! \file BoundaryFromImage.impl.h
 //! \ingroup geometry
 //! \author Martin Bauer <martin.bauer@fau.de>
 //

src/geometry/initializer/BoundarySetter.h

@@ -13,7 +13,7 @@
 //  You should have received a copy of the GNU General Public License along
 //  with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
 //
-//! \file Helper.h
+//! \file BoundarySetter.h
 //! \ingroup geometry
 //! \author Martin Bauer <martin.bauer@fau.de>
 //

src/geometry/initializer/BoundarySetterFlagFieldSpecialization.h

@@ -13,7 +13,7 @@
 //  You should have received a copy of the GNU General Public License along
 //  with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
 //
-//! \file Helper.h
+//! \file BoundarySetterFlagFieldSpecialization.h
 //! \ingroup geometry
 //! \author Martin Bauer <martin.bauer@fau.de>
 //

src/geometry/initializer/ScalarFieldFromBody.h

@@ -107,11 +107,10 @@ namespace initializer {
       * \param body       The body object - has to implement either overlapFraction(...), or contains(...)
       *                   see BodyOverlapFunctions for detailed body concept
       * \param value      The value to set on the matched cells in the field.
-      * \param parser     A function parser which will have the variables x,y,z bound before it is evaluated
       * \param addOrSet   If true, the value is added to scalar field
       *                   If false, the value is set on the scalar field.
       * \param id         If operating on a vector of fields, which field to treat. Zero otherwise.
-
+      *
       *  Supported bodies are Sphere, Ellipsoid, AABB.
       *  To add a new supported body implement concept defined in BodyOverlapFunctions.h, and
       *  add an explicit template instantiation in ScalarFieldFromBody.cpp for the new body.
@@ -119,6 +118,21 @@ namespace initializer {
       *****************************************************************************************************************/
       template<typename Body>
       void init( const Body & body, Value_T value, bool addOrSet, std::vector<BlockDataID>::size_type id = 0 );
+      /*************************************************************************************************************//**
+      * Sets a body on the scalar field
+      *
+      * \param body       The body object - has to implement either overlapFraction(...), or contains(...)
+      *                   see BodyOverlapFunctions for detailed body concept
+      * \param parser     A function parser which will have the variables x,y,z bound before it is evaluated
+      * \param addOrSet   If true, the value is added to scalar field
+      *                   If false, the value is set on the scalar field.
+      * \param id         If operating on a vector of fields, which field to treat. Zero otherwise.
+      *
+      *  Supported bodies are Sphere, Ellipsoid, AABB.
+      *  To add a new supported body implement concept defined in BodyOverlapFunctions.h, and
+      *  add an explicit template instantiation in ScalarFieldFromBody.cpp for the new body.
+      *
+      *****************************************************************************************************************/
       template<typename Body>
       void init( const Body & body, math::FunctionParser & parser, bool addOrSet, std::vector<BlockDataID>::size_type id = 0 );
 

src/geometry/initializer/ScalarFieldFromBody.impl.h

@@ -13,7 +13,7 @@
 //  You should have received a copy of the GNU General Public License along
 //  with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
 //
-//! \file ScalarFieldFromBody.cpp
+//! \file ScalarFieldFromBody.impl.h
 //! \ingroup geometry
 //! \author Michael Kuron <mkuron@icp.uni-stuttgart.de>
 //

src/geometry/initializer/ScalarFieldFromCellInterval.h

@@ -65,7 +65,7 @@ class ScalarFieldFromCellInterval : public Initializer
 public:
 
    typedef typename Field_T::value_type Value_T;
-	
+
    ScalarFieldFromCellInterval( StructuredBlockStorage & blocks, BlockDataID fieldId )
       : ScalarFieldFromCellInterval(blocks, std::vector<BlockDataID>(1, fieldId))
    {}
@@ -86,10 +86,16 @@ public:
    *
    * \param interval             the cell interval
    * \param value                which value to set in the field for all cells in the interval
-   * \param parser               a function parser which will have the variables x,y,z bound before it is evaluated
    * \param id                   which field to operate on (if operating on a vector of fields), defaults to 0
    *****************************************************************************************************************/
    void init( const CellInterval & interval, Value_T value, std::vector<BlockDataID>::size_type id = 0 );
+   /*************************************************************************************************************//**
+   * Function for manually setting a scalar field on a CellInterval
+   *
+   * \param interval             the cell interval
+   * \param parser               a function parser which will have the variables x,y,z bound before it is evaluated
+   * \param id                   which field to operate on (if operating on a vector of fields), defaults to 0
+   *****************************************************************************************************************/
    void init( const CellInterval & interval, math::FunctionParser & parser, std::vector<BlockDataID>::size_type id = 0 );
 
 

src/geometry/mesh/TriangleMeshIO.h

@@ -35,7 +35,7 @@ namespace geometry {
     *
     * Mesh format is detected by file ending.
     *
-    * \param fileName  Filename of mesh. Supported formats are obj, pov and off. Format is detected
+    * \param meshFilename  Filename of mesh. Supported formats are obj, pov and off. Format is detected
     *                  by file ending
     * \param mesh      object where the mesh is stored, if the given mesh is not
     *                  empty, all contents are cleared
@@ -47,7 +47,7 @@ namespace geometry {
     *
     * Mesh format is detected by file ending.
     *
-    * \param fileName  Filename of mesh. Supported formats are obj, pov and off. Format is detected
+    * \param meshFilename  Filename of mesh. Supported formats are obj, pov and off. Format is detected
     *                  by file ending
     * \param mesh      object where the mesh is read from
     */
@@ -58,7 +58,7 @@ namespace geometry {
     *
     * Mesh format is detected by file ending.
     *
-    * \param fileName  Filename of mesh. Supported formats are obj, pov and off. Format is detected
+    * \param meshFilename  Filename of mesh. Supported formats are obj, pov and off. Format is detected
     *                  by file ending
     * \param mesh      object where the mesh is stored, if the given mesh is not
     *                  empty, all contents are cleared
@@ -72,7 +72,7 @@ namespace geometry {
     *
     * Mesh format is detected by file ending.
     *
-    * \param fileName  Filename of mesh. Supported formats are obj, pov and off. Format is detected
+    * \param meshFilename  Filename of mesh. Supported formats are obj, pov and off. Format is detected
     *                  by file ending
     * \param mesh      object where the mesh is read from
     */

src/geometry/structured/BasicVoxelFileReader.impl.h

@@ -49,7 +49,7 @@ BasicVoxelFileReader<T>::BasicVoxelFileReader() : xSize_(0), ySize_(0), zSize_(0
 /*******************************************************************************************************************//**
  * \brief Opens an existing geometry file.
  *
- * \param filename Name (path) of the file.
+ * \param _filename Name (path) of the file.
  *
  * \throws std::runtime_error on I/O errors.
  *
@@ -73,11 +73,11 @@ BasicVoxelFileReader<T>::BasicVoxelFileReader( const std::string & _filename)
 /*******************************************************************************************************************//**
  * \brief Creates a new geometry file with extends xSize x ySize x zSize.
  *
- * \param filename Name (path) of the file.
- * \param xSize    Extend of the geometry file in x direction.
- * \param ySize    Extend of the geometry file in y direction.
- * \param zSize    Extend of the geometry file in z direction.
- * \param value    The value the cells are initialized with. Defaults to T().
+ * \param _filename Name (path) of the file.
+ * \param _xSize    Extend of the geometry file in x direction.
+ * \param _ySize    Extend of the geometry file in y direction.
+ * \param _zSize    Extend of the geometry file in z direction.
+ * \param value     The value the cells are initialized with. Defaults to T().
  *
  * \throws std::runtime_error on I/O errors.
  *
@@ -101,12 +101,12 @@ BasicVoxelFileReader<T>::BasicVoxelFileReader( const std::string & _filename, st
 /*******************************************************************************************************************//**
  * \brief Creates a new geometry file with extends xSize x ySize x zSize.
  *
- * \param filename Name (path) of the file.
- * \param xSize    Extend of the geometry file in x direction.
- * \param ySize    Extend of the geometry file in y direction.
- * \param zSize    Extend of the geometry file in z direction.
- * \param values   An array of size xSize * ySize * zSize with the values to initialize the
- * 					 geometry file with.
+ * \param _filename Name (path) of the file.
+ * \param _xSize    Extend of the geometry file in x direction.
+ * \param _ySize    Extend of the geometry file in y direction.
+ * \param _zSize    Extend of the geometry file in z direction.
+ * \param values    An array of size xSize * ySize * zSize with the values to initialize the
+ *                  geometry file with.
  *
  * \throws std::runtime_error on I/O errors.
  *
@@ -145,9 +145,9 @@ BasicVoxelFileReader<T>::~BasicVoxelFileReader()
 /*******************************************************************************************************************//**
 * \brief Opens an existing geometry file.
 *
-* 	An already opened file gets closed beforehand.
+* An already opened file gets closed beforehand.
 *
-* \param filename Name (path) of the file.
+* \param _filename Name (path) of the file.
 *
 * \throws std::runtime_error on I/O errors.
 * \throws std::runtime_error if the loaded geometry file's format is corrupt
@@ -223,11 +223,11 @@ void BasicVoxelFileReader<T>::open( const std::string & _filename )
  *
  * An already opened file gets closed beforehand.
  *
- * \param filename Name (path) of the file.
- * \param xSize    Extend of the geometry file in x direction.
- * \param ySize    Extend of the geometry file in y direction.
- * \param zSize    Extend of the geometry file in z direction.
- * \param value    The value the cells are initialized with. Defaults to T().
+ * \param _filename Name (path) of the file.
+ * \param _xSize    Extend of the geometry file in x direction.
+ * \param _ySize    Extend of the geometry file in y direction.
+ * \param _zSize    Extend of the geometry file in z direction.
+ * \param value     The value the cells are initialized with. Defaults to T().
  *
  * \throws std::runtime_error on I/O errors.
  *
@@ -296,12 +296,12 @@ void BasicVoxelFileReader<T>::create( const std::string & _filename, std::size_t
  *
  * An already opened file gets closed beforehand.
  *
- * \param filename Name (path) of the file.
- * \param xSize    Extend of the geometry file in x direction.
- * \param ySize    Extend of the geometry file in y direction.
- * \param zSize    Extend of the geometry file in z direction.
- * \param values   An array of size xSize * ySize * zSize with the values to initialize the
- * 					 geometry file with.
+ * \param _filename Name (path) of the file.
+ * \param _xSize    Extend of the geometry file in x direction.
+ * \param _ySize    Extend of the geometry file in y direction.
+ * \param _zSize    Extend of the geometry file in z direction.
+ * \param values    An array of size xSize * ySize * zSize with the values to initialize the
+ *                  geometry file with.
  *
  * \throws std::runtime_error on I/O errors.
  *
@@ -465,7 +465,7 @@ std::size_t BasicVoxelFileReader<T>::numCells() const
  *
  * \param cellAABB   The axis-aligned bounding box of the block of data to be read.
  * \param [out] data The vector the read data is stored to. The Storage order is zyx. (Meaning
- * 				      your innermost loop should iterate over x)
+ *                   your innermost loop should iterate over x)
  *
  * \throws std::runtime_error on I/O errors.
  *
@@ -522,7 +522,7 @@ void BasicVoxelFileReader<T>::read( const CellAABB & cellAABB, std::vector<T> &
  *
  * \param cellAABB The axis-aligned bounding box of the block of data to be written.
  * \param data     The vector holding the data to bw written to the geometry file. The Storage
- * 					 order is zyx. (Meaning your innermost loop should iterate over x)
+ *                 order is zyx. (Meaning your innermost loop should iterate over x)
  *
  * \throws std::runtime_error on I/O errors.
  *

src/geometry/structured/BinaryRawFile.cpp

@@ -13,7 +13,7 @@
 //  You should have received a copy of the GNU General Public License along
 //  with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
 //
-//! \file BinaryRawFileReader.cpp
+//! \file BinaryRawFile.cpp
 //! \ingroup geometry
 //! \author Christian Godenschwager <christian.godenschwager@fau.de>
 //

src/geometry/structured/BinaryRawFile.h

@@ -13,7 +13,7 @@
 //  You should have received a copy of the GNU General Public License along
 //  with waLBerla (see COPYING.txt). If not, see <http://www.gnu.org/licenses/>.
 //
-//! \file BinaryRawFileReader.h
+//! \file BinaryRawFile.h
 //! \ingroup geometry
 //! \author Christian Godenschwager <christian.godenschwager@fau.de>
 //

src/geometry/structured/VoxelFileReader.impl.h

@@ -41,7 +41,7 @@ catch( std::exception & e) { WALBERLA_ABORT( e.what() ); }
 /*******************************************************************************************************************//**
  * \brief Opens an existing geometry file.
  *
- * \param filename Name (path) of the file.
+ * \param _filename Name (path) of the file.
  *
  * \post isOpen() == true
  **********************************************************************************************************************/
@@ -53,11 +53,11 @@ catch( std::exception & e) { WALBERLA_ABORT( e.what() ); }
 /*******************************************************************************************************************//**
  * \brief Creates a new geometry file with extends xSize x ySize x zSize.
  *
- * \param filename Name (path) of the file.
- * \param xSize    Extend of the geometry file in x direction.
- * \param ySize    Extend of the geometry file in y direction.
- * \param zSize    Extend of the geometry file in z direction.
- * \param value    The value the cells are initialized with. Defaults to T().
+ * \param _filename Name (path) of the file.
+ * \param _xSize    Extend of the geometry file in x direction.
+ * \param _ySize    Extend of the geometry file in y direction.
+ * \param _zSize    Extend of the geometry file in z direction.
+ * \param value     The value the cells are initialized with. Defaults to T().
  *
  * \post isOpen() == true
  **********************************************************************************************************************/
@@ -73,12 +73,12 @@ catch( std::exception & e) { WALBERLA_ABORT( e.what() ); }
 /*******************************************************************************************************************//**
 * \brief Creates a new geometry file with extends xSize x ySize x zSize.
 *
-* \param filename Name (path) of the file.
-* \param xSize    Extend of the geometry file in x direction.
-* \param ySize    Extend of the geometry file in y direction.
-* \param zSize    Extend of the geometry file in z direction.
-* \param values   An array of size xSize * ySize * zSize with the values to initialize the
-* 					 geometry file with.
+* \param _filename Name (path) of the file.
+* \param _xSize    Extend of the geometry file in x direction.
+* \param _ySize    Extend of the geometry file in y direction.
+* \param _zSize    Extend of the geometry file in z direction.
+* \param values    An array of size xSize * ySize * zSize with the values to initialize the
+*                  geometry file with.
 *
 * \pre values != nullptr
 *
@@ -96,9 +96,9 @@ catch( std::exception & e) { WALBERLA_ABORT( e.what() ); }
 /*******************************************************************************************************************//**
 * \brief Opens an existing geometry file.
 *
-* 	An already opened file gets closed beforehand.
+* An already opened file gets closed beforehand.
 *
-* \param filename Name (path) of the file.
+* \param _filename Name (path) of the file.
 *
 * \post isOpen() == true
  **********************************************************************************************************************/
@@ -117,11 +117,11 @@ void VoxelFileReader<T>::open( const std::string & _filename )
  *
  * An already opened file gets closed beforehand.
  *
- * \param filename Name (path) of the file.
- * \param xSize    Extend of the geometry file in x direction.
- * \param ySize    Extend of the geometry file in y direction.
- * \param zSize    Extend of the geometry file in z direction.
- * \param value    The value the cells are initialized with. Defaults to T().
+ * \param _filename Name (path) of the file.
+ * \param _xSize    Extend of the geometry file in x direction.
+ * \param _ySize    Extend of the geometry file in y direction.
+ * \param _zSize    Extend of the geometry file in z direction.
+ * \param value     The value the cells are initialized with. Defaults to T().
  *
  * \post isOpen() == true
  **********************************************************************************************************************/
@@ -140,12 +140,12 @@ void VoxelFileReader<T>::create( const std::string & _filename, uint_t _xSize, u
  *
  * An already opened file gets closed beforehand.
  *
- * \param filename Name (path) of the file.
- * \param xSize    Extend of the geometry file in x direction.
- * \param ySize    Extend of the geometry file in y direction.
- * \param zSize    Extend of the geometry file in z direction.
- * \param values   An array of size xSize * ySize * zSize with the values to initialize the
- * 					 geometry file with.
+ * \param _filename Name (path) of the file.
+ * \param _xSize    Extend of the geometry file in x direction.
+ * \param _ySize    Extend of the geometry file in y direction.
+ * \param _zSize    Extend of the geometry file in z direction.
+ * \param values    An array of size xSize * ySize * zSize with the values to initialize the
+ *                  geometry file with.
  *
  * \pre values != nullptr
  *
@@ -259,7 +259,7 @@ uint_t VoxelFileReader<T>::zSize() const
  *
  * \param cellInterval The axis-aligned bounding box of the block of data to be read.
  * \param [out] data The vector the read data is stored to. The Storage order is zyx. (Meaning
- * 				      your innermost loop should iterate over x)
+ *              your innermost loop should iterate over x)
  *
  * \pre isOpen() == true
  *
@@ -279,7 +279,7 @@ void VoxelFileReader<T>::read( const CellInterval & cellInterval, std::vector<T>
  *
  * \param cellInterval The axis-aligned bounding box of the block of data to be written.
  * \param data     The vector holding the data to bw written to the geometry file. The Storage
- * 					 order is zyx. (Meaning your innermost loop should iterate over x)
+ *                 order is zyx. (Meaning your innermost loop should iterate over x)
  *
  * \pre isOpen() == true
  * \pre !cellInterval.empty()

src/gui/BlockSliceView/DisplayAdaptor.h

@@ -80,7 +80,7 @@ namespace gui {
        * Draws data structure represented by this Adaptor to a grid of cells
        * Block has to be set first!
        *
-       * @param [inout] grid           Grid of cells. Use functions of CellView to draw
+       * @param [in,out] grid          Grid of cells. Use functions of CellView to draw
        *                               The Grid has dimension of innerSize + ghostLayers
        * @param [in] nrOfGhostLayers   the number of ghost layers in each direction. This value may be bigger
        *                               than the returned value of configure() since other fields might have more ghost layers.
@@ -92,8 +92,6 @@ namespace gui {
 
       /**
        * Optionally adds a QTreeWidgetItem to a tree, containing configuration options
-       *
-       * @param parentItem the item where own items can be added
        */
       virtual void addConfigurationItem( QTreeWidgetItem *   ) {}