From fe8c6626517e5b46c2b04c6b92feba623b867f8d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marko=20Syd=C3=A4nmaa?= <L4072@student.jamk.fi>
Date: Thu, 25 Jul 2019 10:00:40 +0300
Subject: [PATCH] Comments conformed
---
src/app.module.ts | 32 +++++++++++-----------
src/draw/coordinate.entity.ts | 10 +++----
src/draw/draw.controller.ts | 4 ---
src/draw/draw.module.ts | 4 +--
src/draw/draw.service.ts | 6 ++--
src/faction/faction.controller.ts | 32 +++++++++++-----------
src/faction/faction.dto.ts | 12 ++++----
src/faction/faction.entity.ts | 6 ++--
src/faction/faction.module.ts | 24 ++++++++--------
src/faction/faction.service.ts | 28 +++++++++----------
src/game/game.module.ts | 1 +
src/game/gameperson.decorator.ts | 19 +++++++------
src/main.ts | 10 +++----
src/notifications/notifications.gateway.ts | 6 ++--
src/notifications/notifications.module.ts | 4 ---
src/replay/replay.controller.ts | 6 ++--
src/replay/replay.module.ts | 1 +
src/score/score.module.ts | 1 +
src/task/task.module.ts | 1 +
src/tracking/tracking.module.ts | 1 +
src/user/user.controller.ts | 18 ++++++------
src/user/user.decorator.ts | 14 +++++-----
src/user/user.dto.ts | 10 +++----
src/user/user.entity.ts | 16 +++++------
src/user/user.module.ts | 20 +++++++-------
src/user/user.service.ts | 19 +++++++------
26 files changed, 152 insertions(+), 153 deletions(-)
diff --git a/src/app.module.ts b/src/app.module.ts
index d3461d2..9b68312 100644
--- a/src/app.module.ts
+++ b/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: [
diff --git a/src/draw/coordinate.entity.ts b/src/draw/coordinate.entity.ts
index 01c5d67..da5e940 100644
--- a/src/draw/coordinate.entity.ts
+++ b/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 {
diff --git a/src/draw/draw.controller.ts b/src/draw/draw.controller.ts
index efc4e1b..d66bebe 100644
--- a/src/draw/draw.controller.ts
+++ b/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) {}
diff --git a/src/draw/draw.module.ts b/src/draw/draw.module.ts
index 5bc079e..f03fc3a 100644
--- a/src/draw/draw.module.ts
+++ b/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([
diff --git a/src/draw/draw.service.ts b/src/draw/draw.service.ts
index fabc3a4..da4b239 100644
--- a/src/draw/draw.service.ts
+++ b/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 {
diff --git a/src/faction/faction.controller.ts b/src/faction/faction.controller.ts
index e18add7..5eb905c 100644
--- a/src/faction/faction.controller.ts
+++ b/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 {
diff --git a/src/faction/faction.dto.ts b/src/faction/faction.dto.ts
index c905999..511fce1 100644
--- a/src/faction/faction.dto.ts
+++ b/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()
diff --git a/src/faction/faction.entity.ts b/src/faction/faction.entity.ts
index 0240260..20b4a0a 100644
--- a/src/faction/faction.entity.ts
+++ b/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 {
diff --git a/src/faction/faction.module.ts b/src/faction/faction.module.ts
index 49ba6e9..3a3026d 100644
--- a/src/faction/faction.module.ts
+++ b/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: [
diff --git a/src/faction/faction.service.ts b/src/faction/faction.service.ts
index ba9370b..9447c36 100644
--- a/src/faction/faction.service.ts
+++ b/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 {
diff --git a/src/game/game.module.ts b/src/game/game.module.ts
index 2c5ba6a..e119e49 100644
--- a/src/game/game.module.ts
+++ b/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([
diff --git a/src/game/gameperson.decorator.ts b/src/game/gameperson.decorator.ts
index c23eb38..3e2a232 100644
--- a/src/game/gameperson.decorator.ts
+++ b/src/game/gameperson.decorator.ts
@@ -1,15 +1,16 @@
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;
});
diff --git a/src/main.ts b/src/main.ts
index 6504af3..20e08b2 100644
--- a/src/main.ts
+++ b/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
diff --git a/src/notifications/notifications.gateway.ts b/src/notifications/notifications.gateway.ts
index f0fb179..79fcc0e 100644
--- a/src/notifications/notifications.gateway.ts
+++ b/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
diff --git a/src/notifications/notifications.module.ts b/src/notifications/notifications.module.ts
index ef8a542..5ca243f 100644
--- a/src/notifications/notifications.module.ts
+++ b/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],
diff --git a/src/replay/replay.controller.ts b/src/replay/replay.controller.ts
index a2634a4..e39e99d 100644
--- a/src/replay/replay.controller.ts
+++ b/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 {
diff --git a/src/replay/replay.module.ts b/src/replay/replay.module.ts
index 6df1133..bea3525 100644
--- a/src/replay/replay.module.ts
+++ b/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([
diff --git a/src/score/score.module.ts b/src/score/score.module.ts
index fce21d1..9ce2f41 100644
--- a/src/score/score.module.ts
+++ b/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([
diff --git a/src/task/task.module.ts b/src/task/task.module.ts
index dc4b8f6..9b009fc 100644
--- a/src/task/task.module.ts
+++ b/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]),
diff --git a/src/tracking/tracking.module.ts b/src/tracking/tracking.module.ts
index 98079e9..de4afda 100644
--- a/src/tracking/tracking.module.ts
+++ b/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([
diff --git a/src/user/user.controller.ts b/src/user/user.controller.ts
index 09e308d..8e76357 100644
--- a/src/user/user.controller.ts
+++ b/src/user/user.controller.ts
@@ -12,15 +12,15 @@ import { UserDTO } from './user.dto';
import { AuthGuard } from '../shared/auth.guard';
import { ValidationPipe } from '../shared/validation.pipe';
-/*
-UserController is being used for routing:
-- Login
-- Register
-
-- Verify is checking for logged in user
-
-See shared folder files for more information on decorators.
-*/
+/////////////////////////////////////////////////////////////////////
+/// UserController is being used for routing: ///
+/// - Login ///
+/// - Register ///
+/// ///
+/// - Verify is checking for logged in user ///
+/// ///
+/// See shared folder files for more information on decorators. ///
+/////////////////////////////////////////////////////////////////////
@Controller('user')
export class UserController {
diff --git a/src/user/user.decorator.ts b/src/user/user.decorator.ts
index 2f9a6fc..4a6ec47 100644
--- a/src/user/user.decorator.ts
+++ b/src/user/user.decorator.ts
@@ -1,12 +1,12 @@
import { createParamDecorator } from '@nestjs/common';
-/*
-UserDecorator
-
-See auth.guard.ts in shared folder for more information
-
-Returns user id and user name, this is mainly used to return user id
-*/
+///////////////////////////////////////////////////////////////////////////////
+/// UserDecorator ///
+/// ///
+/// See auth.guard.ts in shared folder for more information ///
+/// ///
+/// Returns user id and user name, this is mainly used to return user id ///
+///////////////////////////////////////////////////////////////////////////////
// used to pass user information to controllers
export const User = createParamDecorator((data, req) => {
diff --git a/src/user/user.dto.ts b/src/user/user.dto.ts
index 4f1b8d6..243dae1 100644
--- a/src/user/user.dto.ts
+++ b/src/user/user.dto.ts
@@ -1,10 +1,10 @@
import { IsString, IsNotEmpty, Length } from 'class-validator';
-/*
-Contains Validation for UserDTO
-uses class-validator built in validations
-see https://github.com/typestack/class-validator
-*/
+///////////////////////////////////////////////////////////
+/// Contains Validation for UserDTO ///
+/// uses class-validator built in validations ///
+/// see https://github.com/typestack/class-validator ///
+///////////////////////////////////////////////////////////
export class UserDTO {
@IsString()
diff --git a/src/user/user.entity.ts b/src/user/user.entity.ts
index 216eeb8..1c4c8d9 100644
--- a/src/user/user.entity.ts
+++ b/src/user/user.entity.ts
@@ -11,14 +11,14 @@ import * as jwt from 'jsonwebtoken';
import { Game_PersonEntity } from '../game/game.entity';
import { Exclude } from 'class-transformer';
-/*
-UserEntity reflects database table.
-
-Before handling password to database we encrypt it with bcrypt.
-password field will be excluded unless we call repository relation.
-
-token will be created when user registers or logs in to the system.
-*/
+/////////////////////////////////////////////////////////////////////////////
+/// UserEntity reflects database table. ///
+/// ///
+/// Before handling password to database we encrypt it with bcrypt. ///
+/// password field will be excluded unless we call repository relation. ///
+/// ///
+/// token will be created when user registers or logs in to the system. ///
+/////////////////////////////////////////////////////////////////////////////
@Entity('Person')
export class PersonEntity {
diff --git a/src/user/user.module.ts b/src/user/user.module.ts
index 7216dde..85ec0ff 100644
--- a/src/user/user.module.ts
+++ b/src/user/user.module.ts
@@ -5,16 +5,16 @@ import { UserController } from './user.controller';
import { UserService } from './user.service';
import { PersonEntity } from './user.entity';
-/*
-Entities
-- PersonEntity
-
-Controllers
-- UserController
-
-Provider
-- UserService
-*/
+///////////////////////////
+/// Entities ///
+/// - PersonEntity ///
+/// ///
+/// Controllers ///
+/// - UserController ///
+/// ///
+/// Provider ///
+/// - UserService ///
+///////////////////////////
@Module({
imports: [TypeOrmModule.forFeature([PersonEntity])],
diff --git a/src/user/user.service.ts b/src/user/user.service.ts
index d34dec0..5e05634 100644
--- a/src/user/user.service.ts
+++ b/src/user/user.service.ts
@@ -4,16 +4,17 @@ import { InjectRepository } from '@nestjs/typeorm';
import { PersonEntity } from './user.entity';
import { UserDTO } from './user.dto';
-/*
-UserService contains functions for
-- Login
-- Register
-Both functions return logged in users tokenObject
-See more info in UserEntity.
-
-See more info on DTO in it's respective file
-*/
+///////////////////////////////////////////////////////////
+/// UserService contains functions for ///
+/// - Login ///
+/// - Register ///
+/// ///
+/// Both functions return logged in users tokenObject ///
+/// See more info in UserEntity. ///
+/// ///
+/// See more info on DTO in it's respective file ///
+///////////////////////////////////////////////////////////
@Injectable()
export class UserService {
--
GitLab