From 9b379f285b6e53c0a7f020ced18e6c9367cf7734 Mon Sep 17 00:00:00 2001
From: dsiders
Date: Sun, 19 Nov 2023 05:14:00 +0000
Subject: [PATCH] Revert "Revert "Docs: LCL/lresources. Adds deprecation
notices in TUTF8Parser topics for changes in 5b65498e.""
This reverts commit 1c5aeb7cade691be903685e76ff2127015039291.
---
docs/xml/lcl/lresources.xml | 324 ++++++++++++++++++------------------
1 file changed, 161 insertions(+), 163 deletions(-)
diff --git a/docs/xml/lcl/lresources.xml b/docs/xml/lcl/lresources.xml
index fb05f982b6..4958351347 100644
--- a/docs/xml/lcl/lresources.xml
+++ b/docs/xml/lcl/lresources.xml
@@ -53,7 +53,7 @@ Author: Mattias Gaertner
-
+
@@ -1750,9 +1750,10 @@ pointer to the item data.
+
-Parser for UTF-8-encoded identifiers, string, and number literals.
+Deprecated. Parser for UTF-8-encoded identifiers, string, and number literals.
@@ -1786,71 +1787,34 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-
-The input stream.
+
+
+
+
+
+
+
+
+
+
+
+
+
+Deprecated. The name of a token, maybe the Token character itself.
+
Deprecated in LCL version 3.0. Use Classes.TParser instead.
-
-
-The allocated buffer.
-
-
-
-
-
-Number of valid chars (bytes) in the buffer.
-
-
-
-
-
-Current position (index) in the buffer.
-
-
-
-
-
-Buffer-relative begin of the current line.
-
-column = fPos - fLineStart + 1
-
-
-
-
-
-
-
-
-
-True when reached the end of the input stream.
-
-
-
-
-
-Holds the last parsed token text.
-
-
-
-
-
-The name of a token, maybe the Token character itself.
-
-
-
-
-
-
-
-
-
+
+
-Fills the buffer from the input stream.
+
+Deprecated. Fills the buffer from the input stream.
+
Deprecated in LCL version 3.0. Use Classes.TParser instead.
@@ -1859,7 +1823,9 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-Skips to the next non-null character.
+
+Deprecated. Skips to the next non-null character.
+
Deprecated in LCL version 3.0. Use Classes.TParser instead.
@@ -1868,7 +1834,9 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-Add the current character to the token string.
+
+Deprecated. Add the current character to the token string.
+
Deprecated in LCL version 3.0. Use Classes.TParser instead.
@@ -1877,89 +1845,89 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-True when the current character is a digit.
+
+Deprecated. True when the current character is a digit.
+
Deprecated in LCL version 3.0. Use Classes.TParser instead.
-
-
-
+
-True when the current character is a hex digit.
+
+Deprecated. True when the current character is a hex digit.
+
Deprecated in LCL version 3.0. Use Classes.TParser instead.
-
-
-
+
-True when the current character is an ASCII character (or underscore).
+Deprecated. True when the current character is an ASCII character (or
+underscore).
-Should mean: all allowed characters in an identifier.
-[To be updated for Unicode identifiers]
+
+Should mean: all allowed characters in an identifier.
+[To be updated for Unicode identifiers].
Deprecated in LCL version 3.0. Use Classes.TParser instead.
-
-
-
+
-True when the current character is a digit or IsAlpha.
+
+Deprecated. True when the current character is a digit or IsAlpha.
+
Deprecated in LCL version 3.0. Use Classes.TParser instead.
-
-
-
+
-Returns the value of a hex digit.
+
+Deprecated. Returns the value of a hex digit.
+
Deprecated in LCL version 3.0. Use Classes.TParser instead.
-
-
-
-
-
-
+
+
-Parses and returns an identifier.
+
+Deprecated. Parses and returns an identifier.
+
+
+Deprecated in LCL version 3.0. Use Classes.TParser instead.
+
EParserError when the current character is not valid for an identifier.
-
-Deprecated in LCL version 3.0. Use Classes.TParser instead.
-
-
-
-
+
-Skip CR/LF, adjust SourceLine.
+
+Deprecated. Skip CR/LF, adjust SourceLine.
+
Deprecated in LCL version 3.0. Use Classes.TParser instead.
@@ -1968,7 +1936,9 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-Skip space and tab chars.
+
+Deprecated. Skip space and tab chars.
+
Deprecated in LCL version 3.0. Use Classes.TParser instead.
@@ -1977,7 +1947,9 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-Skip all whitespace characters.
+
+Deprecated. Skip all whitespace characters.
+
Deprecated in LCL version 3.0. Use Classes.TParser instead.
@@ -1986,7 +1958,9 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-Marks end of input reached (fEofReached).
+
+Deprecated. Marks end of input reached (fEofReached).
+
Deprecated in LCL version 3.0. Use Classes.TParser instead.
@@ -1995,7 +1969,9 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-Parse an identifier.
+
+Deprecated. Parse an identifier.
+
Deprecated in LCL version 3.0. Use Classes.TParser instead.
@@ -2004,8 +1980,10 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-Parse a number,
-recognizing trailing floating point format specifiers.
+
+Deprecated. Parse a number, recognizing trailing floating point format
+specifiers.
+
Deprecated in LCL version 3.0. Use Classes.TParser instead.
@@ -2029,24 +2007,22 @@ EParserError when no valid hex digit was found.
-Parse an quoted string, excluding the leading and trailing quotes.
+Deprecated. Parse an quoted string, excluding the leading and trailing quotes.
-
-EParserError on an unterminated string literal.
-
Deprecated in LCL version 3.0. Use Classes.TParser instead.
+
+EParserError on an unterminated string literal.
+
-
-
-
+
-Parse an decimal Unicode codepoint, return it as an UTF-8 string.
+Deprecated. Parse an decimal Unicode codepoint, return it as an UTF-8 string.
@@ -2060,7 +2036,9 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-Parses a string literal.
+
+Deprecated. Parses a string literal.
+
The string can consist of quoted strings and Unicode codepoints.
@@ -2080,7 +2058,8 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-Tries to parse a negative number, or a single '-' character.
+
+Deprecated. Tries to parse a negative number, or a single '-' character.
@@ -2103,7 +2082,9 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-Constructor for the class instance.
+
+Deprecated. Constructor for the class instance.
+
Create is the constructor for the class instance.
@@ -2127,7 +2108,9 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-Destructor for the class instance.
+
+Deprecated. Destructor for the class instance.
+
Destroy is the overridden destructor for the class instance. It
@@ -2143,10 +2126,16 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-Asserts that Token is of the expected type.
+
+Deprecated. Asserts that Token is of the expected type.
+
+
+Deprecated in LCL version 4.0. Use Classes.TParser instead.
+
-EParserError when Token doesn't match the expected type.
+
+EParserError when Token doesn't match the expected type.
Deprecated in LCL version 3.0. Use Classes.TParser instead.
@@ -2157,11 +2146,16 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-Asserts that the given name was parsed (case insensitive).
+
+Deprecated. Asserts that the given name was parsed (case insensitive).
+
+Deprecated in LCL version 4.0. Use Classes.TParser instead.
+
-EParserError when Token doesn't match the expected type or name.
+
+EParserError when Token doesn't match the expected type or name.
Deprecated in LCL version 3.0. Use Classes.TParser instead.
@@ -2172,7 +2166,8 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-Raises an EParserError with the given message.
+
+Deprecated. Raises an EParserError with the given message.
@@ -2185,7 +2180,8 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-Raises an EParserError with the formatted message.
+
+Deprecated. Raises an EParserError with the formatted message.
@@ -2201,8 +2197,9 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-Raises an EParserError with the given message, adding source position
-information.
+
+Deprecated. Raises an EParserError with the given message, adding source
+position information.
@@ -2210,12 +2207,11 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-
-
-
+
-Writes an hex value into the output stream.
+
+Deprecated. Writes an hex value into the output stream.
@@ -2252,20 +2248,21 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-Returns the current position in the input stream.
+
+Deprecated. Returns the current position in the input stream.
+
Deprecated in LCL version 3.0. Use Classes.TParser instead.
-
-
-
+
-Parses an (possibly) qualified identifier, after a symbol has been parsed.
+Deprecated. Parses an (possibly) qualified identifier, after a symbol has been
+parsed.
@@ -2276,12 +2273,12 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-
-
-
+
-Returns the binary value of a floating point number.
+
+Deprecated. Returns the binary value of a floating point number.
+
EParserError on an invalid number.
@@ -2291,24 +2288,11 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-
-
-
+
-Returns the binary value of an integral number.
-
-
-Deprecated in LCL version 3.0. Use Classes.TParser instead.
-
-
-
-
-
-
-
-
-Returns the last parsed token as an string.
+
+Deprecated. Returns the binary value of an integral number.
@@ -2316,12 +2300,23 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-
-
+
+
+
+
+Deprecated. Returns the last parsed token as an string.
+
+
+
+Deprecated in LCL version 3.0. Use Classes.TParser instead.
+
+
+
-Compares the parsed symbol with the given string (case-insensitive).
+
+Deprecated. Compares the parsed symbol with the given string (case-insensitive).
@@ -2332,13 +2327,11 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
True when a matching symbol has been parsed.
-
-
-
+
-The type of the parsed floating point number. (number, date...).
+Deprecated. The type of the parsed floating point number. (number, date...).
@@ -2348,7 +2341,8 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-The current line number in the input stream.
+
+Deprecated. The current line number in the input stream.
@@ -2358,17 +2352,21 @@ Deprecated in LCL version 3.0. Use Classes.TParser instead.
-The current column number in the source line.
+
+Deprecated. The current column number in the source line.
+
+Deprecated in LCL version 4.0. Use Classes.TParser instead.
+
-
-
-
+
-The last parsed token type.
+
+Deprecated. The last parsed token type.
+
Deprecated in LCL version 3.0. Use Classes.TParser instead.
@@ -2382,7 +2380,7 @@ A queue to stream components, used for multi-threading or network.
-ConvertComponentAsString converts a component to binary format with a leading
+ConvertComponentAsString converts a component to binary format with leading
size information (using WriteLRSInt64MB).