Docs: LazUtils/various. Standardizes tagging for file names in unit overview topics.

This commit is contained in:
dsiders 2023-05-10 08:55:11 +01:00
parent d6c2ae28f5
commit 19e4020609
55 changed files with 79 additions and 72 deletions

View File

@ -18,7 +18,7 @@ TAvlTree is an Average Level binary Tree, located in unit AVL_Tree in FPC
packages.
</p>
<p>
This file is part of the <file>lazutils</file> package.
<file>avglvltree.pas</file> is part of the <file>lazutils</file> package.
</p>
</descr>

View File

@ -6,7 +6,7 @@
<short>Contains Unicode conversion tables for Asian code pages.</short>
<descr>
<p>
This file is part of the <file>lazutils</file> package.
<file>codepagesasian.pas</file> is part of the <file>lazutils</file> package.
</p>
</descr>

View File

@ -53,7 +53,7 @@ in the Lazarus IDE.
Author: Mattias Gaertner
</p>
<p>
This file is part of the <file>lazutils</file> package.
<file>compwriterpas.pas</file> is part of the <file>lazutils</file> package.
</p>
</descr>

View File

@ -10,12 +10,12 @@ DynamicArray
<short>Implements a resizable 2-D array of Pointers.</short>
<descr>
<p>
<file>dynamicarray.pas</file>implements a resizable 2-D array of Pointers. It
<file>dynamicarray.pas</file> implements a resizable 2-D array of Pointers. It
is used to implement the Cells, Cols, and Rows properties in
<var>TCustomGrid</var>, <var>TDrawGrid</var> and <var>TStringGrid</var>.
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>dynamicarray.pas</file> is part of the <file>LazUtils</file> package.
</p>
<p>
Author: Jesus Reyes

View File

@ -12,7 +12,7 @@ Contains classes used to manage dynamic sets or associative arrays.
</short>
<descr>
<p>
<file>DynHashArray.pp</file> extends the functionality of Pascal by
<file>dynhasharray.pp</file> extends the functionality of Pascal by
offering alternative data structure: set like array (the order is not kept)
with fast find/delete. Its size can change automatically during the
execution of the program. The price is that it is somewhat slower than
@ -66,7 +66,7 @@ Important: Items in the TDynHashArray must not change their key. When
changing the key of an item, remove it and add it after the change.
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>dynhasharray.pp</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -14,7 +14,7 @@ DynQueue
dynamic FIFO queue for arbitrary data.
</p>
<p>
This file is part of the <file>lazutils</file> package.
<file>dynqueue.pp</file> is part of the <file>lazutils</file> package.
</p>
</descr>

View File

@ -18,7 +18,7 @@ which is a <var>TStringList</var> that allows its <var>Objects</var> property
to hold any type of record.
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>extendedstrings.pas</file> is part of the <file>LazUtils</file> package.
</p>
<p>
Author: Mattias Gaertner

View File

@ -20,7 +20,8 @@ search path for files in the list.
Author: Mattias Gaertner
</p>
<p>
This file is part of the <file>lazutils</file> package.
<file>filereferencelist.pas</file> is part of the <file>lazutils</file>
package.
</p>
</descr>

View File

@ -18,7 +18,7 @@ the code page for conversions and the <var>RTL</var> file system to
OS-es where the <var>RTL</var> (<b>Run-Time Library</b>) is UTF-8-enabled.
</p>
<p>
This file is part of the <file>lazutils</file> package.
<file>fpcadds.pas</file> is part of the <file>lazutils</file> package.
</p>
</descr>

View File

@ -15,7 +15,8 @@ drawing.
<p>
<file>graphmath.pp</file> contains math helper routines for use for
graphics drawing. It is used to simply cross-platform canvas drawing
operations. This file is part of the <file>LazUtils</file> package.
operations. <file>graphmath.pp</file> is part of the <file>LazUtils</file>
package.
</p>
</descr>

View File

@ -17,7 +17,7 @@ graphics.
and utility functions.
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>graphtype.pp</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -17,7 +17,7 @@ converts HTML into plain text by converting tags and their attributes to a
representation as plain text.
</p>
<p>
This file is part of the <file>lazutils</file> package.
<file>html2textrender.pas</file> is part of the <file>lazutils</file> package.
</p>
</descr>

View File

