lazarus/docs/xml/lcl/lclversion.xml

73 lines
2.3 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
<package name="lcl">
<!--
====================================================================
LCLVersion
====================================================================
-->
<module name="LCLVersion">
<short>Contains the version number constants of the LCL.</short>
<descr><p>The LCLVersion unit contains the version number constants of the LCL.
They can be used at runtime 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 an conditional
expressions, such as <i>{$IFDEF lcl_major&gt;0}</i>. Currently these kinds of
epressions are only support in <i>{$mode delphi}</i>. Recently fpc 2.3.1 added
support for these kind of expressions in <i>{$mode objfpc}</i>.</p>
</descr>
<!-- constant Visibility: default -->
<element name="lcl_major">
<short>LCL major version</short>
<descr>Given a complete version string like 0.9.25, the lcl_major constant
contains the first number.
</descr>
<seealso>
</seealso>
</element>
<!-- constant Visibility: default -->
<element name="lcl_minor">
<short>LCL minor version</short>
<descr>Given a version string like 0.9.25, the lcl_minor constant
contains the second number.</descr>
<seealso>lcl_version</seealso>
</element>
<!-- constant Visibility: default -->
<element name="lcl_release">
<short>LCL release number</short>
<descr>Given a version string like 0.9.25, the lcl_release constant
contains the third number.</descr>
<seealso>lcl_version</seealso>
</element>
<!-- constant Visibility: default -->
<element name="lcl_patch">
<short>LCL patch version</short>
<descr>Given a complete version string like 0.9.24.1, the lcl_patch constant
contains the last number. If there is not fourth number, for example when the
version string is 0.9.25, then lcl_patch is 0.
</descr>
<seealso>lcl_version</seealso>
</element>
<!-- constant Visibility: default -->
<element name="lcl_version">
<short>LCL version string</short>
<descr>Contains the LCL version string.
</descr>
<seealso>
</seealso>
</element>
</module> <!-- LCLVersion -->
</package>
</fpdoc-descriptions>