From 8aedb39e9eaad182ec5c2111bb5336fbd80e335f Mon Sep 17 00:00:00 2001 From: Mauricio Poppe Date: Sat, 4 Apr 2020 21:30:47 -0700 Subject: [PATCH] more formatting in constants --- src/constants.ts | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/src/constants.ts b/src/constants.ts index 0c1f1d5..02352a5 100644 --- a/src/constants.ts +++ b/src/constants.ts @@ -42,12 +42,14 @@ const constants = { }, /** - * An interval that represents PI / 2, NOTE: calls to Interval.PI_HALF always - * return a new interval representing PI / 2 + * An interval that represents `PI / 2`, NOTE: calls to `Interval.PI_HALF` always + * return a new interval representing `PI / 2` * @memberof constants * @static * @example + * ```typescript * Interval(Interval.PI_LOW / 2, Interval.PI_HIGH / 2) + * ``` * @name PI_HALF * @type {Interval} */ @@ -56,12 +58,14 @@ const constants = { }, /** - * An interval that represents PI * 2, NOTE: calls to Interval.PI_TWICE always - * return a new interval representing PI * 2 + * An interval that represents `PI * 2` NOTE: calls to `Interval.PI_TWICE` always + * return a new interval representing `PI * 2` * @memberof constants * @static * @example + * ```typescript * Interval(Interval.PI_LOW * 2, Interval.PI_HIGH * 2) + * ``` * @name PI_TWICE * @type {Interval} */ @@ -70,13 +74,14 @@ const constants = { }, /** - * An interval that represents 0, NOTE: calls to Interval.ZERO always - * return a new interval representing 0 + * An interval that represents 0, NOTE: calls to `Interval.ZERO` always return a new interval representing 0 * @memberof constants * @static * @example + * ```typescript * // Interval.ZERO is equivalent to * Interval(0) + * ``` * @name ZERO * @type {Interval} */ @@ -101,13 +106,14 @@ const constants = { /** * An interval that represents all the real values - * NOTE: calls to Interval.WHOLE always return a new interval representing all - * the real values + * NOTE: calls to Interval.WHOLE always return a new interval representing all the real values * @memberof constants * @static * @example + * ```typescript * // Interval.WHOLE is equivalent to * Interval().setWhole() + * ``` * @name WHOLE * @type {Interval} */ @@ -117,13 +123,14 @@ const constants = { /** * An interval that represents no values - * NOTE: calls to Interval.EMPTY always return a new interval representing no - * values + * NOTE: calls to Interval.EMPTY always return a new interval representing no values * @memberof constants * @static * @example + * ```typescript * // Interval.EMPTY is equivalent to * Interval().setEmpty() + * ``` * @name EMPTY * @type {Interval} */