ENH: strip C/C++ comments from expressions by default

src/OpenFOAM/expressions/exprEntry/expressionEntry.C

@@ -361,12 +361,12 @@ Foam::exprTools::expressionEntry::getExpression
 (
     const word& name,
     const dictionary& dict,
-    const bool removeComments
+    const bool stripComments
 )
 {
     string str(dict.get<string>(name));
 
-    if (removeComments)
+    if (stripComments)
     {
         stringOps::inplaceRemoveComments(str);
     }

src/OpenFOAM/expressions/exprEntry/expressionEntry.H

@@ -141,13 +141,13 @@ public:
             const dictionary& dict
         );
 
-        //- Get and expand expression with dictionary entries
+        //- Get and expand expression with dictionary entries,
-        //  Optionally strip C/C++ comments from the input
+        //- and strip C/C++ comments from the input
         static expressions::exprString getExpression
         (
             const word& name,
             const dictionary& dict,
-            const bool removeComments = false
+            const bool stripComments = false
         );
 
 

src/OpenFOAM/expressions/exprString/exprString.C

@@ -35,10 +35,10 @@ Foam::expressions::exprString&
 Foam::expressions::exprString::expand
 (
     const dictionary& dict,
-    const bool removeComments
+    const bool stripComments
 )
 {
-    if (removeComments)
+    if (stripComments)
     {
         stringOps::inplaceRemoveComments(*this);
     }

src/OpenFOAM/expressions/exprString/exprString.H

@@ -83,31 +83,31 @@ public:
         //- Construct as copy of character array
         inline explicit exprString(const char* s, bool doValidate=true);
 
-        //- Copy construct and expand with dictionary variables
+        //- Copy construct and expand with dictionary variables,
-        //  Optionally strip C/C++ comments from the input
+        //- and strip C/C++ comments from the input
         inline exprString
         (
             const std::string& str,
             const dictionary& dict,
-            const bool removeComments = false
+            const bool stripComments = true
         );
 
-        //- Move construct and expand with dictionary variables
+        //- Move construct and expand with dictionary variables,
-        //  Optionally strip C/C++ comments from the input
+        //- and strip C/C++ comments from the input
         inline exprString
         (
             std::string&& str,
             const dictionary& dict,
-            const bool removeComments = false
+            const bool stripComments = true
         );
 
-        //- Construct from Istream and expand with dictionary variables
+        //- Construct from Istream and expand with dictionary variables,
-        //  Optionally strip C/C++ comments from the input
+        //- and strip C/C++ comments from the input
         inline exprString
         (
             Istream& is,
             const dictionary& dict,
-            const bool removeComments = false
+            const bool stripComments = true
         );
 
 
@@ -125,12 +125,12 @@ public:
         //  No expansions, know what you are doing.
         inline static exprString toExpr(std::string&& str);
 
-        //- Inplace expansion with dictionary variables
+        //- Inplace expansion with dictionary variables,
-        //  Optionally strip C/C++ comments from the input
+        //- and strip C/C++ comments from the input
         exprString& expand
         (
             const dictionary& dict,
-            const bool removeComments = false
+            const bool stripComments = true
         );
 
         //- Check for unexpanded '$' entries. Fatal if any exist.
@@ -145,13 +145,13 @@ public:
         //- Move assign
         exprString& operator=(exprString&& str) = default;
 
-        //- Copy assign from c-string (no expansions)
+        //- Copy assign from c-string. No expansions, no comment stripping
         inline exprString& operator=(const char* str);
 
-        //- Copy assign from string (no expansions)
+        //- Copy assign from string. No expansions, no comment stripping
         inline exprString& operator=(const std::string& str);
 
-        //- Move assign from string (no expansions)
+        //- Move assign from string. No expansions, no comment stripping
         inline exprString& operator=(std::string&& str);
 };