Correct the description of Lexer::getLongString

The fact that it does not work with tabs has been fixed long ago.
This commit is contained in:
Jean-Marc Lasgouttes 2023-01-10 16:25:48 +01:00
parent 253d532974
commit 8ec3397da3

View File

@ -138,12 +138,10 @@ public:
std::string const getString(bool trim = false) const;
///
docstring const getDocString(bool trim = false) const;
/** Get a long string, ended by the tag `endtoken'.
This string can span several lines. The first line
serves as a template for how many spaces the lines
are indented. This much white space is skipped from
each following line. This mechanism does not work
perfectly if you use tabs.
/** Get a long string, ended by the tag `endtoken'. This string
can span several lines. The first line serves as a template
for what sequence of tabs and spaces make up the indentation.
This prefix is skipped from each following line.
*/
docstring getLongString(docstring const & endtoken);