aboutsummaryrefslogtreecommitdiff
path: root/Source/Utils/Parser/IntervalsParser.H
diff options
context:
space:
mode:
authorGravatar David Grote <grote1@llnl.gov> 2022-12-19 05:43:16 -0800
committerGravatar GitHub <noreply@github.com> 2022-12-19 14:43:16 +0100
commitc3eb6ea1efeff3910e8520d94e260d94367d68f7 (patch)
treeaf59d4a61a92fc602ca224e0fdd45685960de433 /Source/Utils/Parser/IntervalsParser.H
parent4913d07348eeed38263745a47ffe3a9f9a680076 (diff)
downloadWarpX-c3eb6ea1efeff3910e8520d94e260d94367d68f7.tar.gz
WarpX-c3eb6ea1efeff3910e8520d94e260d94367d68f7.tar.zst
WarpX-c3eb6ea1efeff3910e8520d94e260d94367d68f7.zip
Clean up documentation (#3542)
* Fix comments for documentation * More fixes to comments for documentation * Fixes in the doc files * Fix typo in parameters.rst
Diffstat (limited to 'Source/Utils/Parser/IntervalsParser.H')
-rw-r--r--Source/Utils/Parser/IntervalsParser.H1
1 files changed, 1 insertions, 0 deletions
diff --git a/Source/Utils/Parser/IntervalsParser.H b/Source/Utils/Parser/IntervalsParser.H
index f590139b3..329e114bb 100644
--- a/Source/Utils/Parser/IntervalsParser.H
+++ b/Source/Utils/Parser/IntervalsParser.H
@@ -31,6 +31,7 @@ namespace utils::parser
* Any of these integers may be omitted in which case it will be equal to their default value
* (0 for the starting point, std::numeric_limits<int>::max() for the stopping point and 1 for
* the period). For example SliceParser(":1000:") is equivalent to SliceParser("0:1000:1").
+ * @param[in] isBTD whether this is a back-transformed diagnostic
*/
SliceParser (const std::string& instr, bool isBTD=false);