fix jsdoc returns tag

vicb · Jun 3, 2024 · ba76ae2 · ba76ae2
1 parent 80f5938
commit ba76ae2
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/libs/optimizer/src/lib/optimizer.ts b/libs/optimizer/src/lib/optimizer.ts
@@ -82,7 +82,7 @@ export interface ScoringResult {
  *
  * @param request Contains the tracks and options.
  * @param ruleName The ScoringRules to use.
- * @return an Iterator of OptimizationResult
+ * @returns an Iterator of OptimizationResult
  */
 export function* getOptimizer(
   request: ScoringRequest,

diff --git a/libs/optimizer/src/lib/utils/create-segments.ts b/libs/optimizer/src/lib/utils/create-segments.ts
@@ -5,7 +5,7 @@ import { LatLonAltTime, ScoringTrack } from '../optimizer';
  *
  * Points are computed by a linear interpolation
  *
- * @return a ScoringTrack of nbSegments
+ * @returns a ScoringTrack of nbSegments
  */
 export function createSegments(startPoint: LatLonAltTime, endPoint: LatLonAltTime, nbSegments: number): ScoringTrack {
   const points: LatLonAltTime[] = [];

diff --git a/libs/optimizer/src/lib/utils/merge-tracks.ts b/libs/optimizer/src/lib/utils/merge-tracks.ts
@@ -6,7 +6,7 @@ import { LatLonAltTime, ScoringTrack } from '../optimizer';
  * Collapse end and start point of consecutive tracks when they match.
  *
  * @param tracks the tracks to concatenate
- * @return a track
+ * @returns a track
  */
 export function mergeTracks(...tracks: ScoringTrack[]): ScoringTrack {
   const points: LatLonAltTime[] = [];