From e567ca6b0394f8fb75c47c920a423b4680889b41 Mon Sep 17 00:00:00 2001 From: dsiders Date: Sun, 17 Apr 2022 21:31:45 +0100 Subject: [PATCH] Docs: LazUtils/various. Fixes spelling and grammar errors. Modified files: docs/xml/lazutils/fileutil.xml docs/xml/lazutils/graphtype.xml docs/xml/lazutils/lazcollections.xml docs/xml/lazutils/lazlistclasses.xml docs/xml/lazutils/lazloggerbase.xml docs/xml/lazutils/lazstringutils.xml docs/xml/lazutils/masks.xml --- docs/xml/lazutils/fileutil.xml | 12 ++++++---- docs/xml/lazutils/graphtype.xml | 6 ++--- docs/xml/lazutils/lazcollections.xml | 8 ++++--- docs/xml/lazutils/lazlistclasses.xml | 10 ++++---- docs/xml/lazutils/lazloggerbase.xml | 34 +++++++++++++++++----------- docs/xml/lazutils/lazstringutils.xml | 14 ++++++++---- docs/xml/lazutils/masks.xml | 12 +++++++--- 7 files changed, 61 insertions(+), 35 deletions(-) diff --git a/docs/xml/lazutils/fileutil.xml b/docs/xml/lazutils/fileutil.xml index 2192fa7b24..0f9a72fbe3 100644 --- a/docs/xml/lazutils/fileutil.xml +++ b/docs/xml/lazutils/fileutil.xml @@ -144,7 +144,7 @@ Gets a short path name using the 8.3 notation from the UTF-8-encoded value.

- ExtractShortPathNameUTF8 is a String function used to get a short path name from the UTF-8-encoded value in FileName. Short path names use the familiar 8.3 notation, where the file name contains a maximum of 8 chararacters, and the optional file extension has a maximum of 3 characters. + ExtractShortPathNameUTF8 is a String function used to get a short path name from the UTF-8-encoded value in FileName. Short path names use the familiar 8.3 notation, where the file name contains a maximum of 8 characters, and the optional file extension has a maximum of 3 characters.

ExtractShortPathNameUTF8 is similar to the ExtractShortPathName routine in the RTL sysutils unit, but accepts a String value in FileName and returns a String value in the result which uses UTF-8 encoding.The RTL routine uses UnicodeString for both. @@ -179,10 +179,14 @@ Returns True when the specified entries are deleted on the local file system. Returns False when:

