From 7ced0b1b40fbce8ddfdf741b0daa4f1f6f0dfad9 Mon Sep 17 00:00:00 2001 From: VegaZ Date: Wed, 19 Sep 2018 15:57:10 +0200 Subject: [PATCH] Add File-Overview comments, move out of place comments --- Client/Login/login.html | 7 ++++++- Client/Login/login.js | 8 +++++++- Client/Login/main.js | 7 ++++++- Client/Login/style.css | 8 +++++++- Client/index.js | 6 ++++++ Main.cs | 12 +++++++----- Model/DatabaseContext.cs | 15 +++++++-------- Server/Commands/Admin.cs | 12 ++++++------ Server/Entities/Character.cs | 16 ---------------- Server/Entities/User.cs | 6 ++++++ Server/Events/Connect.cs | 6 ++++++ Server/Events/Login.cs | 6 ++++++ Server/Events/Spawn.cs | 6 ++++++ Server/Extensions/ClientExtension.cs | 12 ++++++------ Server/Services/ChatService.cs | 12 ++++++------ Server/Services/ClientService.cs | 12 ++++++------ Server/Util/AdminLevel.cs | 12 +++++++----- 17 files changed, 101 insertions(+), 62 deletions(-) delete mode 100644 Server/Entities/Character.cs diff --git a/Client/Login/login.html b/Client/Login/login.html index ac486575..0bfe5b52 100644 --- a/Client/Login/login.html +++ b/Client/Login/login.html @@ -1,4 +1,9 @@ - + + diff --git a/Client/Login/login.js b/Client/Login/login.js index 80ec311d..2e07b8fa 100644 --- a/Client/Login/login.js +++ b/Client/Login/login.js @@ -1,4 +1,10 @@ -$('#loginBtn').click(() => { +/** + * @overview Life of German Reallife - Login Login login.js + * @author VegaZ + * @copyright (c) 2008 - 2018 Life of German + */ + +$('#loginBtn').click(() => { $('.alert').remove(); //Remove any alerts when we attempt to login/register mp.trigger('loginInformationToServer', $('#usernameInputLogin').val(), $('#passwordInputLogin').val()); }); diff --git a/Client/Login/main.js b/Client/Login/main.js index 53e3b780..23f69481 100644 --- a/Client/Login/main.js +++ b/Client/Login/main.js @@ -1,4 +1,9 @@ -var loginBrowser = mp.browsers.new('package://Login/login.html'); +/** + * @overview Life of German Reallife - Login Main main.js + * @author VegaZ + * @copyright (c) 2008 - 2018 Life of German + */ +var loginBrowser = mp.browsers.new('package://Login/login.html'); mp.gui.cursor.show(true, true); mp.events.add('loginInformationToServer', (username, password) => { diff --git a/Client/Login/style.css b/Client/Login/style.css index 2916f236..2405799c 100644 --- a/Client/Login/style.css +++ b/Client/Login/style.css @@ -1,4 +1,10 @@ -.login-page { +/** + * @overview Life of German Reallife - Login CSS style.css + * @author Orangebox + * @copyright (c) 2008 - 2018 Life of German + */ + +.login-page { width: 360px; margin: auto; } diff --git a/Client/index.js b/Client/index.js index e7a9b22d..51689880 100644 --- a/Client/index.js +++ b/Client/index.js @@ -1 +1,7 @@ +/** + * @overview Life of German Reallife - Login index.js + * @author VegaZ + * @copyright (c) 2008 - 2018 Life of German + */ + require('./Login/main.js'); \ No newline at end of file diff --git a/Main.cs b/Main.cs index ab154131..f9e29611 100644 --- a/Main.cs +++ b/Main.cs @@ -1,15 +1,17 @@ using System; using GTANetworkAPI; +/** +* @overview Life of German Reallife - Main Class (Main.cs) +* @author VegaZ, hydrant +* @copyright (c) 2008 - 2018 Life of German +*/ + namespace reallife_gamemode { public class Main : Script { - /** - * @overview Life of German Reallife - Main Class (Main.cs) - * @author VegaZ, hydrant - * @copyright (c) 2008 - 2018 Life of German - */ + [ServerEvent(Event.ResourceStart)] public void OnResourceStart() diff --git a/Model/DatabaseContext.cs b/Model/DatabaseContext.cs index 07cc415e..296b503a 100644 --- a/Model/DatabaseContext.cs +++ b/Model/DatabaseContext.cs @@ -1,15 +1,15 @@ -/** - * @overview Life of German Reallife - DatabaseContext.cs - * @author VegaZ - * @copyright (c) 2008 - 2018 Life of German - */ - -using System; +using System; using System.ComponentModel.DataAnnotations; using System.ComponentModel.DataAnnotations.Schema; using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore.Metadata; +/** + * @overview Life of German Reallife - DatabaseContext.cs + * @author VegaZ + * @copyright (c) 2008 - 2018 Life of German + */ + namespace reallife_gamemode.Model { public partial class DatabaseContext : DbContext @@ -35,6 +35,5 @@ namespace reallife_gamemode.Model } public DbSet Users { get; set; } - public DbSet Characters { get; set; } } } diff --git a/Server/Commands/Admin.cs b/Server/Commands/Admin.cs index 1a16b7b8..fcf8c437 100644 --- a/Server/Commands/Admin.cs +++ b/Server/Commands/Admin.cs @@ -6,16 +6,16 @@ using reallife_gamemode.Server.Extensions; using reallife_gamemode.Server.Services; using reallife_gamemode.Server.Util; +/** +* @overview Life of German Reallife - Admin Commands (Admin.cs) +* @author VegaZ, hydrant +* @copyright (c) 2008 - 2018 Life of German +*/ + namespace reallife_gamemode.Server.Commands { public class Admin : Script { - /** - * @overview Life of German Reallife - Admin Commands (Admin.cs) - * @author VegaZ, hydrant - * @copyright (c) 2008 - 2018 Life of German - */ - [Command("o", "~m~Benutzung: ~s~/o [Nachricht]", GreedyArg = true)] public void CmdAdminO(Client player, string message) { diff --git a/Server/Entities/Character.cs b/Server/Entities/Character.cs deleted file mode 100644 index f5dd13f3..00000000 --- a/Server/Entities/Character.cs +++ /dev/null @@ -1,16 +0,0 @@ -using System; -using System.Collections.Generic; -using System.ComponentModel.DataAnnotations; -using System.Text; - -namespace reallife_gamemode.Server.Entities -{ - public class Character - { - [Key] - public int Id { get; set; } - public int UserId { get; set; } - public string Name { get; set; } - public byte Gender { get; set; } - } -} diff --git a/Server/Entities/User.cs b/Server/Entities/User.cs index 133ab2d1..1f0a934d 100644 --- a/Server/Entities/User.cs +++ b/Server/Entities/User.cs @@ -5,6 +5,12 @@ using System.ComponentModel.DataAnnotations; using System.ComponentModel.DataAnnotations.Schema; using System.Text; +/** +* @overview Life of German Reallife - Entities User (User.cs) +* @author VegaZ, hydrant +* @copyright (c) 2008 - 2018 Life of German +*/ + namespace reallife_gamemode.Server.Entities { public class User diff --git a/Server/Events/Connect.cs b/Server/Events/Connect.cs index b1b581f1..caa7ea4b 100644 --- a/Server/Events/Connect.cs +++ b/Server/Events/Connect.cs @@ -7,6 +7,12 @@ using Microsoft.EntityFrameworkCore; using reallife_gamemode.Model; using reallife_gamemode.Server.Entities; +/** +* @overview Life of German Reallife - Event Login (Login.cs) +* @author VegaZ +* @copyright (c) 2008 - 2018 Life of German +*/ + namespace reallife_gamemode.Server.Events { class Connect : Script diff --git a/Server/Events/Login.cs b/Server/Events/Login.cs index 5072e393..04ebb9b0 100644 --- a/Server/Events/Login.cs +++ b/Server/Events/Login.cs @@ -3,6 +3,12 @@ using System.Collections.Generic; using System.Text; using GTANetworkAPI; +/** +* @overview Life of German Reallife - Event Login (Login.cs) +* @author VegaZ +* @copyright (c) 2008 - 2018 Life of German +*/ + namespace reallife_gamemode.Server.Events { public class Login : Script diff --git a/Server/Events/Spawn.cs b/Server/Events/Spawn.cs index 1dfb2817..a11c5da6 100644 --- a/Server/Events/Spawn.cs +++ b/Server/Events/Spawn.cs @@ -6,6 +6,12 @@ using GTANetworkAPI; using GTANetworkMethods; using reallife_gamemode.Model; +/** +* @overview Life of German Reallife - Event Spawn (Spawn.cs) +* @author VegaZ +* @copyright (c) 2008 - 2018 Life of German +*/ + namespace reallife_gamemode.Server.Event { public class Spawn : Script diff --git a/Server/Extensions/ClientExtension.cs b/Server/Extensions/ClientExtension.cs index e2ff0861..38aed1ac 100644 --- a/Server/Extensions/ClientExtension.cs +++ b/Server/Extensions/ClientExtension.cs @@ -6,16 +6,16 @@ using System.Collections.Generic; using System.Linq; using System.Text; +/** +* @overview Life of German Reallife - Client Extension (ClientExtension.cs) +* @author VegaZ, hydrant +* @copyright (c) 2008 - 2018 Life of German +*/ + namespace reallife_gamemode.Server.Extensions { public static class ClientExtension { - /** - * @overview Life of German Reallife - Client Extension (ClientExtension.cs) - * @author VegaZ, hydrant - * @copyright (c) 2008 - 2018 Life of German - */ - public static User GetUser(this Client client) { using(DatabaseContext dbContext = new DatabaseContext()) diff --git a/Server/Services/ChatService.cs b/Server/Services/ChatService.cs index ad81edef..0ccdfe1f 100644 --- a/Server/Services/ChatService.cs +++ b/Server/Services/ChatService.cs @@ -3,16 +3,16 @@ using System; using System.Collections.Generic; using System.Text; +/** +* @overview Life of German Reallife - Chat Service (ChatService.cs) +* @author hydrant +* @copyright (c) 2008 - 2018 Life of German +*/ + namespace reallife_gamemode.Server.Services { class ChatService { - /** - * @overview Life of German Reallife - Chat Service (ChatService.cs) - * @author hydrant - * @copyright (c) 2008 - 2018 Life of German - */ - public static void NotAuthorized(Client player) { player.SendChatMessage("~r~[FEHLER]~s~ Du kannst diesen Befehl nicht ausführen."); diff --git a/Server/Services/ClientService.cs b/Server/Services/ClientService.cs index d60500f6..6959b3fa 100644 --- a/Server/Services/ClientService.cs +++ b/Server/Services/ClientService.cs @@ -3,16 +3,16 @@ using System; using System.Collections.Generic; using System.Text; +/** +* @overview Life of German Reallife - Client Service (ClientService.cs) +* @author hydrant +* @copyright (c) 2008 - 2018 Life of German +*/ + namespace reallife_gamemode.Server.Services { class ClientService { - /** - * @overview Life of German Reallife - Client Service (ClientService.cs) - * @author hydrant - * @copyright (c) 2008 - 2018 Life of German - */ - public static Client GetClientByName(string name) { /* Funktionsaufbau: Prüft erst, ob ein Spieler mit exakt diesem Namen online ist diff --git a/Server/Util/AdminLevel.cs b/Server/Util/AdminLevel.cs index 8a691fe6..8e201b63 100644 --- a/Server/Util/AdminLevel.cs +++ b/Server/Util/AdminLevel.cs @@ -2,15 +2,17 @@ using System.Collections.Generic; using System.Text; +/** +* @overview Life of German Reallife - Admin Levels (AdminLevel.cs) +* @author VegaZ, hydrant +* @copyright (c) 2008 - 2018 Life of German +*/ + namespace reallife_gamemode.Server.Util { public enum AdminLevel : int { - /** - * @overview Life of German Reallife - Admin Levels (AdminLevel.cs) - * @author VegaZ, hydrant - * @copyright (c) 2008 - 2018 Life of German - */ + PLAYER, SUPPORTER,