lazarus/docs/xml/lcl/lclversion.xml
2021-07-10 17:04:43 +00:00

95 lines
2.4 KiB
XML

<?xml version="1.0"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
LCLVersion
====================================================================
-->
<module name="LCLVersion">
<short>Contains the version number constants of the LCL.</short>
<descr>
<p>
<file>lclversion.pas</file> contains the version number constants of the LCL.
They can be used at run-time to determine the LCL version, so LCL application
writers and component writers can offer different functionality or workarounds
for bugs and take the LCL version into account while choosing their algorithms
at run-time.
</p>
<p>
Likewise, these version constants can be used at compile time in conditional
expressions, such as <i>{$IF lcl_major&gt;0}</i>. These kinds of
expressions are supported in <i>{$mode delphi}</i> and <i>{$mode objfpc}</i>.
</p>
</descr>
<element name="lcl_fullversion">
<short>LCL full version.</short>
<descr>
<p>
The lcl_fullversion constant contains all version numbers, formatted with 2
digits and concatenated (leading zeros are omitted).
</p>
<p>
For example, if the LCL version is 2.0.12.6, lcl_fullversion will be 2001206.
</p>
</descr>
<seealso>lcl_version</seealso>
</element>
<element name="lcl_major">
<short>LCL major version.</short>
<descr>
<p>
Given a complete version string like 2.2.0, the lcl_major constant
contains the first number (2).
</p>
</descr>
<seealso/>
</element>
<element name="lcl_minor">
<short>LCL minor version.</short>
<descr>
<p>
Given a version string like 2.2.0, the lcl_minor constant
contains the second number (2).
</p>
</descr>
<seealso>lcl_version</seealso>
</element>
<element name="lcl_release">
<short>LCL release number.</short>
<descr>
<p>
Given a version string like 2.2.0, the lcl_release constant
contains the third number (0).
</p>
</descr>
<seealso>lcl_version</seealso>
</element>
<element name="lcl_patch">
<short>LCL patch version.</short>
<descr>
<p>
Given a complete version string like 2.2.0.1, the lcl_patch constant
contains the last number (1). If there is no fourth number, for example when the
version string is 2.2.0, then lcl_patch is 0.
</p>
</descr>
<seealso>lcl_version</seealso>
</element>
<element name="lcl_version">
<short>LCL version string.</short>
<descr>Contains the LCL version string, e.g. 2.2.0.</descr>
<seealso/>
</element>
</module>
<!-- LCLVersion -->
</package>
</fpdoc-descriptions>