Add LeastCommonMultiple documentation

psteiwer · psteiwer · commit 451c3ac0b70d · 2020-01-07T14:38:18.000+01:00
diff --git a/src/cls/Math/Math.cls b/src/cls/Math/Math.cls
@@ -1,6 +1,8 @@
 Class Math.Math
 {
 
+/// Accepts a variable number of parameters and outputs the Least Common Multiple of them</br>
+/// Null input and 0 are not valid
 ClassMethod LeastCommonMultiple(pIntegers... As %Integer) As %Integer
 {
 	Set tSC=##class(Math.Utils).ValidateInput(pIntegers...)
@@ -37,6 +39,7 @@ ClassMethod LeastCommonMultiple(pIntegers... As %Integer) As %Integer
 	Quit tRes
 }
 
+/// See <method>LeastCommonMultiple</method>
 ClassMethod LCM(pFactors...) As %Integer [ CodeMode = expression ]
 {
 ##class(Math.Math).LeastCommonMultiple(pFactors...)

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,8 @@`
`1`	`1`	`Class Math.Math`
`2`	`2`	`{`
`3`	`3`
	`4`	`+/// Accepts a variable number of parameters and outputs the Least Common Multiple of them</br>`
	`5`	`+/// Null input and 0 are not valid`
`4`	`6`	`ClassMethod LeastCommonMultiple(pIntegers... As %Integer) As %Integer`
`5`	`7`	`{`
`6`	`8`	`Set tSC=##class(Math.Utils).ValidateInput(pIntegers...)`
`@@ -37,6 +39,7 @@ ClassMethod LeastCommonMultiple(pIntegers... As %Integer) As %Integer`
`37`	`39`	`Quit tRes`
`38`	`40`	`}`
`39`	`41`
	`42`	`+/// See <method>LeastCommonMultiple</method>`
`40`	`43`	`ClassMethod LCM(pFactors...) As %Integer [ CodeMode = expression ]`
`41`	`44`	`{`
`42`	`45`	`##class(Math.Math).LeastCommonMultiple(pFactors...)`