From 868c299c62d7867a22d46aae54d4a0b09f33c6a7 Mon Sep 17 00:00:00 2001 From: samme Date: Sat, 17 Dec 2022 06:59:53 -0800 Subject: [PATCH] Docs: correct GetShortestDistance() Fixes #6322 --- src/geom/line/GetShortestDistance.js | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/src/geom/line/GetShortestDistance.js b/src/geom/line/GetShortestDistance.js index cff8cf83d..d206bfe5a 100644 --- a/src/geom/line/GetShortestDistance.js +++ b/src/geom/line/GetShortestDistance.js @@ -11,12 +11,10 @@ * @function Phaser.Geom.Line.GetShortestDistance * @since 3.16.0 * - * @generic {Phaser.Geom.Point} O - [out,$return] - * * @param {Phaser.Geom.Line} line - The line to get the distance from. - * @param {(Phaser.Geom.Point|object)} point - The point to get the shortest distance to. + * @param {Phaser.Types.Math.Vector2Like} point - The point to get the shortest distance to. * - * @return {number} The shortest distance from the line to the point. + * @return {(boolean|number)} The shortest distance from the line to the point, or `false`. */ var GetShortestDistance = function (line, point) {