Fix helper docs generation (#1857)

ember-math-helpers/src/helpers/abs.ts

@@ -14,8 +14,9 @@ export interface AbsSignature {
  * {{abs a}}
  * ```
  *
- * @param number The number to take the absolute value of
- * @return The absolute value of the passed number
+ * @function abs
+ * @param {number} number The number to take the absolute value of
+ * @return {number} The absolute value of the passed number
  */
 export function abs([number]: [number]) {
   return Math.abs(number);

ember-math-helpers/src/helpers/acos.ts

@@ -14,8 +14,9 @@ export interface AcosSignature {
  * {{acos a}}
  * ```
  *
- * @param number The number to pass to `Math.acos`
- * @return The acos of the passed number
+ * @function acos
+ * @param {number} number The number to pass to `Math.acos`
+ * @return {number} The acos of the passed number
  */
 export function acos([number]: [number]) {
   return Math.acos(number);

ember-math-helpers/src/helpers/acosh.ts

@@ -14,8 +14,9 @@ export interface AcoshSignature {
  * {{acosh a}}
  * ```
  *
- * @param number The number to pass to `Math.acosh`
- * @return The acosh of the passed number
+ * @function acosh
+ * @param {number} number The number to pass to `Math.acosh`
+ * @return {number} The acosh of the passed number
  */
 export function acosh([number]: [number]) {
   return Math.acosh(number);

ember-math-helpers/src/helpers/add.ts

@@ -14,8 +14,9 @@ export interface AddSignature {
  * {{add a b}}
  * ```
  *
- * @param numbers A list of numbers to sum
- * @return The sum of all the passed numbers
+ * @function add
+ * @param {number[]} numbers A list of numbers to sum
+ * @return {number} The sum of all the passed numbers
  */
 export function add(numbers: Array<number>) {
   return numbers.reduce((a, b) => Number(a) + Number(b));

ember-math-helpers/src/helpers/asin.ts

@@ -14,8 +14,9 @@ export interface AsinSignature {
  * {{asin a}}
  * ```
  *
- * @param number The number to pass to `Math.asin`
- * @return The asin of the passed number
+ * @function asin
+ * @param {number} number The number to pass to `Math.asin`
+ * @return {number} The asin of the passed number
  */
 export function asin([number]: [number]) {
   return Math.asin(number);

ember-math-helpers/src/helpers/asinh.ts

@@ -14,8 +14,9 @@ export interface AsinhSignature {
  * {{asinh a}}
  * ```
  *
- * @param number The number to pass to `Math.asinh`
- * @return The asinh of the passed number
+ * @function asinh
+ * @param {number} number The number to pass to `Math.asinh`
+ * @return {number} The asinh of the passed number
  */
 export function asinh([number]: [number]) {
   return Math.asinh(number);

ember-math-helpers/src/helpers/atan.ts

@@ -13,9 +13,9 @@ export interface AtanSignature {
  * ```hbs
  * {{atan a}}
  * ```
- *
- * @param number The number to pass to `Math.atan`
- * @return The atan of the passed number
+ * @function atan
+ * @param {number} number The number to pass to `Math.atan`
+ * @return {number} The atan of the passed number
  */
 export function atan([number]: [number]) {
   return Math.atan(number);

ember-math-helpers/src/helpers/atan2.ts

@@ -14,9 +14,10 @@ export interface Atan2Signature {
  * {{atan2 a b}}
  * ```
  *
- * @param number1 The first number to pass to `Math.atan2`
- * @param number2 The second number to pass to `Math.atan2`
- * @return The atan2 of the passed numbers
+ * @function atan2
+ * @param {number} number1 The first number to pass to `Math.atan2`
+ * @param {number} number2 The second number to pass to `Math.atan2`
+ * @return {number} The atan2 of the passed numbers
  */
 export function atan2([number1, number2]: [number, number]) {
   return Math.atan2(number1, number2);

ember-math-helpers/src/helpers/atanh.ts

@@ -14,8 +14,9 @@ export interface AtanhSignature {
  * {{atanh a}}
  * ```
  *
- * @param number The number to pass to `Math.atanh`
- * @return The atanh of the passed number
+ * @function atanh
+ * @param {number} number The number to pass to `Math.atanh`
+ * @return {number} The atanh of the passed number
  */
 export function atanh([number]: [number]) {
   return Math.atanh(number);

ember-math-helpers/src/helpers/cbrt.ts

@@ -14,8 +14,9 @@ export interface CbrtSignature {
  * {{cbrt a}}
  * ```
  *
- * @param number The number to pass to `Math.cbrt`
- * @return The cbrt of the passed number
+ * @function cbrt
+ * @param {number} number The number to pass to `Math.cbrt`
+ * @return {number} The cbrt of the passed number
  */
 export function cbrt([number]: [number]) {
   return Math.cbrt(number);

ember-math-helpers/src/helpers/ceil.ts

@@ -14,8 +14,9 @@ export interface CeilSignature {
  * {{ceil a}}
  * ```
  *
- * @param number The number to pass to `Math.ceil`
- * @return The ceil of the passed number
+ * @function ceil
+ * @param {number} number The number to pass to `Math.ceil`
+ * @return {number} The ceil of the passed number
  */
 export function ceil([number]: [number]) {
   return Math.ceil(number);

ember-math-helpers/src/helpers/clz32.ts

@@ -14,8 +14,9 @@ export interface Clz32Signature {
  * {{clz32 a}}
  * ```
  *
- * @param number The number to pass to `Math.clz32`
- * @return The clz32 of the passed number
+ * @function clz32
+ * @param {number} number The number to pass to `Math.clz32`
+ * @return {number} The clz32 of the passed number
  */
 export function clz32([number]: [number]) {
   return Math.clz32(number);

ember-math-helpers/src/helpers/cos.ts

@@ -14,8 +14,9 @@ export interface CosSignature {
  * {{cos a}}
  * ```
  *
- * @param number The number to pass to `Math.cos`
- * @return The cos of the passed number
+ * @function cos
+ * @param {number} number The number to pass to `Math.cos`
+ * @return {number} The cos of the passed number
  */
 export function cos([number]: [number]) {
   return Math.cos(number);

ember-math-helpers/src/helpers/cosh.ts

@@ -14,8 +14,9 @@ export interface CoshSignature {
  * {{cosh a}}
  * ```
  *
- * @param number The number to pass to `Math.cosh`
- * @return The cosh of the passed number
+ * @function cosh
+ * @param {number} number The number to pass to `Math.cosh`
+ * @return {number} The cosh of the passed number
  */
 export function cosh([number]: [number]) {
   return Math.cosh(number);

ember-math-helpers/src/helpers/div.ts

@@ -14,8 +14,9 @@ export interface DivSignature {
  * {{div a b}}
  * ```
  *
- * @param numbers A list of numbers to divide
- * @return The result of dividing all the passed numbers
+ * @function div
+ * @param {number[]} numbers A list of numbers to divide
+ * @return {number} The result of dividing all the passed numbers
  */
 export function div(numbers: Array<number>) {
   return numbers.reduce((a, b) => Number(a) / Number(b));

ember-math-helpers/src/helpers/exp.ts

@@ -14,8 +14,9 @@ export interface ExpSignature {
  * {{exp a}}
  * ```
  *
- * @param number The number to pass to `Math.exp`
- * @return The exp of the passed number
+ * @function exp
+ * @param {number} number The number to pass to `Math.exp`
+ * @return {number} The exp of the passed number
  */
 export function exp([number]: [number]) {
   return Math.exp(number);

ember-math-helpers/src/helpers/expm1.ts

@@ -14,8 +14,9 @@ export interface Expm1Signature {
  * {{expm1 a}}
  * ```
  *
- * @param number The number to pass to `Math.expm1`
- * @return The expm1 of the passed number
+ * @function expm1
+ * @param {number} number The number to pass to `Math.expm1`
+ * @return {number} The expm1 of the passed number
  */
 export function expm1([number]: [number]) {
   return Math.expm1(number);

ember-math-helpers/src/helpers/floor.ts

@@ -14,6 +14,7 @@ export interface FloorSignature {
  * {{floor a}}
  * ```
  *
+ * @function floor
  * @param {number} number The number to pass to `Math.floor`
  * @return {number} The floor of the passed number
  */

ember-math-helpers/src/helpers/fround.ts

@@ -14,8 +14,9 @@ export interface FroundSignature {
  * {{fround a}}
  * ```
  *
- * @param number The number to pass to `Math.fround`
- * @return The fround of the passed number
+ * @function fround
+ * @param {number} number The number to pass to `Math.fround`
+ * @return {number} The fround of the passed number
  */
 export function fround([number]: [number]) {
   return Math.fround(number);

ember-math-helpers/src/helpers/gcd.ts

@@ -14,9 +14,10 @@ export interface GcdSignature {
  * {{gcd a b}}
  * ```
  *
- * @param number1 The first number
- * @param number2 The second number
- * @return The GCD of the two numbers passed
+ * @function gcd
+ * @param {number} number1 The first number
+ * @param {number} number2 The second number
+ * @return {number} The GCD of the two numbers passed
  */
 export function gcd([number1 = 0, number2 = 0]) {
   const a = Math.abs(number1);

ember-math-helpers/src/helpers/hypot.ts

@@ -14,8 +14,9 @@ export interface HypotSignature {
  * {{max a b}}
  * ```
  *
- * @param numbers A list of numbers to pass to `Math.hypot`
- * @return The hypot of the set of numbers
+ * @function hypot
+ * @param {number[]} numbers A list of numbers to pass to `Math.hypot`
+ * @return {number} The hypot of the set of numbers
  */
 export function hypot(numbers: Array<number>) {
   return Math.hypot(...numbers);

ember-math-helpers/src/helpers/imul.ts

@@ -14,9 +14,10 @@ export interface ImulSignature {
  * {{imul a}}
  * ```
  *
- * @param number1 The first number to pass to `Math.imul`
- * @param number2 The second number to pass to `Math.imul`
- * @return The imul of the passed numbers
+ * @function imul
+ * @param {number} number1 The first number to pass to `Math.imul`
+ * @param {number} number2 The second number to pass to `Math.imul`
+ * @return {number} The imul of the passed numbers
  */
 export function imul([number1, number2]: [number, number]) {
   return Math.imul(number1, number2);

ember-math-helpers/src/helpers/lcm.ts

@@ -16,9 +16,10 @@ export interface LcmSignature {
  * {{lcm a b}}
  * ```
  *
- * @param number1 The first number
- * @param number2 The second number
- * @return The LCM of the two numbers passed
+ * @function lcm
+ * @param {number} number1 The first number
+ * @param {number} number2 The second number
+ * @return {number} The LCM of the two numbers passed
  */
 export function lcm([number1 = 0, number2 = 0]) {
   return number1 === 0 || number2 === 0

ember-math-helpers/src/helpers/log-e.ts

@@ -14,8 +14,9 @@ export interface LogESignature {
  * {{log-e a}}
  * ```
  *
- * @param number The number to pass to `Math.log`
- * @return The log of the passed number
+ * @function log-e
+ * @param {number} number The number to pass to `Math.log`
+ * @return {number} The log of the passed number
  */
 export function logE([number]: [number]) {
   return Math.log(number);

ember-math-helpers/src/helpers/log10.ts

@@ -14,8 +14,9 @@ export interface Log10Signature {
  * {{log10 a}}
  * ```
  *
- * @param number The number to pass to `Math.log10`
- * @return The log10 of the passed number
+ * @function log10
+ * @param {number} number The number to pass to `Math.log10`
+ * @return {number} The log10 of the passed number
  */
 export function log10([number]: [number]) {
   return Math.log10(number);

ember-math-helpers/src/helpers/log1p.ts

@@ -14,8 +14,9 @@ export interface Log1pSignature {
  * {{log1p a}}
  * ```
  *
- * @param number The number to pass to `Math.log1p`
- * @return The log1p of the passed number
+ * @function log1p
+ * @param {number} number The number to pass to `Math.log1p`
+ * @return {number} The log1p of the passed number
  */
 export function log1p([number]: [number]) {
   return Math.log1p(number);

ember-math-helpers/src/helpers/log2.ts

@@ -14,8 +14,9 @@ export interface Log2Signature {
  * {{log2 a}}
  * ```
  *
- * @param number The number to pass to `Math.log2`
- * @return The log2 of the passed number
+ * @function log2
+ * @param {number} number The number to pass to `Math.log2`
+ * @return {number} The log2 of the passed number
  */
 export function log2([number]: [number]) {
   return Math.log2(number);

ember-math-helpers/src/helpers/max.ts

@@ -14,8 +14,9 @@ export interface MaxSignature {
  * {{max a b}}
  * ```
  *
- * @param numbers A list of numbers to pass to `Math.max`
- * @return The max of the set of numbers
+ * @function max
+ * @param {number[]} numbers A list of numbers to pass to `Math.max`
+ * @return {number} The max of the set of numbers
  */
 export function max(numbers: Array<number>) {
   return Math.max(...numbers);

ember-math-helpers/src/helpers/min.ts

@@ -14,8 +14,9 @@ export interface MinSignature {
  * {{min a b}}
  * ```
  *
- * @param numbers A list of numbers to pass to `Math.min`
- * @return The min of the set of numbers
+ * @function min
+ * @param {number[]} numbers A list of numbers to pass to `Math.min`
+ * @return {number} The min of the set of numbers
  */
 export function min(numbers: Array<number>) {
   return Math.min(...numbers);

ember-math-helpers/src/helpers/mod.ts

@@ -14,8 +14,9 @@ export interface ModSignature {
  * {{mod a b}}
  * ```
  *
- * @param numbers A list of numbers to modulus
- * @return The modulus of all the passed numbers
+ * @function mod
+ * @param {number[]} numbers A list of numbers to modulus
+ * @return {number} The modulus of all the passed numbers
  */
 export function mod(numbers: Array<number>) {
   return numbers.reduce((a, b) => Number(a) % Number(b));

ember-math-helpers/src/helpers/mult.ts

@@ -14,8 +14,9 @@ export interface MultSignature {
  * {{mult a b}}
  * ```
  *
- * @param numbers A list of numbers to multiply
- * @return The product of all the passed numbers
+ * @function mult
+ * @param {number[]} numbers A list of numbers to multiply
+ * @return {number} The product of all the passed numbers
  */
 export function mult(numbers: Array<number>) {
   return numbers.reduce((a, b) => Number(a) * Number(b));

ember-math-helpers/src/helpers/pow.ts

@@ -15,8 +15,9 @@ export interface PowSignature {
  * {{pow a b}}
  * ```
  *
- * @param numbers A list of numbers to pass to `Math.pow`
- * @return The base raised to all exponents
+ * @function pow
+ * @param {number[]} numbers A list of numbers to pass to `Math.pow`
+ * @return {number} The base raised to all exponents
  */
 export function pow(numbers: Array<number>) {
   return numbers.reduce((base, exponent) => Math.pow(base, exponent));