diff --git a/client/src/interfaces/ApiModels.ts b/client/src/interfaces/ApiModels.ts index d32cd65ae7079282b3352cbed7551feffc8b6053..c613477e015cb209a641c03b364bbb3b32264342 100644 --- a/client/src/interfaces/ApiModels.ts +++ b/client/src/interfaces/ApiModels.ts @@ -1,3 +1,9 @@ +/** + * This file contains interfaces used by the API when getting tables from the database. + * Some of these interfaces are lightweight versions used when getting all data is unneccesary. + * The full versions of these interfaces are found in ApiRichModels. + */ + export interface NameID { id: number name: string diff --git a/client/src/interfaces/ApiRichModels.ts b/client/src/interfaces/ApiRichModels.ts index 4251f2e644491b8c3e1a6f5fcad6fa13f42c95bb..853a6afbc991fb7b7ee2e3178e328c8f452f43a8 100644 --- a/client/src/interfaces/ApiRichModels.ts +++ b/client/src/interfaces/ApiRichModels.ts @@ -1,3 +1,9 @@ +/** + * This file contains interfaces used by the API when getting full tables from the database. + * These interfaces also have more lightweight versions used when getting all data is unneccesary, + * found in ApiModels. + */ + import { Component, Media, QuestionAlternative, QuestionAlternativeAnswer, QuestionScore } from './ApiModels' export interface RichCompetition { diff --git a/client/src/interfaces/Components.ts b/client/src/interfaces/Components.ts index 864b987d40772e25640cad0029914f130081cf6b..d0f4842f92611a8801b96a7fa8301de6b8aba0b4 100644 --- a/client/src/interfaces/Components.ts +++ b/client/src/interfaces/Components.ts @@ -1,3 +1,6 @@ +/** + * This file contains interfaces used by components. + */ export interface Position { x: number y: number diff --git a/client/src/interfaces/FilterParams.ts b/client/src/interfaces/FilterParams.ts index eca6551f4705aa3e4dfe6c96878fc9d3039fd983..06cc1569fc5bbe35ed4b7bb34b788872cc3e414f 100644 --- a/client/src/interfaces/FilterParams.ts +++ b/client/src/interfaces/FilterParams.ts @@ -1,3 +1,6 @@ +/** + * This file contains interfaces used when filtering. + */ export interface CompetitionFilterParams { name?: string year?: number diff --git a/client/src/interfaces/FormModels.ts b/client/src/interfaces/FormModels.ts index dd51f32b18fb75ba5c7c3c535e7f8d2328f9bb2d..002f45e1da965f80dc2b9e5386da2bc77ea4520f 100644 --- a/client/src/interfaces/FormModels.ts +++ b/client/src/interfaces/FormModels.ts @@ -1,3 +1,6 @@ +/** + * This file contains interfaces used by form models. + */ export interface ServerResponse { code: number message: string diff --git a/client/src/interfaces/Timer.ts b/client/src/interfaces/Timer.ts index 03704c834d1b51075916d4bd4be3dcc99f9b0e53..f8d2e2985ca2146aaa2eb596acf270adaf1ba2db 100644 --- a/client/src/interfaces/Timer.ts +++ b/client/src/interfaces/Timer.ts @@ -1,3 +1,6 @@ +/** + * This file contains interfaces used by the timer. + */ export interface TimerState { value: number | null enabled: boolean diff --git a/client/src/interfaces/ViewParams.ts b/client/src/interfaces/ViewParams.ts index b8114216500b3295050a0b62f6188fa065fcbfdb..b41671ab589d8cd0947ab9f217341491c8a2197f 100644 --- a/client/src/interfaces/ViewParams.ts +++ b/client/src/interfaces/ViewParams.ts @@ -1,3 +1,6 @@ +/** + * This file contains interfaces used by ViewParams. + */ export interface ViewParams { competitionId: string }