STYLE: emit warning about using deprecated "~OpenFOAM" expansion

- Within strings it is preferable to use the "<etc>" instead.
  Most use cases for the old "~OpenFOAM" expansion have been obsoleted
  by the #includeEtc directive.
This commit is contained in:
Mark Olesen
2018-11-23 13:12:33 +01:00
parent ac03307258
commit 1456a8ca1d
6 changed files with 34 additions and 11 deletions

View File

@ -228,7 +228,6 @@ namespace stringOps
// -# tilde expansion
// - leading "~/" : home directory
// - leading "~user" : home directory for specified user
// - leading "~OpenFOAM" : user/group/other OpenFOAM directory
//
// Supports default and alternative values as per the POSIX shell.
// \code
@ -245,6 +244,9 @@ namespace stringOps
// - Malformed entries (eg, brace mismatch, sigil followed by bad chars)
// are left as is.
//
// \note Deprecated(2018-11) Use "<etc>" instead of the rarely used
// "~OpenFOAM" expansion
//
// \sa
// Foam::findEtcFile
string expand
@ -268,7 +270,6 @@ namespace stringOps
// -# tilde expansion
// - leading "~/" : home directory
// - leading "~user" : home directory for specified user
// - leading "~OpenFOAM" : user/group/other OpenFOAM directory
//
// Supports default and alternative values as per the POSIX shell.
// \code
@ -285,6 +286,9 @@ namespace stringOps
// - Malformed entries (eg, brace mismatch, sigil followed by bad chars)
// are left as is.
//
// \note Deprecated(2018-11) Use "<etc>" instead of the rarely used
// "~OpenFOAM" expansion
//
// \sa
// Foam::findEtcFile
void inplaceExpand