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

This commit is contained in:
dsiders 2023-05-10 08:55:40 +01:00
parent 19e4020609
commit 90c5cbd130
32 changed files with 67 additions and 39 deletions

View File

@ -14,8 +14,8 @@ Definitions for the Clipboard to hold Cut or Copied data for Pasting.
<p> <p>
<file>clipbrd.pp</file> contains classes, types, and routines used to <file>clipbrd.pp</file> contains classes, types, and routines used to
implement TClipboard. TClipboard encapsulates the system clipboard for implement TClipboard. TClipboard encapsulates the system clipboard for
supported platforms. This file is part of the Lazarus Component Library supported platforms. <file>clipbrd.pp</file> is part of the Lazarus Component
(<b>LCL</b>). Library (<b>LCL</b>).
</p> </p>
</descr> </descr>

View File

@ -15,8 +15,7 @@ Defines classes for selecting a color from a combo-box or a list box.
<file>colorbox.pas</file> contains <var>TColorBox</var> and <file>colorbox.pas</file> contains <var>TColorBox</var> and
<var>TColorListBox</var>. TColorBox is a component that displays colors in a <var>TColorListBox</var>. TColorBox is a component that displays colors in a
combo-box control. TColorListBox is a component that displays colors in a combo-box control. TColorListBox is a component that displays colors in a
list box control. This file is part of the Lazarus Component Library list box control. <file>colorbox.pas</file> is part of the Lazarus Component Library (<b>LCL</b>).
(<b>LCL</b>).
</p> </p>
<p> <p>
The following components are added to the Lazarus IDE component palette: The following components are added to the Lazarus IDE component palette:

View File

@ -40,7 +40,7 @@ The following components are added but not displayed on the component palette:
<li>TTabSheet</li> <li>TTabSheet</li>
</ul> </ul>
<p> <p>
This file is part of the <file>LCL</file> (Lazarus Component Library) package. <file>comctrls.pp</file> is part of the Lazarus Component Library (<b>LCL</b>).
</p> </p>
</descr> </descr>

View File

@ -34,7 +34,7 @@ component palette:
<li>TGraphicControl</li> <li>TGraphicControl</li>
</ul> </ul>
<p> <p>
This file is part of the Lazarus Component Library (LCL). <file>controls.pp</file> is part of the Lazarus Component Library (<b>LCL</b>).
</p> </p>
</descr> </descr>

View File

@ -17,7 +17,7 @@ Standard actions used to navigate and manipulate a dataset in a datasource.
used to navigate and manipulate a dataset in a datasource. used to navigate and manipulate a dataset in a datasource.
</p> </p>
<p> <p>
This file is part of the Lazarus Component Library (<b>LCL</b>). <file>dbactns.pp</file> is part of the Lazarus Component Library (<b>LCL</b>).
</p> </p>
<p> <p>
The following components are registered but not displayed on the Lazarus IDE The following components are registered but not displayed on the Lazarus IDE

View File

@ -7,7 +7,7 @@
<short>Contains extended database controls.</short> <short>Contains extended database controls.</short>
<descr> <descr>
<p> <p>
<var>dbextctrls.pp</var> contains extended database-aware controls used in <file>dbextctrls.pp</file> contains extended database-aware controls used in
the Lazarus Component Library (<b>LCL</b>). the Lazarus Component Library (<b>LCL</b>).
</p> </p>
<p> <p>

View File

@ -11,8 +11,8 @@ Dialogs
<descr> <descr>
<p> <p>
<file>dialogs.pp</file> contains classes, types, and routines used to <file>dialogs.pp</file> contains classes, types, and routines used to
implement common dialogs in an application. This file is part of the Lazarus implement common dialogs in an application. <file>dialogs.pp</file> is part of
Component Library (<b>LCL</b>). the Lazarus Component Library (<b>LCL</b>).
</p> </p>
<p> <p>
The following components are added to the Lazarus IDE component palette: The following components are added to the Lazarus IDE component palette:

View File

@ -13,8 +13,8 @@ Types and routines used to implement extended graphic drawing.
<descr> <descr>
<p> <p>
<file>extgraphics.pas</file> contains types and routines which implement <file>extgraphics.pas</file> contains types and routines which implement
extended drawing routines for various shapes. This file is part of the extended drawing routines for various shapes. <file>extgraphics.pas</file> is
Lazarus Component Library (<b>LCL</b>). part of the Lazarus Component Library (<b>LCL</b>).
</p> </p>
</descr> </descr>

View File

