DOC: refer string::expand documentation to stringOps::expand

This commit is contained in:
Mark Olesen
2019-08-07 14:45:06 +02:00
committed by Andrew Heather
parent 22cefff4a8
commit e95ab402fd
3 changed files with 10 additions and 14 deletions

View File

@ -564,7 +564,7 @@ public:
inline void operator=(compound* compoundPtr); inline void operator=(compound* compoundPtr);
//- Deprecated(2016-05) transfer word pointer to the token //- Deprecated(2017-11) transfer word pointer to the token
// \deprecated(2017-11) - use move assign from word // \deprecated(2017-11) - use move assign from word
inline void operator=(word* wordPtr); inline void operator=(word* wordPtr);

View File

@ -2,7 +2,7 @@
========= | ========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | \\ / O peration |
\\ / A nd | Copyright (C) 2016-2018 OpenCFD Ltd. \\ / A nd | Copyright (C) 2016-2019 OpenCFD Ltd.
\\/ M anipulation | \\/ M anipulation |
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
| Copyright (C) 2011-2016 OpenFOAM Foundation | Copyright (C) 2011-2016 OpenFOAM Foundation
@ -239,16 +239,8 @@ public:
const size_type start = 0 const size_type start = 0
); );
//- Expand initial tildes and all occurrences of environment variables //- Inplace expand initial tags, tildes, and all occurrences of
// Expansion includes: //- environment variables as per stringOps::expand
// -# environment variables
// - "$VAR", "${VAR}"
// -# current directory
// - leading "./" : the current directory
// -# tilde expansion
// - leading "~/" : home directory
// - leading "~user" : home directory for specified user
// - leading "~OpenFOAM" : site/user OpenFOAM configuration directory
// //
// Any unknown entries are removed silently if allowEmpty is true // Any unknown entries are removed silently if allowEmpty is true
// \sa // \sa

View File

@ -216,7 +216,9 @@ namespace stringOps
); );
//- Expand initial tildes and all occurrences of environment variables //- Expand initial tags, tildes, and all occurrences of environment
//- variables
//
// Expansion includes: // Expansion includes:
// -# environment variables // -# environment variables
// - "$VAR", "${VAR}" // - "$VAR", "${VAR}"
@ -273,7 +275,9 @@ namespace stringOps
); );
//- Expand initial tildes and all occurrences of environment variables //- Expand initial tags, tildes, and all occurrences of environment
//- variables
//
// Expansion includes: // Expansion includes:
// -# environment variables // -# environment variables
// - "$VAR", "${VAR}" // - "$VAR", "${VAR}"