Browse Source

Add a jsdoc `return`.

Naotoshi Fujita 2 years ago
parent
commit
780aac41c2
1 changed files with 2 additions and 0 deletions
  1. 2 0
      src/js/utils/math/clamp/clamp.ts

+ 2 - 0
src/js/utils/math/clamp/clamp.ts

@@ -7,6 +7,8 @@ import { max, min } from '../math/math';
  * @param number - A subject number to check.
  * @param number - A subject number to check.
  * @param x      - A min or max number.
  * @param x      - A min or max number.
  * @param y      - A min or max number.
  * @param y      - A min or max number.
+ *
+ * @return A clamped number.
  */
  */
 export function clamp( number: number, x: number, y: number ): number {
 export function clamp( number: number, x: number, y: number ): number {
   const minimum = min( x, y );
   const minimum = min( x, y );