Merge branch 'suffa/DocFix' into 'master'

Fixed documentation of Environment class regarding parameter overriding on command line See merge request walberla/walberla!644
lssfau · Dec 15, 2023 · 0383b23 · 0383b23
2 parents fdee9cf + d6f7a22
commit 0383b23
Showing 1 changed file with 2 additions and 3 deletions.
diff --git a/src/core/Environment.h b/src/core/Environment.h
@@ -44,9 +44,8 @@ class Environment
    *
    * \param argc,argv  If command line parameters are present they have to contain at least
    *                   the path to the configuration file and optionally pairs of param-value:
-   *                   "-myParameter myValue"
-   *                   These values are then substituted in configuration files at
-   *                   positions marked with $(myParameter)
+   *                   "-blockName.parameterName=parameterValue"
+   *                   These values are then substituted in configuration files.
    *                   It is also possible to pass no command line options (see description below )
    *
    * If command line arguments are present the constructor initializes static objects