@ -17,7 +17,8 @@ not compiled into the LCL. This form is used to design the .lfm file.
The source code is a copy of <file>../lcl/include/finddialog.inc</file>. The source code is a copy of <file>../lcl/include/finddialog.inc</file>.
</p> </p>
<p> <p>
This file is part of the Lazarus Component Library (<b>LCL</b>). <file>finddlgunit.pas</file> is part of the Lazarus Component Library
(<b>LCL</b>).
</p> </p>
</descr> </descr>

View File

@ -31,7 +31,7 @@ used by the Run-time Library (<b>RTL</b>):
<li>TRegion</li> <li>TRegion</li>
</ul> </ul>
<p> <p>
This file is part of the Lazarus Component Library (<b>LCL</b>). <file>graphics.pp</file> is part of the Lazarus Component Library (<b>LCL</b>).
</p> </p>
</descr> </descr>

View File

@ -10,7 +10,7 @@ GraphUtil
<short>Contains routines and types used when drawing graphics.</short> <short>Contains routines and types used when drawing graphics.</short>
<descr> <descr>
<p> <p>
<var>GraphUtil.pp</var> contains routines and types used when drawing <file>graphutil.pp</file> contains routines and types used when drawing
graphics. They focus primarily on converting colors and drawing gradients, graphics. They focus primarily on converting colors and drawing gradients,
scroll bars, and arrows. scroll bars, and arrows.
</p> </p>
@ -33,6 +33,10 @@ where a lightness value of 0 or 1 is fully black or white (respectively).
GraphUtil is used in the Lazarus IDE, in LCL WidgetSet components, and GraphUtil is used in the Lazarus IDE, in LCL WidgetSet components, and
optional Lazarus components like FPReport, SynEdit, and TAChart. optional Lazarus components like FPReport, SynEdit, and TAChart.
</p> </p>
<p>
<file>graphutil.pp</file> is part of the Lazarus Component Library
(<b>LCL</b>).
</p>
</descr> </descr>
<!-- unresolved type references Visibility: default --> <!-- unresolved type references Visibility: default -->

View File

@ -21,7 +21,8 @@ help system. To create your own help system, implement a descendant of
<var>THelpManager</var>. <var>THelpManager</var>.
</p> </p>
<p> <p>
This file is part of the Lazarus Component Library (<b>LCL</b>). <file>helpintfs.pas</file> is part of the Lazarus Component Library
(<b>LCL</b>).
</p> </p>
<p> <p>
Author: Mattias Gaertner Author: Mattias Gaertner

View File

@ -20,7 +20,8 @@ taken from the univint package in FPC.
Author: Paul Ishenin Author: Paul Ishenin
</p> </p>
<p> <p>
This file is part of the Lazarus Component Library (<b>LCL</b>) <file>icnstypes.pas</file> is part of the Lazarus Component Library
(<b>LCL</b>)
</p> </p>
</descr> </descr>

View File

@ -19,7 +19,8 @@ implement a cache for <var>TCustomImageList</var> instances. It is used mainly
to cache image lists with the glyphs used on button controls. to cache image lists with the glyphs used on button controls.
</p> </p>
<p> <p>
This file is part of the Lazarus Component Library (<b>LCL</b>). <file>imagelistcache.pas</file> is part of the Lazarus Component Library
(<b>LCL</b>).
</p> </p>
</descr> </descr>

View File

@ -17,7 +17,8 @@ define a platform-independent widgetset class (<var>TWidgetSet</var>) and
helper functions. helper functions.
</p> </p>
<p> <p>
This file is part of the Lazarus Component Library (<b>LCL</b>). <file>interfacebase.pp</file> is part of the Lazarus Component Library
(<b>LCL</b>).
</p> </p>
</descr> </descr>

View File

@ -14,7 +14,8 @@ LCL interface class for the text renderer in the FreeType package.
</short> </short>
<descr> <descr>
<p> <p>
This file is part of the Lazarus Component Library (<b>LCL</b>). <file>lazfreetypeintfdrawer.pas</file> is part of the Lazarus Component
Library (<b>LCL</b>).
</p> </p>
</descr> </descr>

View File

@ -13,13 +13,13 @@ Base class for a memory manager used in the LCL and its interfaces.
<descr> <descr>
<p> <p>
<file>lclmemmanager.pas</file> contains classes and type used to define the <file>lclmemmanager.pas</file> contains classes and type used to define the
base base class for various memory managers used in the Lazarus Component Library
class for various memory managers used in the Lazarus Component Library
(<b>LCL</b>) and its interfaces. An own memory manager is somewhat faster and (<b>LCL</b>) and its interfaces. An own memory manager is somewhat faster and
makes debugging and profiling easier. makes debugging and profiling easier.
</p> </p>
<p> <p>
This file is part of the Lazarus Component Library (<b>LCL</b>). <file>lclmemmanager.pas</file> is part of the Lazarus Component Library
(<b>LCL</b>).
</p> </p>
<p> <p>
Author: Mattias Gaertner Author: Mattias Gaertner

