Skip to content

Commit d71464e

Browse files
committed
Add documentation for methods in Utils
1 parent a63e955 commit d71464e

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

src/cls/Math/Utils.cls

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
Class Math.Utils
22
{
33

4+
/// This method will validate the input to confirm there are values to process</br>
5+
/// <var>pIntegers</var> accepts a variable number of parameters</br>
6+
/// If <var>pIntegers</var> has no data or subscript 1 has no data, it will return an error
47
ClassMethod ValidateInput(pIntegers... As %Integer) As %Status
58
{
69
Set tSC=$$$OK
@@ -12,6 +15,10 @@ ClassMethod ValidateInput(pIntegers... As %Integer) As %Status
1215
Quit tSC
1316
}
1417

18+
/// This method will check to see if pValue is within the range of pMin to pMax</br>
19+
/// <var>pValue</var> is the value that is being evaluated</br>
20+
/// <var>pMin</var> is the lowest value of the acceptable range</br>
21+
/// <var>pMax</var> is the highest value of the acceptable range
1522
ClassMethod ValidateRange(pValue As %Integer = "", pMin As %Integer = "", pMax As %Integer = "") As %Status
1623
{
1724
Set tSC=$$$OK

0 commit comments

Comments
 (0)