Comments conformed

src/app.module.ts

@@ -21,22 +21,22 @@ import { GameModule } from './game/game.module';
 import { ScoreModule } from './score/score.module';
 import { ReplayModule } from './replay/replay.module';
 
-/*
-  Core of the server,
-  Every module is being imported and combined here.
-
-  AppController needs to be kept in for SSL verification to work (root needs to return something)
-
-  TypeOrmModule checks ormconfig.json for database connection.
-
-  More information on global decorators can be found from shared folder.
-
-  Providers can be found from shared folder
-   - HttpErrorFilter
-   - LoggingInterceptor
-   - RolesGuard Decorator
-   - StatesGuard Decorator
-*/
+///////////////////////////////////////////////////////////////////////////////////////////////////////////
+///   Core of the server,                                                                               ///
+///   Every module is being imported and combined here.                                                 ///
+///                                                                                                     ///
+///   AppController needs to be kept in for SSL verification to work (root needs to return something)   ///
+///                                                                                                     ///
+///  TypeOrmModule checks ormconfig.json for database connection.                                       ///
+///                                                                                                     ///
+///   More information on global decorators can be found from shared folder.                            ///
+///                                                                                                     ///
+///   Providers can be found from shared folder                                                         ///
+///    - HttpErrorFilter                                                                                ///
+///    - LoggingInterceptor                                                                             ///
+///    - RolesGuard Decorator                                                                           ///
+///    - StatesGuard Decorator                                                                          ///
+///////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 @Module({
   imports: [

src/draw/coordinate.entity.ts

@@ -3,11 +3,11 @@ import { Entity, Column, PrimaryGeneratedColumn, ManyToOne } from 'typeorm';
 import { GameEntity } from '../game/game.entity';
 import { FactionEntity } from '../faction/faction.entity';
 
-/*
-MapDrawingEntity & MapDrawingHistoryEntity reflect database tables.
-
-MapDrawing ownershipCheck checks users rights to MapDrawing
-*/
+///////////////////////////////////////////////////////////////////////////
+/// MapDrawingEntity & MapDrawingHistoryEntity reflect database tables. ///
+///                                                                     ///
+/// MapDrawing ownershipCheck checks users rights to MapDrawing         ///
+///////////////////////////////////////////////////////////////////////////
 
 @Entity('MapDrawing')
 export class MapDrawingEntity {

src/draw/draw.controller.ts

@@ -15,8 +15,6 @@ import { Roles, GameStates } from '../shared/guard.decorator';
 import { MapDrawingDTO } from './mapdrawing.dto';
 import { GamePerson } from '../game/gameperson.decorator';
 
-/*
-
 //////////////////////////////////////////////////////////////////////////
 ///     DrawController                                                 ///
 ///                                                                    ///
@@ -27,8 +25,6 @@ import { GamePerson } from '../game/gameperson.decorator';
 ///     Data return functions require atleast spectator role.          ///
 //////////////////////////////////////////////////////////////////////////
 
-*/
-
 @Controller('draw')
 export class DrawController {
   constructor(private drawService: DrawService) {}

src/draw/draw.module.ts

@@ -10,12 +10,12 @@ import {
 import { FactionEntity } from '../faction/faction.entity';
 import { Game_PersonEntity } from '../game/game.entity';
 import { NotificationModule } from 'src/notifications/notifications.module';
-/*
+
 /////////////////////////////////////////////////////////////////////
 /// Draw                                                          ///
 /// - contains everything to do with mapdrawing data.             ///
 /////////////////////////////////////////////////////////////////////
-*/
+
 @Module({
   imports: [
     TypeOrmModule.forFeature([

src/draw/draw.service.ts

@@ -9,9 +9,9 @@ import {
 import { MapDrawingDTO } from './mapdrawing.dto';
 import { NotificationGateway } from '../notifications/notifications.gateway';
 
-/*
-DrawService contains handling of MapDrawings and MapDrawinghistory
-*/
+///////////////////////////////////////////////////////////////////////////
+/// DrawService contains handling of MapDrawings and MapDrawinghistory  ///
+///////////////////////////////////////////////////////////////////////////
 
 @Injectable()
 export class DrawService {

src/faction/faction.controller.ts

@@ -24,22 +24,22 @@ import { FactionService } from './faction.service';
 import { Roles, GameStates } from '../shared/guard.decorator';
 import { GamePerson } from '../game/gameperson.decorator';
 
-/*
-FactionController is being used for routing:
-
-Group
-- create group when game status is CREATED
-- getting groups with faction id(this is used mainly for listing players)
-- joining group when game status is CREATED
-
-Faction
-- checking users faction
-- joining faction
-- leaving faction
-- changing faction multiplier (not implemented)
-
-See shared folder files for more information on decorators.
-*/
+/////////////////////////////////////////////////////////////////////////////////
+/// FactionController is being used for routing:                              ///
+///                                                                           ///
+/// Group                                                                     ///
+/// - create group when game status is CREATED                                ///
+/// - getting groups with faction id(this is used mainly for listing players) ///
+/// - joining group when game status is CREATED                               ///
+///                                                                           ///
+/// Faction                                                                   ///
+/// - checking users faction                                                  ///
+/// - joining faction                                                         ///
+/// - leaving faction                                                         ///
+/// - changing faction multiplier (not implemented)                           ///
+///                                                                           ///
+/// See shared folder files for more information on decorators.               ///
+/////////////////////////////////////////////////////////////////////////////////
 
 @Controller('faction')
 export class FactionController {

src/faction/faction.dto.ts

@@ -16,12 +16,12 @@ import { GameEntity } from '../game/game.entity';
 import { GameDTO } from '../game/game.dto';
 import { FactionEntity, GameGroupEntity } from './faction.entity';
 
-/*
-Contains Validation for FactionDTO, JoinFactionDTO, PromotePlayerDTO, GameGroupDTO, JoinGameGroupDTO
-
-uses class-validator built in validations
-see https://github.com/typestack/class-validator
-*/
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////
+/// Contains Validation for FactionDTO, JoinFactionDTO, PromotePlayerDTO, GameGroupDTO, JoinGameGroupDTO  ///
+///                                                                                                       ///
+/// uses class-validator built in validations                                                             ///
+/// see https://github.com/typestack/class-validator                                                      ///
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 export class FactionDTO {
   @IsOptional()

src/faction/faction.entity.ts

@@ -14,9 +14,9 @@ import { MapDrawingEntity } from '../draw/coordinate.entity';
 import { Exclude } from 'class-transformer';
 import { ScoreEntity } from '../score/score.entity';
 
-/*
-FactionEntity & GameGroupEntity reflect database tables.
-*/
+///////////////////////////////////////////////////////////////////
+///   FactionEntity & GameGroupEntity reflect database tables.  ///
+///////////////////////////////////////////////////////////////////
 
 @Entity('Faction')
 export class FactionEntity {

src/faction/faction.module.ts

@@ -6,18 +6,18 @@ import { FactionService } from './faction.service';
 import { GameGroupEntity, FactionEntity } from './faction.entity';
 import { Game_PersonEntity } from '../game/game.entity';
 
-/*
-Entities
-- FactionEntity
-- Game_PersonEntity
-- GameGroupEntity
-
-Controllers
-- FactionController
-
-Provider
-- FactionService
-*/
+/////////////////////////////
+/// Entities              ///
+/// - FactionEntity       ///
+/// - Game_PersonEntity   ///
+/// - GameGroupEntity     ///
+///                       ///
+/// Controllers           ///
+/// - FactionController   ///
+///                       ///
+/// Provider              ///
+/// - FactionService      ///
+/////////////////////////////
 
 @Module({
   imports: [

src/faction/faction.service.ts

@@ -11,20 +11,20 @@ import {
 } from './faction.dto';
 import { Game_PersonEntity } from '../game/game.entity';
 
-/*
-FactionService contains functions for
-- Joining faction
-- Leaving faction
-- Change faction multiplier (not implemented)
-
-Group
-- Creating group
-- List faction players in groups
-
-Player
-- Promote player
-- verifying user
-*/
+///////////////////////////////////////////////////////
+/// FactionService contains functions for           ///
+/// - Joining faction                               ///
+/// - Leaving faction                               ///
+/// - Change faction multiplier (not implemented)   ///
+///                                                 ///
+/// Group                                           ///
+/// - Creating group                                ///
+/// - List faction players in groups                ///
+///                                                 ///
+/// Player                                          ///
+/// - Promote player                                ///
+/// - verifying user                                ///
+///////////////////////////////////////////////////////
 
 @Injectable()
 export class FactionService {

src/game/game.module.ts

@@ -22,6 +22,7 @@ import { MulterModule } from '@nestjs/platform-express';
 /// Game                                                          ///
 /// - contains everything to do with Game data                    ///
 /////////////////////////////////////////////////////////////////////
+
 @Module({
   imports: [
     TypeOrmModule.forFeature([

src/game/gameperson.decorator.ts

 import { createParamDecorator } from '@nestjs/common';
 
-/* 
-    gives service access to the gameperson object
-    Game_PersonEntity {
-        gamepersonId
-        role
-        faction
-    }
+///////////////////////////////////////////////////////////////////////////
+///    gives service access to the gameperson object                    ///
+///    Game_PersonEntity {                                              ///
+///        gamepersonId                                                 ///
+///        role                                                         ///
+///        faction                                                      ///
+///    }                                                                ///
+///                                                                     ///
+///    See more information from decorators in shared folder files.     ///
+///////////////////////////////////////////////////////////////////////////
 
-    See more information from decorators in shared folder files. 
-*/
 export const GamePerson = createParamDecorator((data, req) => {
   return data ? req.gameperson[data] : req.gameperson;
 });

src/main.ts

@@ -2,11 +2,11 @@ import { NestFactory } from '@nestjs/core';
 
 import { AppModule } from './app.module';
 
-/*
-  Main.ts starts the server.
-
-  .env.PORT is not defined, port 5000 will be listened by default
-*/
+///////////////////////////////////////////////////////////////////////////
+///   Main.ts starts the server.                                        ///
+///                                                                     ///
+///   .env.PORT is not defined, port 5000 will be listened by default   ///
+///////////////////////////////////////////////////////////////////////////
 
 async function bootstrap() {
   // port opened

src/notifications/notifications.gateway.ts

@@ -16,9 +16,9 @@ import { GameEntity } from '../game/game.entity';
 import { NotificationdDTO } from './notification.dto';
 import { ValidationPipe } from '../shared/validation.pipe';
 
-/*
-NotificationGateway contains websocket server and listener for game-info
-*/
+///////////////////////////////////////////////////////////////////////////////////
+/// NotificationGateway contains websocket server and listener for game-info    ///
+///////////////////////////////////////////////////////////////////////////////////
 
 @WebSocketGateway()
 export class NotificationGateway

src/notifications/notifications.module.ts

@@ -7,15 +7,11 @@ import { GameEntity } from '../game/game.entity';
 import { NotificationsController } from './notifications.controller';
 import { NotificationsService } from './notifications.service';
 
-/*
-
 /////////////////////////////////////////////////////////////////////
 /// Notification                                                  ///
 /// - contains everything to do with Notification data.           ///
 /////////////////////////////////////////////////////////////////////
 
-*/
-
 @Module({
   imports: [TypeOrmModule.forFeature([NotificationEntity, GameEntity])],
   providers: [NotificationGateway, NotificationsService],

src/replay/replay.controller.ts

@@ -9,9 +9,9 @@ import {
 import { ReplayService } from './replay.service';
 import { Roles } from 'src/shared/guard.decorator';
 
-/*
-POST mockdata is mainly used for development, it can be removed from the code when needed, remember to remove service & test relations.
-*/
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+/// POST mockdata is mainly used for development, it can be removed from the code when needed, remember to remove service & test relations.   ///
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
 @Controller('replay')
 export class ReplayController {

src/replay/replay.module.ts

@@ -29,6 +29,7 @@ import { TickService } from 'src/game/tick.service';
 /// Replay                                                        ///
 /// - contains everything to do with Replay data.                 ///
 /////////////////////////////////////////////////////////////////////
+
 @Module({
   imports: [
     TypeOrmModule.forFeature([

src/score/score.module.ts

@@ -15,6 +15,7 @@ import { NotificationModule } from '../notifications/notifications.module';
 /// Score                                                         ///
 /// - contains everything to do with Score data.                  ///
 /////////////////////////////////////////////////////////////////////
+
 @Module({
   imports: [
     TypeOrmModule.forFeature([

src/task/task.module.ts

@@ -11,6 +11,7 @@ import { NotificationModule } from '../notifications/notifications.module';
 /// Task                                                          ///
 /// - contains everything to do with Task data.                   ///
 /////////////////////////////////////////////////////////////////////
+
 @Module({
   imports: [
     TypeOrmModule.forFeature([TaskEntity, FactionEntity]),

src/tracking/tracking.module.ts

@@ -12,6 +12,7 @@ import { FactionEntity } from '../faction/faction.entity';
 /// Tracking                                                      ///
 /// - contains everything to do with Tracking data.               ///
 /////////////////////////////////////////////////////////////////////
+
 @Module({
   imports: [
     TypeOrmModule.forFeature([