View File

@ -17,7 +17,8 @@ the LCL from the different widgetsets easier. Your mileage will vary if you
try to use these procedures from within your program. try to use these procedures from within your program.
</p> </p>
<p> <p>
This file is part of the Lazarus Component Library (<b>LCL</b>). <file>lclmessageglue.pas</file> is part of the Lazarus Component Library
(<b>LCL</b>).
</p> </p>
</descr> </descr>

View File

@ -14,7 +14,8 @@ LCLPlatformDef
routines used in LCL platform definitions. routines used in LCL platform definitions.
</p> </p>
<p> <p>
This file is part of the Lazarus Component Library (<b>LCL</b>). <file>lclplatformdef.pas</file> is part of the Lazarus Component Library
(<b>LCL</b>).
</p> </p>
</descr> </descr>

View File

@ -14,7 +14,7 @@ LCLProc
that are useful in LCL applications. that are useful in LCL applications.
</p> </p>
<p> <p>
This file is part of the Lazarus Component Library (<b>LCL</b>). <file>lclproc.pas</file> is part of the Lazarus Component Library (<b>LCL</b>).
</p> </p>
</descr> </descr>

View File

@ -14,7 +14,8 @@ LCLResCache
interface resources. See <file>graphics.pp</file> for examples. interface resources. See <file>graphics.pp</file> for examples.
</p> </p>
<p> <p>
This file is part of the Lazarus Component Library (<b>LCL</b>). <file>lclrescache.pas</file> is part of the Lazarus Component Library
(<b>LCL</b>).
</p> </p>
<p> <p>
Author: Mattias Gaertner Author: Mattias Gaertner

View File

@ -12,7 +12,7 @@ Performs string translation in the Lazarus IDE and LCL.
</short> </short>
<descr> <descr>
<p> <p>
<var>lcltranslator.pas</var> contains classes and routines used to perform <file>lcltranslator.pas</file> contains classes and routines used to perform
translation for strings used in Lazarus IDE and LCL (Lazarus Component translation for strings used in Lazarus IDE and LCL (Lazarus Component
Library). It searches for .po (Portable Object) and/or .mo (Machine Object) Library). It searches for .po (Portable Object) and/or .mo (Machine Object)
files used to perform I18n internationalization and L10n localization. The files used to perform I18n internationalization and L10n localization. The
@ -41,6 +41,10 @@ href="http://wiki.lazarus.freepascal.org/Step-by-step_instructions_for_creating_
Creating Multi-Language Applications Creating Multi-Language Applications
</url> </url>
</p> </p>
<p>
<file>lcltranslator.pas</file> is part of the Lazarus Component Library
(<b>LCL</b>).
</p>
</descr> </descr>
<element name="Classes"/> <element name="Classes"/>

View File

@ -16,7 +16,8 @@ This unit defines TLazDockTree, the default TDockTree used in the LCL.
TDockTree used in the LCL. TDockTree used in the LCL.
</p> </p>
<p> <p>
This file is part of the Lazarus Component Library (LCL). <file>ldocktree.pas</file> is part of the Lazarus Component Library
<b>(LCL)</b>.
</p> </p>
</descr> </descr>
<descr/> <descr/>

View File

@ -15,7 +15,8 @@ for other platforms/widgetsets.
<p> <p>
<file>lmessages.pp</file> contains Lazarus message codes and their mapping <file>lmessages.pp</file> contains Lazarus message codes and their mapping
to message codes for other platforms/widgetsets. to message codes for other platforms/widgetsets.
This file is part of the Lazarus Component Library (<b>LCL</b>). <file>lmessages.pp</file> is part of the Lazarus Component Library
(<b>LCL</b>).
</p> </p>
</descr> </descr>

View File

@ -36,7 +36,8 @@ Lazarus resource include file.
Author: Mattias Gaertner Author: Mattias Gaertner
</p> </p>
<p> <p>
This file is part of the Lazarus Component Library (<b>LCL</b>). <file>lresources.pp</file> is part of the Lazarus Component Library
(<b>LCL</b>).
</p> </p>
</descr> </descr>

View File

@ -23,7 +23,7 @@ following components are added to the Lazarus IDE component palette:
<li>TMaskEdit</li> <li>TMaskEdit</li>
</ul> </ul>
<p> <p>
This file is part of the Lazarus Component Library (<b>LCL</b>). <file>maskedit.pp</file> is part of the Lazarus Component Library (<b>LCL</b>).
</p> </p>
</descr> </descr>

