Commit e95ab402 authored by Mark OLESEN's avatar Mark OLESEN Committed by Andrew Heather
Browse files

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

parent 22cefff4
......@@ -564,7 +564,7 @@ public:
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
inline void operator=(word* wordPtr);
......
......@@ -2,7 +2,7 @@
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016-2018 OpenCFD Ltd.
\\ / A nd | Copyright (C) 2016-2019 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
| Copyright (C) 2011-2016 OpenFOAM Foundation
......@@ -239,16 +239,8 @@ public:
const size_type start = 0
);
//- Expand initial tildes and all occurrences of environment variables
// Expansion includes:
// -# 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
//- Inplace expand initial tags, tildes, and all occurrences of
//- environment variables as per stringOps::expand
//
// Any unknown entries are removed silently if allowEmpty is true
// \sa
......
......@@ -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:
// -# environment variables
// - "$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:
// -# environment variables
// - "$VAR", "${VAR}"
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment