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

Docs: LazUtils/various. Fixes spelling and grammar errors.

Browse Source
This commit is contained in:
dsiders 2022-04-22 21:17:51 +01:00
parent 417ff31e84
commit 30dcede890
8 changed files with 25 additions and 17 deletions

4
docs/xml/lazutils/dynhasharray.xml
View File

@ -462,7 +462,7 @@
<short>Constructor for the class instance.</short>
<descr>
<p>
Create is the overloaded constructor for the class instance. Overloaded variants are provided which set the initial value in MinCapacity to either a default or a user-specified value. The parameterless version sets the initial value in MinCapacity to 10, but it is automagically increased to 137.
Create is the overloaded constructor for the class instance. Overloaded variants are provided which set the initial value in MinCapacity to either a default or a user-specified value. The parameter-less version sets the initial value in MinCapacity to 10, but it is automagically increased to 137.
</p>
<p>
MaxCapacity is set to an arbitrarily large prime number defined in the implementation for class.
@ -1055,7 +1055,7 @@ StrDispose(s); </code>
<!-- function Visibility: public -->
<element name="TDynHashArrayItemMemManager.ConsistencyCheck">
<short>
Ensures that Count mataches the actual number of entries in the free list.
Ensures that Count matches the actual number of entries in the free list.
</short>
<descr/>
<errors/>

2
docs/xml/lazutils/fileutil.xml
View File

@ -297,7 +297,7 @@
</short>
<descr>
<p>
<var>FilenameHasPascalExt</var> is a <var>Boolean</var> function used to determine if the file name in the <var>Filename</var> argument uses a file extension recognized as a Pascal source code file. The <var>CompareText</var> routine is called to perform a case-insensitive comparision between the value in Filename and the recognized file extensions.
<var>FilenameHasPascalExt</var> is a <var>Boolean</var> function used to determine if the file name in the <var>Filename</var> argument uses a file extension recognized as a Pascal source code file. The <var>CompareText</var> routine is called to perform a case-insensitive comparison between the value in Filename and the recognized file extensions.
</p>
<p>
The return value is <b>True</b> when Filename has one of the following file extensions:

2
docs/xml/lazutils/laz2_xmlcfg.xml
View File

@ -1408,7 +1408,7 @@ ACfg.WriteXMLFile('/another/path/to/file.xml');
<code>
// write XML content to a stream
AStream := TStream.Create;
ACfg.WriteToSteam(ASteam);
ACfg.WriteToSteam(AStream);
</code>
<code>
ACfg := TXMLConfig.CreateClean('myappconfig.xml');

4
docs/xml/lazutils/laz2_xmlutils.xml
View File

@ -63,10 +63,10 @@
<var>IsXmlName</var> is an overloaded <var>Boolean</var> function used to determine if <var>Value</var> contains a valid XML element name. It ensures that the name is valid using the <b>Name</b> production in the XML specifications.
</p>
<p>
In XML 1.0, the valid characters allowed in a name eas some restricted. It used the principle of "that which is not expressly permitted is prohibited."
In XML 1.0, the valid characters allowed in a name was restricted. It used the principle of "that which is not expressly permitted is prohibited."
</p>
<p>
The Xml11 flag indicates if the XML 1.1 element naming conventions are allowed. When set to True, the XML 1.1 naming convenients are used. XML 1.1 allows almost all Unicode characters in any position in the name except the NameStart character. When to False (the default value), XML 1.0 naming conventions are used.
The Xml11 flag indicates if the XML 1.1 element naming conventions are allowed. When set to True, the XML 1.1 naming conventions are used. XML 1.1 allows almost all Unicode characters in any position in the name except the NameStart character. When to False (the default value), XML 1.0 naming conventions are used.
</p>
<p>
<b>Extensible Markup Language (XML) 1.0 (Fifth Edition)</b>

2
docs/xml/lazutils/laz2_xpath.xml
View File

@ -1555,7 +1555,7 @@
<short>Implements a Namespace resolver for the XPath environment.</short>
<descr>
<p>
<var>TXPathNSResolver</var> is a class used to implement a Namespace resolver for the XPath environment. TXPathNSResolver performs namespace lookups for Qualified Names which include a prefix. Namespaces are resolved relative to the context node passed to the constructor for the class instance.
<var>TXPathNSResolver</var> is a class used to implement a Namespace resolver for the XPath environment. TXPathNSResolver performs namespace look-ups for Qualified Names which include a prefix. Namespaces are resolved relative to the context node passed to the constructor for the class instance.
</p>
<p>
TXPathNSResolver is used in the implementation of TXPathScanner, TXPathExpression, and passed as an argument to the EvaluateXPathExpression routine.

22
docs/xml/lazutils/lazclasses.xml
View File