View File

@ -21,7 +21,8 @@ Please note that <var>ExtCtrls</var> has a dependency on the
<var>popupnotifier</var> and other units should be avoided. <var>popupnotifier</var> and other units should be avoided.
</remark> </remark>
<p> <p>
This file is part of the Lazarus Component Library (<b>LCL</b>). <file>popupnotifier.pas</file> is part of the Lazarus Component Library
(<b>LCL</b>).
</p> </p>
</descr> </descr>

View File

@ -20,7 +20,8 @@ implemented in a descendent class. For example: TControlPropertyStorage,
TFormPropertyStorage, TIniPropStorage, TJSONPropStorage, and TXMLPropStorage. TFormPropertyStorage, TIniPropStorage, TJSONPropStorage, and TXMLPropStorage.
</p> </p>
<p> <p>
This file is part of the <b>Lazarus Component Library (LCL)</b>. <file>propertystorage.pas</file> is part of the Lazarus Component Library
<b>(LCL)</b>.
</p> </p>
</descr> </descr>

View File

@ -11,7 +11,7 @@ Spin
<descr> <descr>
<p> <p>
<file>spin.pp</file> contains classes which implement spin edit controls. <file>spin.pp</file> contains classes which implement spin edit controls.
This file is part of the Lazarus Component Library (<b>LCL</b>). <file>spin.pp</file> is part of the Lazarus Component Library (<b>LCL</b>).
</p> </p>
<p> <p>
The following components are added to the Lazarus IDE component palette: The following components are added to the Lazarus IDE component palette:

View File

@ -14,8 +14,8 @@ Defines standard actions used in Action Lists in the LCL.
<p> <p>
<file>stdactns.pas</file> contains <var>TAction</var> descendents <file>stdactns.pas</file> contains <var>TAction</var> descendents
which can be used in <var>TActionList</var> for common actions which can be used in <var>TActionList</var> for common actions
performed using controls. This file is part of the Lazarus Component performed using controls. <file>stdactns.pas</file> is part of the Lazarus
Library (<b>LCL</b>). Component Library (<b>LCL</b>).
</p> </p>
<p> <p>
The following components are registered but not displayed on the The following components are registered but not displayed on the

View File

@ -14,7 +14,7 @@ Defines an assertion error handler used for tracebacks in the debugger.
</short> </short>
<descr> <descr>
<p> <p>
This file is part of the Lazarus Component Library (<b>LCL</b>). <file>utrace.pp</file> is part of the Lazarus Component Library (<b>LCL</b>).
</p> </p>
</descr> </descr>

View File

@ -10,7 +10,8 @@ WSControls
<short>Contains the base interface classes for widgetset controls.</short> <short>Contains the base interface classes for widgetset controls.</short>
<descr> <descr>
<p> <p>
This file is part of the Lazarus Component Library (<b>LCL</b>). <file>wscontrols.pp</file> is part of the Lazarus Component Library
(<b>LCL</b>).
</p> </p>
</descr> </descr>
@ -18,8 +19,10 @@ This file is part of the Lazarus Component Library (<b>LCL</b>).
<element name="DefBtnColors"> <element name="DefBtnColors">
<short>Default colors used for button faces and button text.</short> <short>Default colors used for button faces and button text.</short>
<descr> <descr>
<p>
DefBtnColors is an array type which contains the default colors used for DefBtnColors is an array type which contains the default colors used for
button faces and button text in the widgetset class. button faces and button text in the widgetset class.
</p>
</descr> </descr>
<seealso></seealso> <seealso></seealso>
</element> </element>
@ -27,7 +30,9 @@ button faces and button text in the widgetset class.
<element name="TWSDragImageListResolution"> <element name="TWSDragImageListResolution">
<short></short> <short></short>
<descr> <descr>
<p>
TWSDragImageListResolution is a TWSCustomImageListResolution descendant. TWSDragImageListResolution is a TWSCustomImageListResolution descendant.
</p>
</descr> </descr>
<seealso></seealso> <seealso></seealso>
</element> </element>
@ -233,7 +238,9 @@ TWSDragImageListResolution is a TWSCustomImageListResolution descendant.
<element name="TWSControl"> <element name="TWSControl">
<short></short> <short></short>
<descr> <descr>
<p>
TWSControl is a TWSLCLComponent descendant. TWSControl is a TWSLCLComponent descendant.
</p>
</descr> </descr>
<seealso></seealso> <seealso></seealso>
</element> </element>