@@ -623,7 +627,7 @@ ShowMessage('File: ' + sFile + LineEnding + SearchFileInPath is a String function used to get the fully-qualified name for the specified FileName in the specified search paths. When FileName contains an absolute path, and the file exists in the file system, no other directories are checked in the routine.

- SearchPath contains the delimited list of search paths examined in the routine. Search paths are separated using the value in Delimter. + SearchPath contains the delimited list of search paths examined in the routine. Search paths are separated using the value in Delimiter.

BasePath contains the path used to resolve relative path references in SearchPath. By default, BasePath is also searched unless sffDontSearchInBasePath is included in the Flags parameter. diff --git a/docs/xml/lazutils/graphtype.xml b/docs/xml/lazutils/graphtype.xml index 0ae31f621b..6d8e6aafe3 100644 --- a/docs/xml/lazutils/graphtype.xml +++ b/docs/xml/lazutils/graphtype.xml @@ -85,7 +85,7 @@ - The bevel is drawn as a space using the required width, netiher inset nor outset. + The bevel is drawn as a space using the required width, neither inset nor outset. @@ -1195,10 +1195,10 @@ - Used to pad bit data in a raw image to specific precisions and byte boundaries. + Used to pad bit data in a raw image to a specific precision and byte boundaries. - Used to pad bit data in a raw image to specific precisions and byte boundaries. + Used to pad bit data in a raw image to a specific precision and byte boundaries. diff --git a/docs/xml/lazutils/lazcollections.xml b/docs/xml/lazutils/lazcollections.xml index 5baaadcd7f..fa3dca8baa 100644 --- a/docs/xml/lazutils/lazcollections.xml +++ b/docs/xml/lazutils/lazcollections.xml @@ -332,7 +332,9 @@ - Resizes the internal storage for the queue by the specified Delta value. + + Resizes the internal storage for the queue by the specified Delta value. +

Grow is a method used to resize the internal storage for the queue by the specified Delta value. @@ -341,7 +343,7 @@ When ADelta is a position Integer value, the size for the internal array is enlarged by the value specified number of entries. When ADelta is a negative Integer value, the internal storage is shrunk by the specified number of entries.

- Grow reallocates the internal array used to store the item types for the specialization. Exisitng items in the queue are moved to the new array, and the internal storage is updated. + Grow reallocates the internal array used to store the item types for the specialization. Existing items in the queue are moved to the new array, and the internal storage is updated.

The value in the QueueSize property is set to the new length for the internal array. @@ -743,7 +745,7 @@ TLazThreadedQueueRect = specialize TLazThreadedQueue<TRectangle>; When ADelta is a position Integer value, the size for the internal array is enlarged by the value specified number of entries. When ADelta is a negative Integer value, the internal storage is shrunk by the specified number of entries.

- Grow reallocates the internal array used to store the item types for the specialization. Exisitng items in the queue are moved to the new array, and the internal storage is updated. + Grow reallocates the internal array used to store the item types for the specialization. Existing items in the queue are moved to the new array, and the internal storage is updated.

The value in the QueueSize property is set to the new length for the internal array. diff --git a/docs/xml/lazutils/lazlistclasses.xml b/docs/xml/lazutils/lazlistclasses.xml index c14ce06d1e..32d9fd07b1 100644 --- a/docs/xml/lazutils/lazlistclasses.xml +++ b/docs/xml/lazutils/lazlistclasses.xml @@ -21,13 +21,13 @@ TLazShiftBufferList

- This list is designed for shift/unshift/pop/push operations. The first list element is not forced to the start of the allocated memory. Instead it allows a gap (some of the over-allocated memory / List.Capacity) in front of the first element. Therefore elements can be added/removed at either the begin or end of the list, withouth any need to move the other elemnts in the list. + This list is designed for shift/unshift/pop/push operations. The first list element is not forced to the start of the allocated memory. Instead it allows a gap (some of the over-allocated memory / List.Capacity) in front of the first element. Therefore elements can be added/removed at either the begin or end of the list, withouth any need to move the other elements in the list.

TLazRoundBufferList

- The first element of the list can be anywhere within the allocated memory (capacity). If the elements of the list reach the end of the memory, the list will wrap arount and continues in the available memory at the start of the allocation. This list can be used for a first-in, first-out queue. If the list does never exceed the size set by its capacity, then elements can be pushed/shifted from/to the list without any need to reallocate or move entries to new locations. + The first element of the list can be anywhere within the allocated memory (capacity). If the elements of the list reach the end of the memory, the list will wrap around and continues in the available memory at the start of the allocation. This list can be used for a first-in, first-out queue. If the list does never exceed the size set by its capacity, then elements can be pushed/shifted from/to the list without any need to reallocate or move entries to new locations.

TLazPagedListMem @@ -49,7 +49,7 @@

@@ -1271,7 +1271,7 @@ TLazPagedListObj = object

- The first element of the list can be anywhere within the allocated memory (capacity). If the elements of the list reach the end of the memory, the list will wrap arount and continues in the available memory at the start of the allocation. + The first element of the list can be anywhere within the allocated memory (capacity). If the elements of the list reach the end of the memory, the list will wrap around and continues in the available memory at the start of the allocation.

This list can be used for a first-in, first-out queue. If the list does never exceed the size set by its capacity, then elements can be pushed/shifted from/to the list without any need to reallocate or move entries to new locations. @@ -2301,7 +2301,7 @@ TLazPagedListObj = object The first list element is not forced to the start of the allocated memory. Instead it allows a gap (some of the over-allocated memory / List.Capacity) in front of the first element.

- Therefore elements can be added/removed at either the begin or end of the list, withouth any need to move the other elemnts in the list. + Therefore elements can be added/removed at either the begin or end of the list, without any need to move the other elements in the list.

diff --git a/docs/xml/lazutils/lazloggerbase.xml b/docs/xml/lazutils/lazloggerbase.xml index 81a2bcc1eb..62cd821251 100644 --- a/docs/xml/lazutils/lazloggerbase.xml +++ b/docs/xml/lazutils/lazloggerbase.xml @@ -57,7 +57,7 @@ LazLoggerBase
Stdout/Console

- By default the output created by DebugLn is written to the stdout device. The output is silently discarded if stdout is not open. On Windows this is the default behavior, if project type "Application" is used to create a Windows GUI application. To get a console alongside your Windows GUI application, you need to uncheck the option "Win32 gui application (-WG)" under Project options / Compiler options / Config and Target / Target specific options. Alternatively you can add {$APPTYPE CONSOLE} at the top of your project .lpr file, or configure multiple "Build Modes" to control the -WG switch. + By default the output created by DebugLn is written to the stdout device. The output is silently discarded if stdout is not open. On Windows this is the default behavior, if project type "Application" is used to create a Windows GUI application. To get a console alongside your Windows GUI application, you need to uncheck the option "Win32 GUI application (-WG)" under Project options / Compiler options / Config and Target / Target specific options. Alternatively you can add {$APPTYPE CONSOLE} at the top of your project .lpr file, or configure multiple "Build Modes" to control the -WG switch.

File
@@ -124,7 +124,7 @@ LazLoggerBase Set type used to store values from the TLazLoggerLogGroupFlag enumeration.

- TLazLoggerLogGroupFlags is the type used for the FLags member in TLazLoggerLogGroup. + TLazLoggerLogGroupFlags is the type used for the Flags member in TLazLoggerLogGroup.

@@ -165,7 +165,9 @@ LazLoggerBase - Member usesd to track the current indentation level for the log group. + + Member used to track the current indentation level for the log group. + @@ -202,7 +204,7 @@ LazLoggerBase Logger output is written to the stdout device. - Logger outout is written to the StdErr device. + Logger output is written to the StdErr device. Logger output is written to a text file. @@ -377,7 +379,7 @@ LazLoggerBase Ordinal position in the container for the specified log group. - Name of the loag group to locate in the container. + Name of the load group to locate in the container. Pointer to the log group to locate in the container. @@ -504,10 +506,12 @@ LazLoggerBase - Performs actions needed when the nesting level for the logger has been changed. + + Performs actions needed when the nesting level for the logger has been changed. +

- IndentChanged has an empty implementation, andmust be overridden in a descendent class to perform the actions needed when the nesting level (Increaseindent, DecreaseIndent) has been changed. + IndentChanged has an empty implementation, and must be overridden in a descendent class to perform the actions needed when the nesting level (Increaseindent, DecreaseIndent) has been changed.

@@ -524,7 +528,9 @@ LazLoggerBase Value for the indexed property. - Ordinal position for the property value retrieved in the method. + + Ordinal position for the property value retrieved in the method. + @@ -660,7 +666,7 @@ LazLoggerBase - FInalizes the logger class instance. + Finalizes the logger class instance. @@ -694,7 +700,7 @@ LazLoggerBase - Indicates the maximum length for the nexting prefix used when values are output in the logger. + Indicates the maximum length for the nesting prefix used when values are output in the logger. @@ -754,7 +760,7 @@ LazLoggerBase - Indicates if the gloabal DebugLoggerGroupList is used as the value for the LogGroupList property. + Indicates if the global DebugLoggerGroupList is used as the value for the LogGroupList property. @@ -772,7 +778,7 @@ LazLoggerBase - Removes the specified block hander for the logger type. + Removes the specified block handler for the logger type. @@ -800,7 +806,9 @@ LazLoggerBase - Calls DoDebuglnStack to write the message in s when the logger has been enabed. + + Calls DoDebuglnStack to write the message in s when the logger has been enabled. + diff --git a/docs/xml/lazutils/lazstringutils.xml b/docs/xml/lazutils/lazstringutils.xml index 053cbb95a9..e09e71c96a 100644 --- a/docs/xml/lazutils/lazstringutils.xml +++ b/docs/xml/lazutils/lazstringutils.xml @@ -668,13 +668,15 @@ - Stores a multi-line string as seperate lines in a TStrings instance. + + Stores a multi-line string as separate lines in a TStrings instance. +

StringToStringList is a procedure used to convert the multi-line String in S to separate lines of text in a TStrings instance.

- The LF (#10) character is used to mark the end of a line in S, and causes the preceeding text to be added to the string list in List. The LF character is not included in the value added to the string list. + The LF (#10) character is used to mark the end of a line in S, and causes the preceding text to be added to the string list in List. The LF character is not included in the value added to the string list.

If no end-of-line characters are found in S, then a single line of text is added to the string list. @@ -683,14 +685,18 @@ - String with values extracted and stored in the string list. + + String with values extracted and stored in the string list. + TStrings instance where values are stored in the routine. - Gets the next delimited value in List starting at the specified position. + + Gets the next delimited value in List starting at the specified position. +

GetNextDelimitedItem is a String function used to get the next item in a delimited list of items starting at the specified position. diff --git a/docs/xml/lazutils/masks.xml b/docs/xml/lazutils/masks.xml index 9c1d8dcd59..0885b6932e 100644 --- a/docs/xml/lazutils/masks.xml +++ b/docs/xml/lazutils/masks.xml @@ -1011,7 +1011,9 @@ - Indicates whether the specified value is a match for the WIndows-specific Mask expression. + + Indicates whether the specified value is a match for the Windows-specific Mask expression. + Deprecated in Lazarus version 2.3, and will be removed in 2.5. Create a TWindowsMask instance and call its Matches method instead. @@ -1034,7 +1036,9 @@ - Mask expression used to match files or directories in the class instance. + + Mask expression used to match files or directories in the class instance. +

Mask is a String property which contains the mask expression used to compare / evaluate a value in the Matches method. The property value is initially set using the arguments passed to the Create constructor. Values in Mask use the UNIX file system conventions for wildcards and related notations. @@ -1050,7 +1054,9 @@ - The TMask class represents a mask expression and performs comparisons. + + The TMask class represents a mask expression and performs comparisons. +

TMask is an alias for the TMaskUTF8 class. Provided for compatibility with previous LazUtils versions.