paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-23 18:49:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LazUtils. Adds missing content and see also links.

Browse Source
This commit is contained in:
dsiders 2021-08-14 03:41:18 +01:00
parent 5db1922e37
commit 0467d7cf0f
4 changed files with 68 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/xml/lazutils/lazfileutils.xml
View File

@ -350,15 +350,21 @@
</element>
<element name="ExtractFileNameWithoutExt">
<short/>
<descr/>
<short>
Gets the value from AFilename prior to the '.' character that starts the file extension.
</short>
<descr>
<p>
Processes characters in AFilename in reverse order to locate the '.' that starts the file extension. If a '.' character is not found, the process continues until a path or directory delimiter is found. The return value defaults to AFilename if a path or directory delimiter occurs before a '.' character.
</p>
</descr>
<seealso/>
</element>
<element name="ExtractFileNameWithoutExt.Result">
<short/>
<short>File name (including path) after the file extension has been removed.</short>
</element>
<element name="ExtractFileNameWithoutExt.AFilename">
<short/>
<short>Qualified path and file name examined in the method.</short>
</element>
<element name="FilenameIsAbsolute">
@ -473,7 +479,7 @@ D:\db\employee.fdb
</short>
<descr>
<p>
CheckIfFileIsExecutable is a procedure used to examine the specified file name to see if it is executable. CheckIfFileIsExecutable is implemented for UNIX-like environments, and allows a process to better determine if the file can be executed on the platform or OS, and to get better error messages when it cannot.
<var>CheckIfFileIsExecutable</var> is a procedure used to examine the specified file name to see if it is executable. CheckIfFileIsExecutable is implemented for UNIX-like environments, and allows a process to better determine if the file can be executed on the platform or OS, and to get better error messages when it cannot.
</p>
<p>
CheckIfFileIsExecutable raises an exception with a specific message when the platform or OS facilities indicate it is necessary.

14
docs/xml/lazutils/lazutf8.xml
View File

@ -1881,15 +1881,21 @@ end;
</element>
<element name="TStringListUTF8Fast">
<short/>
<short>Implements a string list using UTF8CompareLatinTextFast for comparisons.</short>
<descr>
Uses UTF8CompareLatinTextFast for comparison.
<p>
<var>TStringListUTF8Fast</var> is a <var>TStringList</var> descendant which uses UTF8CompareLatinTextFast for fast comparison of values in the class instance.
</p>
</descr>
<seealso/>
<seealso>
<link id="#rtl.classes.TStringList">TStringList</link>
</seealso>
</element>
<element name="TStringListUTF8Fast.DoCompareText">
<short/>
<short>
Compares UTF-8-encoded values in the class using UTF8CompareLatinTextFast.
</short>
<descr/>
<seealso/>
</element>

13
docs/xml/lazutils/objectlists.xml
View File

@ -206,8 +206,19 @@
</seealso>
</element>
<element name="TObjectArray.Destroy">
<short>Destructor for the class instance.</short>
<descr>
<var>Destroy</var> is the overridden destructor for the class instance. It calls <var>ReallocMem</var> to reset the storage size in <var>List</var> to <b>0</b> (<b>zero</b>). It calls the inherited method prior to exit.
</descr>
<seealso>
<link id="TObjectArray.List"/>
<link id="#rtl.system.ReallocMem">ReallocMem</link>
</seealso>
</element>
<element name="TObjectArray.Add">
<short>Adds the specified item.</short>
<short>Adds the specified item to the storage for the class instance.</short>
<descr>
<p>
<var>Add</var> is an <var>Integer</var> function used to add the item specified in <var>Item</var> to the storage for the class instance. Add calls the <var>AddObject</var> method to store the value in Item. The associated object is unassigned (<b>Nil)</b> in the method. Use <var>AddObject</var> to store an Item and its associated object.

41
docs/xml/lazutils/textstrings.xml
View File

@ -159,11 +159,35 @@
<short>Indicates if Changed was called after calling BeginUpdate.</short>
</element>
<element name="TTextStrings.GetTextStr" link="#rtl.classes.TStrings.GetTextStr"/>
<element name="TTextStrings.GetTextStr.Result" link="#rtl.classes.TStrings.GetTextStr.Result"/>
<element name="TTextStrings.GetTextStr">
<short>Gets the value for the Text property.</short>
<descr>
<p>
Overridden to re-implement the method from the ancestor class.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TStrings.Text">TStrings.Text</link>
</seealso>
</element>
<element name="TTextStrings.GetTextStr.Result">
<short>Value for the Text property.</short>
</element>
<element name="TTextStrings.SetTextStr" link="#rtl.classes.TStrings.SetTextStr"/>
<element name="TTextStrings.SetTextStr.AValue" link="#rtl.classes.TStrings.SetTextStr.AValue"/>
<element name="TTextStrings.SetTextStr">
<short>Sets the value for the Text property.</short>
<descr>
<p>
Overridden to re-implement the method from the ancestor class.
</p>
</descr>
<seealso>
<link id="#rtl.classes.TStrings.Text">TStrings.Text</link>
</seealso>
</element>
<element name="TTextStrings.SetTextStr.AValue">
<short>New value for the Text property.</short>
</element>
<element name="TTextStrings.BuildArrays">
<short>Clears and builds the array with the line ranges for the values in Text.</short>
@ -703,13 +727,18 @@
</element>
<element name="TTextStrings.AddStrings">
<short/>
<short>Adds the lines of text in TheStrings to the current class instance.</short>
<descr>
<p>
No actions are performed in the method when <var>TheString</var> does not have any lines of text.
<var>AddStrings</var> is an overridden method in <var>TTextStrings</var> used to add the lines of text in <var>TheStrings</var> to the current class instance. No actions are performed in the method when <var>TheStrings</var> does not contain any lines of text.
</p>
<p>
Builds (or re-builds) the internal array of line ranges for the class instance. Values from the Objects property in TheStrings are also copied in the method.
</p>
</descr>
<seealso>
<link id="TTextStrings.AddObject"/>
<link id="#rtl.classes.TStrings.Objects">TStrings.Objects</link>
<link id="#rtl.classes.TStrings.AddStrings">TStrings.AddStrings</link>
</seealso>
</element>