From 6d81fc13095b2d96b6cd864f952242749567bbab Mon Sep 17 00:00:00 2001
From: Nicolai Ort <info@nicolai-ort.com>
Date: Thu, 3 Dec 2020 17:46:32 +0100
Subject: [PATCH] Added Comments.

ref #11 #13
---
 src/controllers/TrackController.ts |  2 +-
 src/models/CreateTrack.ts          | 11 ++++++++++-
 2 files changed, 11 insertions(+), 2 deletions(-)

diff --git a/src/controllers/TrackController.ts b/src/controllers/TrackController.ts
index a448922..7b22cc2 100644
--- a/src/controllers/TrackController.ts
+++ b/src/controllers/TrackController.ts
@@ -42,7 +42,7 @@ export class TrackController {
 		@Body({ validate: true })
 		track: CreateTrack
 	) {
-		return this.trackRepository.save(track.getTrack());
+		return this.trackRepository.save(track.toTrack());
 	}
 
 	@Put('/:id')
diff --git a/src/models/CreateTrack.ts b/src/models/CreateTrack.ts
index 025d8a9..015a58f 100644
--- a/src/models/CreateTrack.ts
+++ b/src/models/CreateTrack.ts
@@ -2,15 +2,24 @@ import { IsInt, IsNotEmpty, IsPositive, IsString } from 'class-validator';
 import { Track } from './Track';
 
 export class CreateTrack {
+    /**
+     * The track's name.
+     */
     @IsString()
     @IsNotEmpty()
     name: string;
 
+    /**
+     * The track's distance in meters (must be greater 0).
+     */
     @IsInt()
     @IsPositive()
     distance: number;
 
-    public getTrack(): Track {
+    /**
+     * Converts a Track object based on this.
+     */
+    public toTrack(): Track {
         let newTrack: Track = new Track();
 
         newTrack.name = this.name;