mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-11-20 19:39:29 +01:00
Docs: LazUtils. Adds missing topics or content. Fixes tagging and content errors.
This commit is contained in:
dsiders
parent
6c8e9f0867
commit
fc99cfa6ee
@ -7,7 +7,9 @@
|
||||
====================================================================
|
||||
-->
|
||||
<module name="LazClasses">
|
||||
<short>Contains classes and routines used to implement free notifications.</short>
|
||||
<short>
|
||||
Contains classes and routines used to implement free notifications and reference counting.
|
||||
</short>
|
||||
<descr></descr>
|
||||
|
||||
<!-- unresolved external references -->
|
||||
@ -59,108 +61,98 @@
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TRefCountedObject.FRefCount">
|
||||
<short/>
|
||||
</element>
|
||||
|
||||
<element name="TRefCountedObject.FIncDecRefCount">
|
||||
<short/>
|
||||
</element>
|
||||
|
||||
<element name="TRefCountedObject.FDebugNext">
|
||||
<short/>
|
||||
</element>
|
||||
|
||||
<element name="TRefCountedObject.FDebugPrev">
|
||||
<short/>
|
||||
</element>
|
||||
|
||||
<element name="TRefCountedObject.FDebugList">
|
||||
<short/>
|
||||
</element>
|
||||
|
||||
<element name="TRefCountedObject.FCritSect">
|
||||
<short/>
|
||||
</element>
|
||||
|
||||
<element name="TRefCountedObject.FInDestroy">
|
||||
<short/>
|
||||
</element>
|
||||
|
||||
<element name="TRefCountedObject.DbgAddName">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TRefCountedObject.DbgAddName.DebugIdAdr">
|
||||
<short/>
|
||||
</element>
|
||||
<element name="TRefCountedObject.DbgAddName.DebugIdTxt">
|
||||
<short/>
|
||||
</element>
|
||||
|
||||
<element name="TRefCountedObject.DbgRemoveName">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TRefCountedObject.DbgRemoveName.DebugIdAdr">
|
||||
<short/>
|
||||
</element>
|
||||
<element name="TRefCountedObject.DbgRemoveName.DebugIdTxt">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- private -->
|
||||
<element name="TRefCountedObject.FRefCount"/>
|
||||
<element name="TRefCountedObject.FIncDecRefCount"/>
|
||||
<element name="TRefCountedObject.FDebugNext"/>
|
||||
<element name="TRefCountedObject.FDebugPrev"/>
|
||||
<element name="TRefCountedObject.FDebugList"/>
|
||||
<element name="TRefCountedObject.FCritSect"/>
|
||||
<element name="TRefCountedObject.FInDestroy"/>
|
||||
<element name="TRefCountedObject.DbgAddName"/>
|
||||
<element name="TRefCountedObject.DbgAddName.DebugIdAdr"/>
|
||||
<element name="TRefCountedObject.DbgAddName.DebugIdTxt"/>
|
||||
<element name="TRefCountedObject.DbgRemoveName"/>
|
||||
<element name="TRefCountedObject.DbgRemoveName.DebugIdAdr"/>
|
||||
<element name="TRefCountedObject.DbgRemoveName.DebugIdTxt"/>
|
||||
|
||||
<element name="TRefCountedObject.DoFree">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<errors></errors>
|
||||
<seealso></seealso>
|
||||
<short>Performs actions needed to free the reference counted object instance.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Calls the inherited Free method.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TRefCountedObject.DoReferenceAdded">
|
||||
<short/>
|
||||
<short>Has an empty implementation in TRefCountedObject.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TRefCountedObject.DoReferenceReleased">
|
||||
<short/>
|
||||
<short>Has an empty implementation in TRefCountedObject.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TRefCountedObject.RefCount">
|
||||
<short></short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
<short>
|
||||
Number of times the object instance has been referenced in the application.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>RefCount</var> is a read-only <var>Integer</var> property which contains the number of times the object instance has been referenced. Its value is maintained when methods like <var>AddReference</var> and <var>ReleaseReference</var> are called.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TRefCountedObject.AddReference"/>
|
||||
<link id="TRefCountedObject.ReleaseReference"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TRefCountedObject.Create">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<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.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TRefCountedObject.RefCount"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TRefCountedObject.Destroy">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Destructor for the class instance.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Destroy</var> is the overridden destructor for the class instance. It ensures that resource allocated in the constructor are freed before freeing the class instance. Destroy calls the inherited destructor prior to exit.
|
||||
</p>
|
||||
</descr>
|
||||
<errors>
|
||||
Destroy raises an EAssertionFailed exception if RefCount has a non-zero value when the method was called.
|
||||
</errors>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TRefCountedObject.AddReference">
|
||||
<short/>
|
||||
<short>Increments the value in RefCount and calls DoReferenceAdded.</short>
|
||||
<descr>
|
||||
<p>
|
||||
AddReference and ReleaseReference can be used in threads. However a thread can only call the
|
||||
methods, if either:
|
||||
AddReference and ReleaseReference can be used in threads. However a thread can only call the methods, if either:
|
||||
</p>
|
||||
<ul>
|
||||
<li>The thread already holds a refernce (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).</li>
|
||||
<li>
|
||||
The thread is in a critical section, preventing other threads from decreasing the reference
|
||||
count.
|
||||
The thread already holds a refernce (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).
|
||||
</li>
|
||||
<li>
|
||||
The thread is in a critical section, preventing other threads from decreasing the reference count.
|
||||
</li>
|
||||
</ul>
|
||||
</descr>
|
||||
@ -174,18 +166,20 @@
|
||||
</element>
|
||||
|
||||
<element name="TRefCountedObject.ReleaseReference">
|
||||
<short/>
|
||||
<short>Decrements the value in RefCount and calls DoReferenceReleased.</short>
|
||||
<descr>
|
||||
<p>
|
||||
AddReference and ReleaseReference can be used in threads. However a thread can only call the
|
||||
methods, if either:
|
||||
AddReference and ReleaseReference can be used in threads. However a thread can only call the methods, if either:
|
||||
</p>
|
||||
<ul>
|
||||
<li>The thread already holds a refernce (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).</li>
|
||||
<li>
|
||||
The thread is in a critical section, preventing other threads from decreasing the reference
|
||||
count.
|
||||
The thread already holds a refernce (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).
|
||||
</li>
|
||||
<li>
|
||||
The thread is in a critical section, preventing other threads from decreasing the reference count.
|
||||
</li>
|
||||
</ul>
|
||||
</descr>
|
||||
@ -199,7 +193,9 @@
|
||||
</element>
|
||||
|
||||
<element name="TRefCountedObject.DbgRenameReference">
|
||||
<short/>
|
||||
<short>
|
||||
implemented when WITH_REFCOUNT_DEBUG is defined in the LCL.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -220,15 +216,21 @@
|
||||
<short>Implements a list used to store TRefCountedObject instances.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Provides a <var>Notify</var> method which executes the notification methods for each reference-counted object in the list.
|
||||
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.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TRefCntObjList.Notify">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>
|
||||
Performs a notification when an object is added to or removed from the list.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
For TRefCntObjList, the notification causes the reference count for the object in Ptr to be increased or decreased as needed for the value in Action.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TRefCntObjList.Notify.Ptr">
|
||||
@ -239,8 +241,15 @@
|
||||
</element>
|
||||
|
||||
<element name="ReleaseRefAndNil">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Releases the specified reference counted object and sets it to Nil.</short>
|
||||
<descr>
|
||||
<p>
|
||||
No actions are performed in the method when ARefCountedObject has not been assigned, or has already been released. ReleaseRefAndNil calls the ReleaseReference method for the object instance, and sets the pointer in ARefCountedObject to Nil.
|
||||
</p>
|
||||
</descr>
|
||||
<errors>
|
||||
Raises an EAssertionFailed exception if the object instance in ARefCountedObject is derived from a class other than TRefCountedObject.
|
||||
</errors>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="ReleaseRefAndNil.ARefCountedObject">
|
||||
@ -254,8 +263,17 @@
|
||||
</element>
|
||||
|
||||
<element name="NilThenReleaseRef">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>
|
||||
Copies and releases the specified reference counted object, and sets the copy to Nil.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
No actions are performed in the method when ARefCountedObject has not been assigned, or has already been released. ReleaseRefAndNil calls the ReleaseReference method for the object instance, and sets the pointer in ARefCountedObject to Nil.
|
||||
</p>
|
||||
</descr>
|
||||
<errors>
|
||||
Raises an EAssertionFailed exception if the object instance in ARefCountedObject is derived from a class other than TRefCountedObject.
|
||||
</errors>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="NilThenReleaseRef.ARefCountedObject">
|
||||
|
||||
@ -283,8 +283,14 @@
|
||||
|
||||
<element name="TLazFifoQueue.FList"/>
|
||||
<element name="TLazFifoQueue.FQueueSize"/>
|
||||
<element name="TLazFifoQueue.FTotalItemsPopped"/>
|
||||
<element name="TLazFifoQueue.FTotalItemsPushed"/>
|
||||
|
||||
<element name="TLazFifoQueue.FTotalItemsPopped">
|
||||
<short>Member with the total number of items removed from the FIFO queue.</short>
|
||||
</element>
|
||||
|
||||
<element name="TLazFifoQueue.FTotalItemsPushed">
|
||||
<short>Member with the total number of items stored on the FIFO queue.</short>
|
||||
</element>
|
||||
|
||||
<element name="TLazFifoQueue.GetIsEmpty">
|
||||
<short>Gets the value for the IsEmpty property.</short>
|
||||
@ -601,8 +607,12 @@ TLazThreadedQueueRect = specialize TLazThreadedQueue<TRectangle>;
|
||||
</element>
|
||||
|
||||
<element name="TLazThreadedQueue.TryPushItemUnprotected">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Tries to push an item onto the queue without resource protection.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Sets and resets internal RTL events when the item was successfully pushed, and when queue space is available.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TLazThreadedQueue.TryPushItemUnprotected.Result">
|
||||
@ -613,8 +623,12 @@ TLazThreadedQueueRect = specialize TLazThreadedQueue<TRectangle>;
|
||||
</element>
|
||||
|
||||
<element name="TLazThreadedQueue.TryPopItemUnprotected">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Tries to pop an item off of the queue without resource protection.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Sets and resets internal RTL events when the item was successfully popped, and when queue space is available.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TLazThreadedQueue.TryPopItemUnprotected.Result">
|
||||
|
||||
@ -217,7 +217,7 @@
|
||||
|
||||
<!-- class Visibility: default -->
|
||||
<element name="TUnicodeEnumeratorBase">
|
||||
<short></short>
|
||||
<short>Base class for a Unicode character enumerator.</short>
|
||||
<descr>
|
||||
Base class for a Unicode character enumerator.
|
||||
</descr>
|
||||
@ -364,20 +364,16 @@
|
||||
</element>
|
||||
|
||||
<!-- operator Visibility: default -->
|
||||
<element name="Enumerator">
|
||||
<element name="operator enumerator(string): tunicodecharacterenumerator">
|
||||
<short>
|
||||
Enumerator which combines diacritical marks.
|
||||
</short>
|
||||
<descr>
|
||||
Operator enables For ... In loops. This enumerator combines diacritical marks. It is used by default although there are more rules for combining codepoints. Diacritical marks cover rules for most western languages.
|
||||
<p>
|
||||
The enumerator operator enables For ... In loops. This enumerator combines diacritical marks in the String argument for the operator. It is used by default although there are more rules for combining codepoints. Diacritical marks cover rules for most western languages.
|
||||
</p>
|
||||
</descr>
|
||||
</element>
|
||||
<element name="Enumerator.Result">
|
||||
<short>Enumerator for the operator.</short>
|
||||
</element>
|
||||
<element name="Enumerator.A">
|
||||
<short>Values to traverse in the enumerator.</short>
|
||||
</element>
|
||||
|
||||
</module>
|
||||
<!-- LazUnicode -->
|
||||
|
||||
@ -184,7 +184,9 @@
|
||||
</element>
|
||||
|
||||
<element name="MergeSortWithLen">
|
||||
<short></short>
|
||||
<short>
|
||||
Implements a merge sort algorithm for a list of pointers with the given length.
|
||||
</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
@ -199,7 +201,7 @@
|
||||
</element>
|
||||
|
||||
<element name="ConsoleVerbosity">
|
||||
<short></short>
|
||||
<short>Level of detail displayed in IDE console output windows.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>ConsoleVerbosity</var> is an Integer variable which indicates the level of detail output from tools like pas2js and CodeTools. ConsoleVerbosity enables debugger output for specific levels of detail.
|
||||
|
||||
@ -318,20 +318,22 @@
|
||||
|
||||
<element name="Deduplicate">
|
||||
<short>
|
||||
Removes duplicate strings in AStrings.
|
||||
Removes duplicate strings in the AStrings argument.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Removes duplicate strings (with case sensitivity) from <var>AStrings</var>. Deduplicate creates a <var>TLookupStringList</var> instance that is used to remove the duplicate values in AStrings. When AStrings owns and contains objects, the function will return <b>False</b>.
|
||||
Removes duplicate strings (with case sensitivity) from <var>AStrings</var>. Deduplicate creates a <var>TLookupStringList</var> instance that is used to remove the duplicate values in AStrings.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
<seealso>
|
||||
<link id="TLookupStringList"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="Deduplicate.AStrings">
|
||||
<short>TStrings to examine in the function.</short>
|
||||
<short>TStrings instance examined in the function.</short>
|
||||
</element>
|
||||
<element name="Deduplicate.Result">
|
||||
<short>False if AStrings owns and contains objects.</short>
|
||||
<short>The number of duplicates removed from AStrings.</short>
|
||||
</element>
|
||||
|
||||
</module>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user