Add GreatestCommonDivisor documenation

psteiwer · psteiwer · commit 4971e94c8853 · 2020-01-07T14:41:30.000+01:00
diff --git a/src/cls/Math/Math.cls b/src/cls/Math/Math.cls
@@ -77,6 +77,8 @@ ClassMethod Min(pIntegers...) As %Integer
 	Quit tMin
 }
 
+/// Accepts a variable number of parameters and outputs the Greatest Common Divisor of them</br>
+/// Null input and 0 are not valid
 ClassMethod GreatestCommonDivisor(pIntegers...) As %Integer
 {
 	Set tRes=""
@@ -105,6 +107,7 @@ ClassMethod GreatestCommonDivisor(pIntegers...) As %Integer
 	Quit tRes
 }
 
+/// See <method>GreatestCommonDivisor</method>
 ClassMethod GCD(pFactors...) As %Integer [ CodeMode = expression ]
 {
 ##class(Math.Math).GreatestCommonDivisor(pFactors...)

Original file line number	Diff line number	Diff line change
`@@ -77,6 +77,8 @@ ClassMethod Min(pIntegers...) As %Integer`
`77`	`77`	`Quit tMin`
`78`	`78`	`}`
`79`	`79`
	`80`	`+/// Accepts a variable number of parameters and outputs the Greatest Common Divisor of them</br>`
	`81`	`+/// Null input and 0 are not valid`
`80`	`82`	`ClassMethod GreatestCommonDivisor(pIntegers...) As %Integer`
`81`	`83`	`{`
`82`	`84`	`Set tRes=""`
`@@ -105,6 +107,7 @@ ClassMethod GreatestCommonDivisor(pIntegers...) As %Integer`
`105`	`107`	`Quit tRes`
`106`	`108`	`}`
`107`	`109`
	`110`	`+/// See <method>GreatestCommonDivisor</method>`
`108`	`111`	`ClassMethod GCD(pFactors...) As %Integer [ CodeMode = expression ]`
`109`	`112`	`{`
`110`	`113`	`##class(Math.Math).GreatestCommonDivisor(pFactors...)`