mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-06-05 03:58:38 +02:00
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
This commit is contained in:
dsiders
parent
f16931bfc4
commit
e567ca6b03
@ -144,7 +144,7 @@
|
||||
<short>Gets a short path name using the 8.3 notation from the UTF-8-encoded value.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>ExtractShortPathNameUTF8</var> is a <var>String</var> 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.
|
||||
<var>ExtractShortPathNameUTF8</var> is a <var>String</var> 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.
|
||||
</p>
|
||||
<p>
|
||||
ExtractShortPathNameUTF8 is similar to the <var>ExtractShortPathName</var> routine in the RTL <file>sysutils</file> unit, but accepts a String value in <var>FileName</var> 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 <b>True</b> when the specified entries are deleted on the local file system. Returns <b>False</b> when:
|
||||
</p>
|
||||
<ul>
|
||||
<li>DirectoryName is one of the relative path indicatiors like '.' or '..'</li>
|
||||
<li>
|
||||
DirectoryName is one of the relative path indicators like '.' or '..'
|
||||
</li>
|
||||
<li>DirectoryName is an empty string ('')</li>
|
||||
<li>DirectoryName does not exist on the local file system</li>
|
||||
<li>The process does not have permissions needed to delete the directory or its content</li>
|
||||
<li>
|
||||
The process does not have permissions needed to delete the directory or its content
|
||||
</li>
|
||||
</ul>
|
||||
</descr>
|
||||
<errors>
|
||||
@ -623,7 +627,7 @@ ShowMessage('File: ' + sFile + LineEnding +
|
||||
<var>SearchFileInPath</var> is a <var>String</var> function used to get the fully-qualified name for the specified <var>FileName</var> 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.
|
||||
</p>
|
||||
<p>
|
||||
<var>SearchPath</var> contains the delimited list of search paths examined in the routine. Search paths are separated using the value in <var>Delimter</var>.
|
||||
<var>SearchPath</var> contains the delimited list of search paths examined in the routine. Search paths are separated using the value in <var>Delimiter</var>.
|
||||
</p>
|
||||
<p>
|
||||
<var>BasePath</var> contains the path used to resolve relative path references in SearchPath. By default, BasePath is also searched unless <var>sffDontSearchInBasePath</var> is included in the <var>Flags</var> parameter.
|
||||
|
||||
@ -85,7 +85,7 @@
|
||||
</element>
|
||||
<element name="TGraphicsBevelCut.bvSpace">
|
||||
<short>
|
||||
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.
|
||||
</short>
|
||||
</element>
|
||||
|
||||
@ -1195,10 +1195,10 @@
|
||||
|
||||
<element name="MissingBits">
|
||||
<short>
|
||||
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.
|
||||
</short>
|
||||
<descr>
|
||||
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.
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
@ -332,7 +332,9 @@
|
||||
</element>
|
||||
|
||||
<element name="TLazFifoQueue.Grow">
|
||||
<short>Resizes the internal storage for the queue by the specified Delta value.</short>
|
||||
<short>
|
||||
Resizes the internal storage for the queue by the specified Delta value.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Grow</var> is a method used to resize the internal storage for the queue by the specified Delta value.
|
||||
@ -341,7 +343,7 @@
|
||||
When <var>ADelta</var> 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.
|
||||
</p>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
<p>
|
||||
The value in the <var>QueueSize</var> property is set to the new length for the internal array.
|
||||
@ -743,7 +745,7 @@ TLazThreadedQueueRect = specialize TLazThreadedQueue<TRectangle>;
|
||||
When <var>ADelta</var> 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.
|
||||
</p>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
<p>
|
||||
The value in the <var>QueueSize</var> property is set to the new length for the internal array.
|
||||
|
||||
@ -21,13 +21,13 @@
|
||||
<b>TLazShiftBufferList</b>
|
||||
</p>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
<p>
|
||||
<b>TLazRoundBufferList</b>
|
||||
</p>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
<p>
|
||||
<b>TLazPagedListMem</b>
|
||||
@ -49,7 +49,7 @@
|
||||
<ul>
|
||||
<li>So it is necessary to call Destroy.</li>
|
||||
<li>
|
||||
It is also necessary to call Create. (Unless you can gurantee that the memory for the object has been zero filled).
|
||||
It is also necessary to call Create. (Unless you can guarantee that the memory for the object has been zero filled).
|
||||
</li>
|
||||
</ul>
|
||||
<p>
|
||||
@ -1271,7 +1271,7 @@ TLazPagedListObj = object
|
||||
<short/>
|
||||
<descr>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
|
||||
@ -57,7 +57,7 @@ LazLoggerBase
|
||||
<dt>Stdout/Console</dt>
|
||||
<dd>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
</dd>
|
||||
<dt>File</dt>
|
||||
@ -124,7 +124,7 @@ LazLoggerBase
|
||||
<short>Set type used to store values from the TLazLoggerLogGroupFlag enumeration.</short>
|
||||
<descr>
|
||||
<p>
|
||||
TLazLoggerLogGroupFlags is the type used for the FLags member in TLazLoggerLogGroup.
|
||||
TLazLoggerLogGroupFlags is the type used for the Flags member in TLazLoggerLogGroup.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -165,7 +165,9 @@ LazLoggerBase
|
||||
|
||||
<!-- variable Visibility: default -->
|
||||
<element name="TLazLoggerLogGroup.FOpenedIndents">
|
||||
<short>Member usesd to track the current indentation level for the log group.</short>
|
||||
<short>
|
||||
Member used to track the current indentation level for the log group.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -202,7 +204,7 @@ LazLoggerBase
|
||||
<short>Logger output is written to the stdout device.</short>
|
||||
</element>
|
||||
<element name="TLazLoggerWriteTarget.lwtStdErr">
|
||||
<short>Logger outout is written to the StdErr device.</short>
|
||||
<short>Logger output is written to the StdErr device.</short>
|
||||
</element>
|
||||
<element name="TLazLoggerWriteTarget.lwtTextFile">
|
||||
<short>Logger output is written to a text file.</short>
|
||||
@ -377,7 +379,7 @@ LazLoggerBase
|
||||
<short>Ordinal position in the container for the specified log group.</short>
|
||||
</element>
|
||||
<element name="TLazLoggerLogGroupList.IndexOf.AConfigName">
|
||||
<short>Name of the loag group to locate in the container.</short>
|
||||
<short>Name of the load group to locate in the container.</short>
|
||||
</element>
|
||||
<element name="TLazLoggerLogGroupList.IndexOf.AnEntry">
|
||||
<short>Pointer to the log group to locate in the container.</short>
|
||||
@ -504,10 +506,12 @@ LazLoggerBase
|
||||
|
||||
<!-- procedure Visibility: protected -->
|
||||
<element name="TLazLogger.IndentChanged">
|
||||
<short>Performs actions needed when the nesting level for the logger has been changed.</short>
|
||||
<short>
|
||||
Performs actions needed when the nesting level for the logger has been changed.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
@ -524,7 +528,9 @@ LazLoggerBase
|
||||
<short>Value for the indexed property.</short>
|
||||
</element>
|
||||
<element name="TLazLogger.GetBlockHandler.AIndex">
|
||||
<short>Ordinal position for the property value retrieved in the method.</short>
|
||||
<short>
|
||||
Ordinal position for the property value retrieved in the method.
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: protected -->
|
||||
@ -660,7 +666,7 @@ LazLoggerBase
|
||||
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TLazLogger.Finish">
|
||||
<short>FInalizes the logger class instance.</short>
|
||||
<short>Finalizes the logger class instance.</short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
@ -694,7 +700,7 @@ LazLoggerBase
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TLazLogger.MaxNestPrefixLen">
|
||||
<short>
|
||||
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.
|
||||
</short>
|
||||
<descr>
|
||||
</descr>
|
||||
@ -754,7 +760,7 @@ LazLoggerBase
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TLazLogger.UseGlobalLogGroupList">
|
||||
<short>
|
||||
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.
|
||||
</short>
|
||||
<descr>
|
||||
</descr>
|
||||
@ -772,7 +778,7 @@ LazLoggerBase
|
||||
</element>
|
||||
|
||||
<element name="TLazLogger.RemoveBlockHandler">
|
||||
<short>Removes the specified block hander for the logger type.</short>
|
||||
<short>Removes the specified block handler for the logger type.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -800,7 +806,9 @@ LazLoggerBase
|
||||
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TLazLogger.DebuglnStack">
|
||||
<short>Calls DoDebuglnStack to write the message in s when the logger has been enabed.</short>
|
||||
<short>
|
||||
Calls DoDebuglnStack to write the message in s when the logger has been enabled.
|
||||
</short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
|
||||
@ -668,13 +668,15 @@
|
||||
</element>
|
||||
|
||||
<element name="StringToStringList">
|
||||
<short>Stores a multi-line string as seperate lines in a TStrings instance.</short>
|
||||
<short>
|
||||
Stores a multi-line string as separate lines in a TStrings instance.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>StringToStringList</var> is a procedure used to convert the multi-line String in <var>S</var> to separate lines of text in a <var>TStrings</var> instance.
|
||||
</p>
|
||||
<p>
|
||||
The <b>LF</b> (<b>#10</b>) character is used to mark the end of a line in <var>S</var>, and causes the preceeding text to be added to the string list in <var>List</var>. The LF character is not included in the value added to the string list.
|
||||
The <b>LF</b> (<b>#10</b>) character is used to mark the end of a line in <var>S</var>, and causes the preceding text to be added to the string list in <var>List</var>. The LF character is not included in the value added to the string list.
|
||||
</p>
|
||||
<p>
|
||||
If no end-of-line characters are found in <var>S</var>, then a single line of text is added to the string list.
|
||||
@ -683,14 +685,18 @@
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="StringToStringList.s">
|
||||
<short>String with values extracted and stored in the string list.</short>
|
||||
<short>
|
||||
String with values extracted and stored in the string list.
|
||||
</short>
|
||||
</element>
|
||||
<element name="StringToStringList.List">
|
||||
<short>TStrings instance where values are stored in the routine.</short>
|
||||
</element>
|
||||
|
||||
<element name="GetNextDelimitedItem">
|
||||
<short>Gets the next delimited value in List starting at the specified position.</short>
|
||||
<short>
|
||||
Gets the next delimited value in List starting at the specified position.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>GetNextDelimitedItem</var> is a <var>String</var> function used to get the next item in a delimited list of items starting at the specified position.
|
||||
|
||||
@ -1011,7 +1011,9 @@
|
||||
</element>
|
||||
|
||||
<element name="TMaskUTF8.MatchesWindowsMask">
|
||||
<short>Indicates whether the specified value is a match for the WIndows-specific Mask expression.</short>
|
||||
<short>
|
||||
Indicates whether the specified value is a match for the Windows-specific Mask expression.
|
||||
</short>
|
||||
<descr>
|
||||
<remark>
|
||||
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 @@
|
||||
</element>
|
||||
|
||||
<element name="TMaskUTF8.Mask">
|
||||
<short>Mask expression used to match files or directories in the class instance.</short>
|
||||
<short>
|
||||
Mask expression used to match files or directories in the class instance.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Mask</var> is a <var>String</var> 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 @@
|
||||
</element>
|
||||
|
||||
<element name="TMask">
|
||||
<short>The TMask class represents a mask expression and performs comparisons.</short>
|
||||
<short>
|
||||
The TMask class represents a mask expression and performs comparisons.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
TMask is an alias for the TMaskUTF8 class. Provided for compatibility with previous LazUtils versions.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user