refactor member variables and template naming (#234)

ikarus-project · Feb 6, 2024 · 269b7cf · 269b7cf
1 parent 4557552
commit 269b7cf
Show file tree

Hide file tree

Showing 77 changed files with 2,858 additions and 2,900 deletions.
diff --git a/docs/website/03_contribution/howToEdit.md b/docs/website/03_contribution/howToEdit.md
@@ -63,10 +63,10 @@ double complicatedCalculation(double number, double anotherNumber)
 
 Look at the Markdown file (`03_contribution/howToEdit.md`) to see how tables, warnings and notes can be inserted.
 
-| Grid Entity Interface        ||
-| :------------ | :-----------: |
-| `#!cpp GridViewType leafGridView()`     |
-| `#!cpp GridViewType levelGridView(int level)`     |
+|          Grid Entity Interface                   |
+|:------------------------------------------------:|
+|       `#!cpp GridViewType leafGridView()`        |
+|  `#!cpp GridViewType levelGridView(int level)`   |
 
 !!! warning "Insert a warning"
     Note that the **four** spaces at the beginning of this line are essential for the warning to be displayed

diff --git a/docs/website/doxygen/modules.hh b/docs/website/doxygen/modules.hh
@@ -2,76 +2,76 @@
 // SPDX-License-Identifier: LGPL-3.0-or-later
 
 /**
- * @defgroup group_main Ikarus Modules
- * @brief All Ikarus modules
+ * \defgroup group_main Ikarus Modules
+ * \brief All Ikarus modules
  *
  * @{
  */
 
-/**  @defgroup assembler Assembler
-@brief All finite element assembler
+/**  \defgroup assembler Assembler
+\brief All finite element assembler
 */
-/**  @defgroup controlroutines Control Routines
-@brief Routines to follow a non-linear solution curve
+/**  \defgroup controlroutines Control Routines
+\brief Routines to follow a non-linear solution curve
  */
 
-/**  @defgroup finiteelements Finite Elements
-@brief Local assemblers for linear algebra contributions to the global system
+/**  \defgroup finiteelements Finite Elements
+\brief Local assemblers for linear algebra contributions to the global system
  * @{
  */
-/**  @defgroup mechanics Mechanics
-@brief All finite elements in the context of mechanics
+/**  \defgroup mechanics Mechanics
+\brief All finite elements in the context of mechanics
 */
-/** @defgroup Affordancestags FE Affordance Tags
-@brief All finite element affordances
+/** \defgroup Affordancestags FE Affordance Tags
+\brief All finite element affordances
 */
-/**  @defgroup FEParameterTags FE Parameter Tags
-@brief All finite element parameter tags
+/**  \defgroup FEParameterTags FE Parameter Tags
+\brief All finite element parameter tags
 */
 /** @} */
 
-/**  @defgroup materials Materials
-@brief Materials for mechanical simulations
+/**  \defgroup materials Materials
+\brief Materials for mechanical simulations
  * @{*/
-/**  @defgroup Materialtags Material Tags
-@brief All tags related to strain or stress types
+/**  \defgroup Materialtags Material Tags
+\brief All tags related to strain or stress types
 */
 /** @} */
 
-/**  @defgroup io IO
-@brief Functions for input and output
+/**  \defgroup io IO
+\brief Functions for input and output
  * @{*/
-/**  @defgroup resultevaluators Result Evaluator
-@brief Computation of finite element results using `calculateAt`
+/**  \defgroup resultevaluators Result Evaluator
+\brief Computation of finite element results using `calculateAt`
 */
 /** @} */
 
-/**  @defgroup pythonbindings Python bindings
-@brief Header for Python Bindings
+/**  \defgroup pythonbindings Python bindings
+\brief Header for Python Bindings
 */
 
-/**  @defgroup solvers Solver
-@brief Solvers for algebraic system of equations
+/**  \defgroup solvers Solver
+\brief Solvers for algebraic system of equations
 */
 
-/**  @defgroup observer Observer
-@brief Solvers for algebraic system of equations
+/**  \defgroup observer Observer
+\brief Solvers for algebraic system of equations
 */
 
-/**  @defgroup utils Utilities
-@brief Collection of several utilities
+/**  \defgroup utils Utilities
+\brief Collection of several utilities
 */
 
-/**  @defgroup tensor Tensor Utilities
-@brief Collection of several utilities for dealing with Eigen tensors
+/**  \defgroup tensor Tensor Utilities
+\brief Collection of several utilities for dealing with Eigen tensors
 */
 
-/**  @defgroup algos Algorithms
-@brief Stl-like algorithms for runtime and compile time
+/**  \defgroup algos Algorithms
+\brief Stl-like algorithms for runtime and compile time
 */
 
-/**  @defgroup traits Type traits
-@brief Type traits for TMP
+/**  \defgroup traits Type traits
+\brief Type traits for TMP
 */
 
 /** @} */