Docs: LCL,LazUtils. Updates for module descriptions.

git-svn-id: trunk@65256 -
This commit is contained in:
dsiders 2021-06-17 06:12:31 +00:00
parent 2c391e29f7
commit bd406daec9
10 changed files with 57 additions and 16 deletions

View File

@ -9,8 +9,17 @@
--> -->
<module name="Laz_XMLCfg"> <module name="Laz_XMLCfg">
<short></short> <short>Provides an implementation of TXMLConfig</short>
<descr> <descr>
<p>
TXMLConfig enables applications to use XML files for storing their configuration data.
</p>
<p>
Copyright (c) 1999 - 2001 by Sebastian Guenther, sg@freepascal.org
</p>
<p>
This file is part of the <file>LazUtils</file> package.
</p>
</descr> </descr>
<!-- class Visibility: default --> <!-- class Visibility: default -->

View File

@ -7,7 +7,7 @@
==================================================================== ====================================================================
--> -->
<module name="FindDlgUnit"> <module name="FindDlgUnit">
<short/> <short>Contains a form template for the find dialog in LCL</short>
<descr> <descr>
<p> <p>
Only the .lfm file is used by the LCL (dialogs.pp). This unit is itself is not compiled into the LCL. This form is used to design the .lfm file. Only the .lfm file is used by the LCL (dialogs.pp). This unit is itself is not compiled into the LCL. This form is used to design the .lfm file.
@ -15,6 +15,9 @@
<p> <p>
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>
This file is part of the Lazarus Component Library (<b>LCL</b>).
</p>
</descr> </descr>
<!-- used units --> <!-- used units -->

View File

@ -1,4 +1,4 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions> <fpdoc-descriptions>
<package name="lcl"> <package name="lcl">
<!-- <!--
@ -7,12 +7,10 @@
==================================================================== ====================================================================
--> -->
<module name="Graphics"> <module name="Graphics">
<short> <short>Contains definitions for classes and types used in graphic applications</short>
Contains definitions for many fundamental classes and types used in graphic applications
</short>
<descr> <descr>
<p> <p>
<file>graphics.pp</file> contains classes, types, and routines used to represent graphic images in a Lazarus Component Library (<b>LCL</b>) application. The following classes are added to the registered class list used in the Run-time Library (<b>RTL</b>): <file>graphics.pp</file> contains classes, types, and routines used to represent graphic images in a Lazarus Component Library (<b>LCL</b>) application. The following classes are added to the registered class list used by the Run-time Library (<b>RTL</b>):
</p> </p>
<ul> <ul>
<li>TBitmap</li> <li>TBitmap</li>
@ -27,6 +25,9 @@
<li>TBrush</li> <li>TBrush</li>
<li>TRegion</li> <li>TRegion</li>
</ul> </ul>
<p>
This file is part of the Lazarus Component Library (<b>LCL</b>).
</p>
</descr> </descr>
<!-- unresolved external references --> <!-- unresolved external references -->

View File

@ -9,8 +9,17 @@
--> -->
<module name="IcnsTypes"> <module name="IcnsTypes">
<short/> <short>Provides support for Mac OS X icon resources</short>
<descr> <descr>
<p>
<file>icnstypes.pas</file> contains types, constants and functions needed to read Mac OS X icon resource files (or icns). Most defines present here were taken from the univint package in FPC.
</p>
<p>
Author: Paul Ishenin
</p>
<p>
This file is part of the Lazarus Component Library (<b>LCL</b>)
</p>
</descr> </descr>
<!-- array type Visibility: default --> <!-- array type Visibility: default -->

View File

@ -1,4 +1,4 @@
<?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions> <fpdoc-descriptions>
<package name="lcl"> <package name="lcl">
@ -9,8 +9,11 @@
--> -->
<module name="IndustrialBase"> <module name="IndustrialBase">
<short></short> <short>Contains the base class for graphic controls that support anti-aliasing</short>
<descr> <descr>
<p>
<file>industrialbase.pp</file> contains the base class for graphic controls that support anti-aliasing.
</p>
</descr> </descr>
<!-- class Visibility: default --> <!-- class Visibility: default -->

View File

@ -9,8 +9,11 @@
--> -->
<module name="LazFreeTypeIntfDrawer"> <module name="LazFreeTypeIntfDrawer">
<short></short> <short>LCL interface class for the text renderer in the FreeType package</short>
<descr> <descr>
<p>
This file is part of the Lazarus Component Library (<b>LCL</b>).
</p>
</descr> </descr>
<!-- unresolved external references --> <!-- unresolved external references -->

View File

@ -9,8 +9,14 @@
--> -->
<module name="LCLMessageGlue"> <module name="LCLMessageGlue">
<short/> <short>Contains routines used to send messages from widgetset classes to the LCL</short>
<descr> <descr>
<p>
<file>lclmessageglue.pas</file> is used to make the passing of messages to the LCL from the different widgetsets easier. Your mileage will vary if you try to use these procedures from within your program.
</p>
<p>
This file is part of the Lazarus Component Library (<b>LCL</b>).
</p>
</descr> </descr>
<!-- unresolved type reference Visibility: default --> <!-- unresolved type reference Visibility: default -->

View File

@ -8,7 +8,7 @@
--> -->
<module name="MaskEdit"> <module name="MaskEdit">
<short> <short>
Defines classes for a masked edit control, i.e. editing with a masking string in place to obscure, format, or validate the text entered in the control Defines classes for a masked edit control
</short> </short>
<descr> <descr>
<p> <p>

View File

@ -9,8 +9,11 @@
--> -->
<module name="UTrace"> <module name="UTrace">
<short/> <short>Defines an assertion error handler used for tracebacks in the debugger</short>
<descr> <descr>
<p>
This file is part of the Lazarus Component Library (<b>LCL</b>).
</p>
</descr> </descr>
<!-- unresolved type reference Visibility: default --> <!-- unresolved type reference Visibility: default -->

View File

@ -7,8 +7,12 @@
====================================================================== ======================================================================
--> -->
<module name="WSControls"> <module name="WSControls">
<short></short> <short>Contains the base interface classes for widgetset controls</short>
<descr></descr> <descr>
<p>
This file is part of the Lazarus Component Library (<b>LCL</b>).
</p>
</descr>
<element name="DefBtnColors"> <element name="DefBtnColors">