From d2278fd248658504cba856542328851f4fc6d96b Mon Sep 17 00:00:00 2001 From: Nicolai Ort Date: Fri, 27 Nov 2020 19:57:10 +0100 Subject: [PATCH] Added jsdoc style class documentation ref #3 --- src/models/Track.ts | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/models/Track.ts b/src/models/Track.ts index 9d977b2..b0a789b 100644 --- a/src/models/Track.ts +++ b/src/models/Track.ts @@ -7,6 +7,12 @@ import { IsString, } from "class-validator"; +/** + * @classdesc Defines a track of given length. + * @property {number} id - Autogenerated unique id + * @property {string} name - The track's name + * @property {number} lenth - The track's length in meters +*/ @Entity() export class Track { @PrimaryGeneratedColumn()