Commit 2ae00a9
authored
File tree
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,10 +1,12 @@ | |||
| 1 | - /* | ||
| 2 | - Calculate the distance between two coordinates using the haversine formula | ||
| 3 | - More about: https://pt.wikipedia.org/wiki/F%C3%B3rmula_de_Haversine | ||
| 4 | - @Param {number} latitude1 | ||
| 5 | - @Param {number} latitude2 | ||
| 6 | - @Param {number} longitude1 | ||
| 7 | - @Param {number} longitude2 | ||
| 1 | + /** | ||
| 2 | + * @function HaversineDistance | ||
| 3 | + * @description Calculate the distance between two coordinates using the haversine formula | ||
| 4 | + * @param {Integer} latitude1 - The input integer | ||
| 5 | + * @param {Integer} latitude2 - The input integer | ||
| 6 | + * @param {Integer} longitude1 - The input integer | ||
| 7 | + * @param {Integer} longitude2 - The input integer | ||
| 8 | + * @return {Integer} Haversine Distance. | ||
| 9 | + * @see [Haversine_Distance](https://pt.wikipedia.org/wiki/F%C3%B3rmula_de_Haversine) | ||
| 8 | 10 | */ | |
| 9 | 11 | const haversineDistance = (latitude1 = 0, longitude1 = 0, latitude2 = 0, longitude2 = 0) => { | |
| 10 | 12 | validateLatOrLong(latitude1) | |
0 commit comments