@ -21,7 +21,7 @@ Cardinal, Integer, and Int64 types. Each provides an overloaded
handled in the method.
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>integerlist.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -10,7 +10,7 @@ laz2_DOM
<short>Provides an implementation of DOM interfaces.</short>
<descr>
<p>
<var>laz2_dom.pas</var> provides an Implementation of DOM (Document Object
<file>laz2_dom.pas</file> provides an Implementation of DOM (Document Object
Model) interfaces. It is a modified copy of the FCL dom.pp unit (revision
15251) adapted to use UTF-8 instead of WideString by Mattias Gaertner.
</p>
@ -33,7 +33,7 @@ Document Object Model (DOM) Level 2 Specification
</url>
</p>
<p>
This file is part of the <file>lazutils</file> package.
<file>laz2_dom.pas</file> is part of the <file>lazutils</file> package.
</p>
</descr>

View File

@ -21,7 +21,7 @@ It is copied from the FreePascal Free Component Library (<b>FCL</b>) and
adapted to use UTF-8 strings instead of WideStrings.
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>laz2_xmlcfg.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -12,8 +12,8 @@ Provides routines used to read XML content from a file, text file, or stream.
</short>
<descr>
<p>
<var>laz2_xmlread.pas</var> provides routines used to read XML content from a
file, text file, or stream. It is copied from the FCL unit xmlread.pp (SVN
<file>laz2_xmlread.pas</file> provides routines used to read XML content from
a file, text file, or stream. It is copied from the FCL unit xmlread.pp (SVN
revision 15251), and adapted to use UTF-8 instead of widestrings by Mattias
Gaertner.
</p>
@ -23,7 +23,7 @@ Modified in 2006 by Sergei Gorelkin, sergei_gorelkin@mail.ru <br/>
Converted to use UTF-8 instead of widestrings by Mattias Gaertner.
</p>
<p>
This file is part of the <file>lazutils</file> package.
<file>laz2_xmlread.pas</file> is part of the <file>lazutils</file> package.
</p>
</descr>

View File

@ -17,7 +17,7 @@ the UTF-8 encoding. It is copied from code in the FreePascal Free Component
Library (FCL) and modified to provide UTF-8 support.
</p>
<p>
This file is part of <file>LazUtils</file> package.
<file>laz2_xmlutils.pas</file> is part of <file>LazUtils</file> package.
</p>
</descr>

View File

@ -12,7 +12,7 @@ Provides routines used to write XML content to a file, text file, or stream.
</short>
<descr>
<p>
<var>laz2_xmlwrite.pas</var> provides procedures and types used to write XML
<file>laz2_xmlwrite.pas</file> provides procedures and types used to write XML
content to a file, text file, or stream. laz2_xmlwrite.pas has classes in its
implementation section that are used to perform serialization of XML content
to the storage destination.
@ -23,7 +23,7 @@ Modified in 2006 by Sergei Gorelkin, sergei_gorelkin@mail.ru <br/>
Converted to use UTF-8 instead of widestrings by Mattias Gaertner.
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>laz2_xmlwrite.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -12,9 +12,9 @@ An implementation of the XML Path Language (XPath) for Free Pascal.
</short>
<descr>
<p>
<var>laz2_xpath.pas</var> provides an implementation of the XML Path Language
(XPath) for the Lazarus IDE. It is based on the <var>xpath.pp</var> unit from
the Free Component Library (FCL).
<file>laz2_xpath.pas</file> provides an implementation of the XML Path
Language (XPath) for the Lazarus IDE. It is based on the <file>xpath.pp</file>
unit from the Free Component Library (FCL).
</p>
<p>
Copyright (c) 2000 - 2003 by Areca Systems GmbH / Sebastian Guenther,
@ -31,7 +31,7 @@ W3C Recommendation,
</url>
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>laz2_xpath.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -12,12 +12,12 @@ Provides an implementation of DOM Interfaces.
</short>
<descr>
<p>
<var>laz_dom.pas</var> provides an implementation of the Interfaces for the
<file>laz_dom.pas</file> provides an implementation of the Interfaces for the
DOM (Document Object Model). Classes in this unit are aliased to the UTF-8
implementation provided in <var>laz2_dom.pas</var>.
implementation provided in <file>laz2_dom.pas</file>.
</p>
<p>
This file is part of the <file>lazutils</file> package.
<file>laz_dom.pas</file> is part of the <file>lazutils</file> package.
</p>
</descr>

View File

@ -19,7 +19,7 @@ configuration data.
Copyright (c) 1999 - 2001 by Sebastian Guenther, sg@freepascal.org
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>laz_xmlcfg.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -12,7 +12,7 @@ Provides routines used to read XML content from a file, text file, or stream.
</short>
<descr>
<p>
This file is part of the <file>LazUtils</file> package.
<file>laz_xmlread.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -23,7 +23,7 @@ Extended by Mattias Gaertner:
<li>Custom properties (via DefineProperties).</li>
</ul>
<p>
This file is part of the <file>LazUtils</file> package.
<file>laz_xmlstreaming.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -10,7 +10,7 @@ Laz_XMLWrite
<short>Provides routines used to write XML documents or nodes.</short>
<descr>
<p>
This file is part of the <file>LazUtils</file> package.
<file>laz_xmlwrite.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -13,7 +13,7 @@ reference counting.
</short>
<descr>
<p>
This file is part of the <file>lazutils</file> package.
<file>lazclasses.pas</file> is part of the <file>lazutils</file> package.
</p>
</descr>

View File

@ -14,7 +14,7 @@ lazCollections
thread-safe collections.
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>lazCollections.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -12,7 +12,7 @@ Defines various base classes for loading and saving configuration files.
</short>
<descr>
<p>
This file is part of the <file>LazUtils</file> package.
<file>lazconfigstorage.pas</file> is part of the <file>LazUtils</file> package.
</p>
<p>
Author: Mattias Gaertner

View File

@ -10,7 +10,7 @@ LazDbgLog
<short>Contains utility routines used in the Lazarus Debugger and IDE.</short>
<descr>
<p>
This file is part of the <file>LazUtils</file> package.
<file>lazdbglog.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -12,7 +12,7 @@ lazfglhash
<short>Contains a hash table implementation using Generics.</short>
<descr>
<p>
This file is part of the <file>LazUtils</file> package.
<file>lazfglhash.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -19,7 +19,7 @@ directory state information. It is used in the implementation of the Lazarus
IDE, and in the LCL package system.
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>lazfilecache.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -15,7 +15,7 @@ LazLinkedList
O(1). Finding can be done in time O(n).
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>lazlinkedlist.pas</file> is part of the <file>LazUtils</file> package.
</p>
<p>
Authors: Mattias Gaertner, Jeroen van Iddekinge

View File

@ -196,7 +196,7 @@ overlaps with "To").
</li>
</ul>
<p>
This file is part of the <file>LazUtils</file> package.
<file>lazlistclasses.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>
<version>Initial revision: May 2015</version>

View File

@ -29,7 +29,7 @@ The easiest method is to use the unit and put "DebugLn"/ "DbgOut" /
setup.
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>LazLogger.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -132,7 +132,7 @@ callback must be thread save by itself. Changing the routine assigned to the
property is <b>NOT</b> thread-safe.
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>lazloggerbase.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>
<!-- unresolved externals -->

View File

@ -12,7 +12,7 @@ LazLoggerDummy
<short>Provide an empty re-implementation of LazLoggerBase.</short>
<descr>
<p>
This file is part of the <file>LazUtils</file> package.
<file>lazloggerdummy.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -14,7 +14,8 @@ Contains classes and routines used for profiling in the Lazarus debugger.
</short>
<descr>
<p>
This file is part of the <file>LazUtils</file> package.
<file>lazloggerprofiling.pas</file> is part of the <file>LazUtils</file>
package.
</p>
</descr>

View File

@ -14,7 +14,7 @@ LazMethodList
representing event handler routines in LCL components.
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>lazmethodlist.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -15,7 +15,7 @@ LazPasReadUtil
Helper functions for component serialized Pascal.
</p>
<p>
This file is part of the <file>lazutils</file> package.
<file>lazpasreadutil.pas</file> is part of the <file>lazutils</file> package.
</p>
</descr>

View File

@ -11,7 +11,8 @@ LazSysUtils
<descr>
<p>
<file>lazsysutils.pas</file> contains utility functions for the various
supported platforms. This file is part of the <file>LazUtils</file> package.
supported platforms. <file>lazsysutils.pas</file> is part of the
<file>LazUtils</file> package.
</p>
</descr>

View File

@ -13,15 +13,18 @@ enumerator.
</short>
<descr>
<p>
<var>lazunicode.pas</var> provides encoding-agnostic Unicode string
<file>lazunicode.pas</file> provides encoding-agnostic Unicode string
manipulation functions and an enumerator. It works transparently with UTF-8
and UTF-16 encodings, and allows one codebase to work for:
</p>
<ol>
<li>Lazarus using its default UTF-8 encoding</li>
<li>Future FPC and Lazarus versions with Delphi compatible UTF-16
encoding</li>
<li>Delphi compatibility where String is defined as UnicodeString</li>
<li>
Future FPC and Lazarus versions with Delphi compatible UTF-16 encoding
</li>
<li>
Delphi compatibility where String is defined as UnicodeString
</li>
</ol>
<remark>
Behavior of helper functions are altered using the <var>{$ModeSwitch
@ -29,7 +32,7 @@ UnicodeStrings}</var> directive; the correct routines for handling UTF-8 or
UTF-16 are called based on the mode switch value.
</remark>
<p>
This file is part of the <file>LazUtils</file> package.
<file>lazunicode.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -26,7 +26,7 @@ Currently this unit includes only UTF8LowerCaseViaTables which is based on
a UTF-16 table, but it might be extended to include various UTF-16 routines.
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>lazutf16.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -16,7 +16,7 @@ Routines for managing UTF-8-encoded strings.
strings. All routines are thread-safe unless explicitly stated.
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>lazutf8.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -11,11 +11,11 @@ Implements UTF-8-enabled classes and routines.
<p>
<file>lazutf8classes.pas</file> implements UTF-8-enabled classes and
routines, including: TFileStreamUTF8, TMemoryStreamUTF8, and TStringListUTF8.
This file is part of the <file>LazUtils</file> package.
<file>lazutf8classes.pas</file> is part of the <file>LazUtils</file> package.
</p>
<remark>
lazutf8classes has an implementation dependency on the
<file>lazfileutils</file> unit.
<file>lazfileutils.pas</file> unit.
</remark>
</descr>

View File

@ -13,7 +13,7 @@ and LCL.
</short>
<descr>
<p>
This file is part of the <file>LazUtils</file> package.
<file>lazutilities.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -17,7 +17,7 @@ Values in the unit are used as the basis for corresponding LCL version
numbers in the <file>lclversion.pas</file> unit.
</p>
<p>
This file is part of the <file>lazutils</file> package.
<file>lazversion.pas</file> is part of the <file>lazutils</file> package.
</p>
</descr>

View File

@ -19,7 +19,7 @@ implementation of the <file>LazUtils</file> package and the <var>TGrid</var>
component.
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>lcsvutils.pas</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -13,8 +13,8 @@ Contains TLookupStringList, an unsorted StringList with a fast lookup feature.
<descr>
<p>
<file>lookupstringlist.pas</file> contains TLookupStringList, an unsorted
StringList with a fast lookup feature. This file is part of the
<file>LazUtils</file> package.
StringList with a fast lookup feature. <file>lookupstringlist.pas</file> is
part of the <file>LazUtils</file> package.
</p>
<p>
Authors: Juha Manninen / Antônio Galvão

View File

@ -20,7 +20,7 @@ size of 1, 2, 4, 8, 16 or 32 bytes. The data can be of any (constant) size.
Author: Marc Weustink
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>maps.pp</file> is part of the <file>LazUtils</file> package.
</p>
</descr>

View File

@ -22,7 +22,7 @@ It is fast and optimized, and fully supports Unicode. Also supports
DOS/Windows compatible masks which behave differently from standard masks.
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>masks.pas</file> is part of the <file>LazUtils</file> package.
</p>
<p>
Author: José Mejuto

View File

@ -17,7 +17,7 @@ objects/pointers with objects/pointers. Converted to use generics by Juha.
Item and Object types can now be defined.
</p>
<p>
This file is part of the <file>lazutils</file> package.
<file>objectlists.pas</file> is part of the <file>lazutils</file> package.
</p>
</descr>

View File

@ -16,7 +16,7 @@ StringHashList
implement a hashed list of string values.
</p>
<p>
This file is part of the <file>lazutils</file> package.
<file>stringhashlist.pas</file> is part of the <file>lazutils</file> package.
</p>
<p>
Thanks to Markus Waldenburg.

View File

@ -18,7 +18,7 @@ optimized for handling their complete text as a whole (instead of line by
line).
</p>
<p>
This file is part of the <file>lazutils</file> package.
<file>textstrings.pas</file> is part of the <file>lazutils</file> package.
</p>
</descr>

View File

@ -17,7 +17,7 @@ Contains classes and routines used to load/check/maintain translations from
load/check/maintain translations from .po (portable object) files.
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>translations.pas</file> is part of the <file>LazUtils</file> package.
</p>
<p>
Initial authors: Mattias Gaertner, Bart Broersma, Giuliano Colla

View File

@ -15,7 +15,7 @@ Contains types and constants used in modal dialogs.
<file>uitypes.pas</file> contains types and constants used in modal dialogs.
</p>
<p>
This file is part of the <file>lazutils</file> package.
<file>uitypes.pas</file> is part of the <file>lazutils</file> package.
</p>
<remark>
The <file>UITypes</file> unit has been marked as deprecated in versions after

View File

@ -19,7 +19,7 @@ properties. The TProcessUTF8 component is added to the <b>System</b> tab in
the Lazarus IDE Component Palette.
</p>
<p>
This file is part of the <file>LazUtils</file> package.
<file>utf8process.pp</file> is part of the <file>LazUtils</file> package.
</p>
</descr>