@ -24,7 +24,9 @@
</element>
<element name="TFreeNotifyingObject.FFreeNotificationList">
<short>List of notification methods called when the object is freed.</short>
<short>
List of notification methods called when the object is freed.
</short>
</element>
<element name="TFreeNotifyingObject.Destroy">
@ -34,7 +36,9 @@
</element>
<element name="TFreeNotifyingObject.AddFreeNotification">
<short>Adds the specified method to the notification list in the class instance.</short>
<short>
Adds the specified method to the notification list in the class instance.
</short>
<descr/>
<seealso/>
</element>
@ -52,7 +56,9 @@
</element>
<element name="TRefCountedObject">
<short>Implements a thread-safe reference-counted class which performs free notifications.</short>
<short>
Implements a thread-safe reference-counted class which performs free notifications.
</short>
<descr>
<p>
Used in the implementation of logging classes and the debugger interface in Lazarus. Also used in the implementation of classes for TSynEdit.
@ -117,7 +123,7 @@
<short>Constructor for the class instance.</short>
<descr>
<p>
Create is the constructor for the class instance. It sets the default values for members used in the class instance.When WITH_REFCOUNT_DEBUG has been defined in the LCL, a critcal section used during debugging is initialized. Create calls the inherited constructor prior to exiting from the method.
Create is the constructor for the class instance. It sets the default values for members used in the class instance.When WITH_REFCOUNT_DEBUG has been defined in the LCL, a critical section used during debugging is initialized. Create calls the inherited constructor prior to exiting from the method.
</p>
</descr>
<seealso>
@ -146,7 +152,7 @@
</p>
<ul>
<li>
The thread already holds a refernce (and no other thread will release that reference).
The thread already holds a reference (and no other thread will release that reference).
</li>
<li>
The thread created the reference, and no other thread has access to the object (yet).
@ -173,7 +179,7 @@
</p>
<ul>
<li>
The thread already holds a refernce (and no other thread will release that reference).
The thread already holds a reference (and no other thread will release that reference).
</li>
<li>
The thread created the reference, and no other thread has access to the object (yet).
@ -213,7 +219,9 @@
</element>
<element name="TRefCntObjList">
<short>Implements a list used to store TRefCountedObject instances.</short>
<short>
Implements a list used to store TRefCountedObject instances.
</short>
<descr>
<p>
Provides a <var>Notify</var> method which increases or decreases the reference count for an object when it is added to or removed from the list.ist.

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

@ -534,7 +534,7 @@ D:\db\employee.fdb
<element name="CheckIfFileIsSymlink">
<short>
Checks whether the specified file name is a symbolc link on the local file system.
Checks whether the specified file name is a symbolic link on the local file system.
</short>
<descr>
<p>
@ -623,7 +623,7 @@ D:\db\employee.fdb
<var>FileIsHardLink</var> is a <var>Boolean</var> function used to determine if the specified file name is represented by a file descriptor or handle on the local file system.
</p>
<p>
The implementation of FileIsHardLink is platform- or OS-specific. For UNIX-like environments, a file handle is retrieved by calling the <var>FileOpenUTF8</var> function and passed to the <var>FPFStat</var> function to access the file information. For the Windows platform (excluding WinCE and Windows XP), the <var>GetFileInformationByHandle</var> Windows API routine is called to get information for the file handle. For the Amiga platform, FileIsHardLink always returns <b>False</b>.
The implementation of FileIsHardLink is platform- or OS-specific. For UNIX-like environments, a file handle is retrieved by calling the <var>FileOpenUTF8</var> function and passed to the <var>FpFStat</var> function to access the file information. For the Windows platform (excluding WinCE and Windows XP), the <var>GetFileInformationByHandle</var> Windows API routine is called to get information for the file handle. For the Amiga platform, FileIsHardLink always returns <b>False</b>.
</p>
<p>
The return value is <b>False</b> if a file handle could not be accessed for the specified file name or it is actually a symbolic link on the local file system.

2
docs/xml/lazutils/lazmethodlist.xml
View File

@ -235,7 +235,7 @@
<short>Copies property values from Source into the current class instance.</short>
<descr>
<p>
<var>Assign</var> is an overridden method in <var>TMethodList</var> used to implement object persistence for the TMethodList class type. Assign calls <var>Clear</var> ro reallocate memory for the <var>Items</var> in the class instance. Values from the Items property in <var>Source</var> are added to the current class instance.
<var>Assign</var> is an overridden method in <var>TMethodList</var> used to implement object persistence for the TMethodList class type. Assign calls <var>Clear</var> to reallocate memory for the <var>Items</var> in the class instance. Values from the Items property in <var>Source</var> are added to the current class instance.
</p>
</descr>
<seealso/>