diff --git a/docs/xml/lazutils/lazstringutils.xml b/docs/xml/lazutils/lazstringutils.xml index e09e71c96a..46d1c2b87d 100644 --- a/docs/xml/lazutils/lazstringutils.xml +++ b/docs/xml/lazutils/lazstringutils.xml @@ -99,7 +99,7 @@ - True when the string starts with the specified sub-text. + True when the string starts with the specified sub-text. Value to look for at the start of the text. @@ -127,7 +127,7 @@ - True when the string ends with the specified value. + True when the string ends with the specified value. Text to look for at the end of the string. @@ -155,7 +155,7 @@ - True when the sub-text is at the start of the string value. + True when the sub-text is at the start of the string value. Value to locate at the start of the string. @@ -174,7 +174,7 @@ LazEndsText casts the values in ASubText and AText to PChar types, and calls StrLIComp to perform a case-insensitive comparison for the number of characters in ASubText at the end of the value in AText.

- The return value is True when AText ends with the value in ASubText. The return value is True when ASubText is an empty string (''); this is Delphi compatible. It is False when StrLIComp returns a non-zero value, or when ASubText is longer than AText. + The return value is True when AText ends with the value in ASubText. The return value is True when ASubText is an empty string (''); this is Delphi compatible. It is False when StrLIComp returns a non-zero value, or when ASubText is longer than AText.

@@ -183,7 +183,7 @@ - True when the sub-text is at the end of the string value. + True when the sub-text is at the end of the string value. Value to locate at the end of the string. @@ -227,12 +227,12 @@ - True when characters in S are in the range '0'..'9' + True when characters in S are in the range '0'..'9' - True when characters in S are in the range '0'..'9' + True when characters in S are in the range '0'..'9' String with values examined in the routine. @@ -334,7 +334,7 @@ - String value after converting Tab characters to spaces. + String value after converting Tab characters to spaces. String with values updated in the routine. @@ -343,7 +343,7 @@ Number of space characters to use for each Tab character. - True when UTF-8 codepoints are used to convert individual characters. + True when UTF-8 codepoints are used to convert individual characters. @@ -388,7 +388,9 @@ - Creates a regular expression from a filter expression used in IDE dialogs. + + Creates a regular expression from a filter expression used in IDE dialogs. +

Ensures that characters in Src are converted to the notation needed for regular expressions, including '.', ',', ';', '*', '+', '?', and '\'. The return value is enclosed in a regex single line expression ('^(...)$'). @@ -438,7 +440,7 @@ String examined and converted in the routine. - True when invalid UTF-8 codepoints are repaired in the string. + True when invalid UTF-8 codepoints are repaired in the string. @@ -483,7 +485,7 @@ Y represents the column number in the context for the message.

- Line contains the context for the formatted message. The ShortDotsLine routine is called to shorten and "ellipsify" the message in Line when needed. + Line contains the context for the formatted message. The ShortDotsLine routine is called to shorten and "ellipsify" the message in Line when needed.

BeautifyLineXY is used in the implementation of Jump History and Search Result views in the Lazarus IDE. @@ -549,7 +551,9 @@ Maximum length of lines in the converted value. - Number of Space characters prepended as an indent for lines in the converted value. + + Number of Space characters prepended as an indent for lines in the converted value. + @@ -572,11 +576,15 @@ TStrings instance where lines of text are stored. - True to clear the string list; False to append lines to existing values. + + True to clear the string list; False to append lines to existing values. + - Gets a string with the lines of text from the specified TStrings instance. + + Gets a string with the lines of text from the specified TStrings instance. + @@ -590,7 +598,7 @@ End-of-Line sequence used to delimit lines of text in the result value. - True to omit empty lines in the string list from the return value. + True to omit empty lines in the string list from the return value. @@ -756,7 +764,7 @@ - True when the specified item is found in the list. + True when the specified item is found in the list. Values checked for the specified item. @@ -984,23 +992,25 @@ Determines the selector in the return value - True if case is ignored in the comparison. + True if case is ignored in the comparison. - True is a partial match at the start of the selector is a match. + True is a partial match at the start of the selector is a match. - Returns True if P1 and P2 have the same content. + Returns True if P1 and P2 have the same content.

- Returns False if either P1 or P2 are unassigned (contain Nil). + Returns False if either P1 or P2 are unassigned (contain Nil).

- True when P1 and P2 have the same content, or are the same pointer. + + True when P1 and P2 have the same content, or are the same pointer. + Pointer to characters compared in the routine. @@ -1069,16 +1079,16 @@ - True if the specified value is a valid identifier name. + True if the specified value is a valid identifier name. Identifier name examined in the routine. - True if period characters are allowed in the identifier name. + True if period characters are allowed in the identifier name. - True if the position of a period character is validated. + True if the position of a period character is validated.