paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-06 11:18:10 +02:00
Code Issues Packages Projects Releases Wiki Activity

TAChart: Small improvements of help file for TAMath unit.

Browse Source
This commit is contained in:
wp_xyz 2021-10-27 00:14:10 +02:00
parent 82518bf64d
commit b58bc06733
1 changed files with 2 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
components/tachart/fpdoc/tamath.xml
View File

@ -2,13 +2,12 @@
<fpdoc-descriptions>
<package name="TAChartLazarusPkg">
<module name="TAMath"><element name="EnsureOrder"><short>If <var>A</var> is greater than <var>B</var> then both numbers are exchanged to make sure that <var>A</var> is never greater than <var>B</var>.</short>
</element><element name="ExpandRange"><short>Expands the interval between <var>ALo</var> and <var>AHi</var> by subtracting <var>ACoeff</var> from <var>ALo</var> and adding it to <var>AHi</var>
</element><element name="ExpandRange"><short>Expands the interval between <var>ALo</var> and <var>AHi</var> by subtracting the fraction <var>ACoeff</var> of the distance <var>AHi-ALo</var> from <var>ALo</var> and adding it to <var>AHi</var>
</short>
</element><element name="SafeEqual"><short>Checks whether <var>A</var> is equal to <var>B</var> in a way which does not crash when one of the arguments is <var>NaN</var> ("not a number").</short>
</element>
<element name="SafeMin"><short>Returns the minimum of the numbers <var>A</var> and <var>B</var>. Does not crash when one of the values is <var>NaN</var> (Not a Number).</short>
</element><element name="SafeInRange"><short>Returns <var>true</var> when <var>AValue</var> is within or at the bounds of the interval between <var>ABound1</var> and <var>ABound2</var>
</short>
</element><element name="SafeInRange"><short>Returns <var>true</var> when <var>AValue</var> is within or at the bounds of the interval between <var>ABound1</var> and <var>ABound2</var>. The result is correct even if the bounds are in reverse order.</short>
</element><element name="SafeInRangeWithBounds"><short>Returns <var>true</var> when <var>AValue</var> is within or at the bounds of the interval between <var>ABound1</var> and <var>ABound2</var>
</short><descr>Whether <var>AValue</var> is at the bounds of the interval is allowed within the specified tolerance <var>AEpsilon</var> where the default <var>AEpsilon=0</var> is interpreted as a <var>1E-12</var> fraction of the interval length.
</descr>