diff --git a/docs/xml/lazutils/lazstringutils.xml b/docs/xml/lazutils/lazstringutils.xml index 748a1fac4c..e7b00b7b4b 100644 --- a/docs/xml/lazutils/lazstringutils.xml +++ b/docs/xml/lazutils/lazstringutils.xml @@ -22,6 +22,7 @@ + @@ -1058,8 +1059,23 @@ - This is a copy of IsValidIdent from FPC 3.1. + This is a modified version of IsValidIdent from the FPC 3.1 FCL library. +

+ LazIsValidIdent is a Boolean function used to determine if the name specified in Ident contains a valid identifier name value. +

+

+ The return value is True when Ident contains a valid identifier name using the Pascal naming convention, and does not contain an unquoted reserved keyword. The IsKeyword method in TPascalCodeGenerator is used to check the value in Ident, and the return value is set to False if it contains one of the reserved keywords. +

+

+ If the value is a keyword prefixed with an Ampersand (&) character, it is "quoted' and considered a valid identifier name if the Pascal naming convention is satisfied. That naming convention requires the identifier to start with an alphabetic character in the range 'a-z', 'A-Z' or the '_' character. The other characters can be any of the alphanumeric characters. Case is not significant in the identifier name. +

+

+ AllowDots indicates whether Period ('.') characters are allowed in the identifier name. The default value for the argument is False (not allowed). +

+

+ StrictDots indicates whether the position of a given Period character is validated. In other words, the Period character cannot be first or last character in the identifier name. The default value for the argument is False, and is significant only when AllowDots is set to True. +

Use the IsValidIdent routine from FPC 3.2.X when version 3.2 is the minimum requirement. @@ -1068,10 +1084,18 @@ IsValidIdent
- - - - + + 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 the position of a period character is validated. + Defines the maximum length for shortened or "ellipsified" text.