diff --git a/Cicm.Database/IDbCore.cs b/Cicm.Database/IDbCore.cs index 52522dc8..3bbc36a4 100644 --- a/Cicm.Database/IDbCore.cs +++ b/Cicm.Database/IDbCore.cs @@ -27,22 +27,51 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + using System.Data; namespace Cicm.Database { + /// Interface to database public interface IDbCore { + /// Database operations Operations Operations { get; } + /// Last inserted row's ID long LastInsertRowId { get; } + /// + /// Opens an existing database + /// + /// Server + /// User + /// Database name + /// Password + /// Port + /// true if database opened correctly, false otherwise bool OpenDb(string server, string user, string database, string password, ushort port); + /// + /// Closes the database + /// void CloseDb(); + /// + /// Creates a new database + /// + /// Server + /// User + /// Database name + /// Password + /// Port + /// true if database is created correctly, false otherwise bool CreateDb(string database, string server, string user, string password, ushort port); + /// + /// Gets a data adapter for the opened database + /// + /// Data adapter IDbDataAdapter GetNewDataAdapter(); } } \ No newline at end of file diff --git a/Cicm.Database/Mysql.cs b/Cicm.Database/Mysql.cs index a15eec06..30425dc9 100644 --- a/Cicm.Database/Mysql.cs +++ b/Cicm.Database/Mysql.cs @@ -27,6 +27,7 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + using System; using System.Data; using MySql.Data.MySqlClient; @@ -45,7 +46,10 @@ namespace Cicm.Database connection = new MySqlConnection(connectionString); } + /// Database operations public Operations Operations { get; private set; } + + /// Last inserted row's ID public long LastInsertRowId { get @@ -62,6 +66,15 @@ namespace Cicm.Database } } + /// + /// Opens an existing database + /// + /// Server + /// User + /// Database name + /// Password + /// Port + /// true if database opened correctly, false otherwise public bool OpenDb(string server, string user, string database, string password, ushort port = 3306) { try @@ -89,12 +102,24 @@ namespace Cicm.Database } } + /// + /// Closes the database + /// public void CloseDb() { connection?.Close(); connection = null; } + /// + /// Creates a new database + /// + /// Server + /// User + /// Database name + /// Password + /// Port + /// true if database is created correctly, false otherwise public bool CreateDb(string database, string server, string user, string password, ushort port = 3306) { try @@ -128,6 +153,10 @@ namespace Cicm.Database } } + /// + /// Gets a data adapter for the opened database + /// + /// Data adapter public IDbDataAdapter GetNewDataAdapter() { return new MySqlDataAdapter(); diff --git a/Cicm.Database/Operations/Admin.cs b/Cicm.Database/Operations/Admin.cs index ad0d22ba..6e091848 100644 --- a/Cicm.Database/Operations/Admin.cs +++ b/Cicm.Database/Operations/Admin.cs @@ -27,6 +27,7 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + using System; using System.Collections.Generic; using System.Data; @@ -37,6 +38,11 @@ namespace Cicm.Database { public partial class Operations { + /// + /// Gets all admins + /// + /// All admins + /// true if is correct, false otherwise public bool GetAdmins(out List entries) { #if DEBUG @@ -67,6 +73,13 @@ namespace Cicm.Database } } + /// + /// Gets the specified number of admins since the specified start + /// + /// List of admins + /// Start of query + /// How many entries to retrieve + /// true if is correct, false otherwise public bool GetAdmins(out List entries, ulong start, ulong count) { #if DEBUG @@ -97,6 +110,11 @@ namespace Cicm.Database } } + /// + /// Gets admin by specified id + /// + /// Id + /// Admin with specified id, null if not found or error public Admin GetAdmin(int id) { #if DEBUG @@ -126,6 +144,10 @@ namespace Cicm.Database } } + /// + /// Counts the number of administrators in the database + /// + /// Entries in database public long CountAdmins() { #if DEBUG @@ -140,6 +162,12 @@ namespace Cicm.Database catch { return 0; } } + /// + /// Adds a new administrator to the database + /// + /// Entry to add + /// ID of added entry + /// true if added correctly, false otherwise public bool AddAdmin(Admin entry, out long id) { #if DEBUG @@ -167,6 +195,11 @@ namespace Cicm.Database return true; } + /// + /// Updated an administrator in the database + /// + /// Updated entry + /// true if updated correctly, false otherwise public bool UpdateAdmin(Admin entry) { #if DEBUG @@ -188,6 +221,11 @@ namespace Cicm.Database return true; } + /// + /// Removes an administrator from the database + /// + /// ID of entry to remove + /// true if removed correctly, false otherwise public bool RemoveAdmin(long id) { #if DEBUG diff --git a/Cicm.Database/Operations/BrowserTest.cs b/Cicm.Database/Operations/BrowserTest.cs index 37488f4c..d8df6744 100644 --- a/Cicm.Database/Operations/BrowserTest.cs +++ b/Cicm.Database/Operations/BrowserTest.cs @@ -27,6 +27,7 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + using System; using System.Collections.Generic; using System.Data; @@ -37,6 +38,11 @@ namespace Cicm.Database { public partial class Operations { + /// + /// Gets all browser tests + /// + /// All browser tests + /// true if is correct, false otherwise public bool GetBrowserTests(out List entries) { #if DEBUG @@ -67,6 +73,13 @@ namespace Cicm.Database } } + /// + /// Gets the specified number of browser tests since the specified start + /// + /// List of browser tests + /// Start of query + /// How many entries to retrieve + /// true if is correct, false otherwise public bool GetBrowserTests(out List entries, ulong start, ulong count) { #if DEBUG @@ -97,6 +110,11 @@ namespace Cicm.Database } } + /// + /// Gets browser test by specified id + /// + /// Id + /// Browser test with specified id, null if not found or error public BrowserTest GetBrowserTest(int id) { #if DEBUG @@ -126,6 +144,10 @@ namespace Cicm.Database } } + /// + /// Counts the number of browser tests in the database + /// + /// Entries in database public long CountBrowserTests() { #if DEBUG @@ -140,6 +162,12 @@ namespace Cicm.Database catch { return 0; } } + /// + /// Adds a new browser test to the database + /// + /// Entry to add + /// ID of added entry + /// true if added correctly, false otherwise public bool AddBrowserTest(BrowserTest entry, out long id) { #if DEBUG @@ -169,6 +197,11 @@ namespace Cicm.Database return true; } + /// + /// Updated a browser test in the database + /// + /// Updated entry + /// true if updated correctly, false otherwise public bool UpdateBrowserTest(BrowserTest entry) { #if DEBUG @@ -193,6 +226,11 @@ namespace Cicm.Database return true; } + /// + /// Removes a browser test from the database + /// + /// ID of entry to remove + /// true if removed correctly, false otherwise public bool RemoveBrowserTest(long id) { #if DEBUG diff --git a/Cicm.Database/Operations/Company.cs b/Cicm.Database/Operations/Company.cs index 20ac4804..22189e8d 100644 --- a/Cicm.Database/Operations/Company.cs +++ b/Cicm.Database/Operations/Company.cs @@ -27,6 +27,7 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + using System; using System.Collections.Generic; using System.Data; @@ -37,6 +38,11 @@ namespace Cicm.Database { public partial class Operations { + /// + /// Gets all companies + /// + /// All companies + /// true if is correct, false otherwise public bool GetCompanies(out List entries) { #if DEBUG @@ -67,6 +73,13 @@ namespace Cicm.Database } } + /// + /// Gets the specified number of companies since the specified start + /// + /// List of companies + /// Start of query + /// How many entries to retrieve + /// true if is correct, false otherwise public bool GetCompanies(out List entries, ulong start, ulong count) { #if DEBUG @@ -97,6 +110,11 @@ namespace Cicm.Database } } + /// + /// Gets company by specified id + /// + /// Id + /// Company with specified id, null if not found or error public Company GetCompany(int id) { #if DEBUG @@ -126,6 +144,10 @@ namespace Cicm.Database } } + /// + /// Counts the number of companies in the database + /// + /// Entries in database public long CountCompanies() { #if DEBUG @@ -140,6 +162,12 @@ namespace Cicm.Database catch { return 0; } } + /// + /// Adds a new company to the database + /// + /// Entry to add + /// ID of added entry + /// true if added correctly, false otherwise public bool AddCompany(Company entry, out long id) { #if DEBUG @@ -167,6 +195,11 @@ namespace Cicm.Database return true; } + /// + /// Updated a company in the database + /// + /// Updated entry + /// true if updated correctly, false otherwise public bool UpdateCompany(Company entry) { #if DEBUG @@ -188,6 +221,11 @@ namespace Cicm.Database return true; } + /// + /// Removes a company from the database + /// + /// ID of entry to remove + /// true if removed correctly, false otherwise public bool RemoveCompany(long id) { #if DEBUG diff --git a/Cicm.Database/Operations/Computer.cs b/Cicm.Database/Operations/Computer.cs index 38eb7450..d8a3f563 100644 --- a/Cicm.Database/Operations/Computer.cs +++ b/Cicm.Database/Operations/Computer.cs @@ -27,6 +27,7 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + using System; using System.Collections.Generic; using System.Data; @@ -37,6 +38,11 @@ namespace Cicm.Database { public partial class Operations { + /// + /// Gets all computers + /// + /// All computers + /// true if is correct, false otherwise public bool GetComputers(out List entries) { #if DEBUG @@ -67,6 +73,13 @@ namespace Cicm.Database } } + /// + /// Gets the specified number of computers since the specified start + /// + /// List of computers + /// Start of query + /// How many entries to retrieve + /// true if is correct, false otherwise public bool GetComputers(out List entries, ulong start, ulong count) { #if DEBUG @@ -97,6 +110,11 @@ namespace Cicm.Database } } + /// + /// Gets computer by specified id + /// + /// Id + /// Computer with specified id, null if not found or error public Computer GetComputer(int id) { #if DEBUG @@ -126,6 +144,10 @@ namespace Cicm.Database } } + /// + /// Counts the number of computers in the database + /// + /// Entries in database public long CountComputers() { #if DEBUG @@ -140,6 +162,12 @@ namespace Cicm.Database catch { return 0; } } + /// + /// Adds a new administrator to the database + /// + /// Entry to add + /// ID of added entry + /// true if added correctly, false otherwise public bool AddComputer(Computer entry, out long id) { #if DEBUG @@ -169,6 +197,11 @@ namespace Cicm.Database return true; } + /// + /// Updated a computer in the database + /// + /// Updated entry + /// true if updated correctly, false otherwise public bool UpdateComputer(Computer entry) { #if DEBUG @@ -194,6 +227,11 @@ namespace Cicm.Database return true; } + /// + /// Removes a computer from the database + /// + /// ID of entry to remove + /// true if removed correctly, false otherwise public bool RemoveComputer(long id) { #if DEBUG diff --git a/Cicm.Database/Operations/Console.cs b/Cicm.Database/Operations/Console.cs index ded20041..d9204a9c 100644 --- a/Cicm.Database/Operations/Console.cs +++ b/Cicm.Database/Operations/Console.cs @@ -27,6 +27,7 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + using System; using System.Collections.Generic; using System.Data; @@ -36,6 +37,11 @@ namespace Cicm.Database { public partial class Operations { + /// + /// Gets all consoles + /// + /// All consoles + /// true if is correct, false otherwise public bool GetConsoles(out List entries) { #if DEBUG @@ -66,6 +72,13 @@ namespace Cicm.Database } } + /// + /// Gets the specified number of videogame consoles since the specified start + /// + /// List of videogame consoles + /// Start of query + /// How many entries to retrieve + /// true if is correct, false otherwise public bool GetConsoles(out List entries, ulong start, ulong count) { #if DEBUG @@ -96,6 +109,11 @@ namespace Cicm.Database } } + /// + /// Gets videogame console by specified id + /// + /// Id + /// Videogame console with specified id, null if not found or error public Console GetConsole(int id) { #if DEBUG @@ -125,6 +143,10 @@ namespace Cicm.Database } } + /// + /// Counts the number of videogame consoles in the database + /// + /// Entries in database public long CountConsoles() { #if DEBUG @@ -139,6 +161,12 @@ namespace Cicm.Database catch { return 0; } } + /// + /// Adds a new videogame console to the database + /// + /// Entry to add + /// ID of added entry + /// true if added correctly, false otherwise public bool AddConsole(Console entry, out long id) { #if DEBUG @@ -168,6 +196,11 @@ namespace Cicm.Database return true; } + /// + /// Updated an videogame console in the database + /// + /// Updated entry + /// true if updated correctly, false otherwise public bool UpdateConsole(Console entry) { #if DEBUG @@ -193,6 +226,11 @@ namespace Cicm.Database return true; } + /// + /// Removes a videogame console from the database + /// + /// ID of entry to remove + /// true if removed correctly, false otherwise public bool RemoveConsole(long id) { #if DEBUG diff --git a/Cicm.Database/Operations/ConsoleCompany.cs b/Cicm.Database/Operations/ConsoleCompany.cs index 26f8ee49..913ef57e 100644 --- a/Cicm.Database/Operations/ConsoleCompany.cs +++ b/Cicm.Database/Operations/ConsoleCompany.cs @@ -27,6 +27,7 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + using System; using System.Collections.Generic; using System.Data; @@ -37,6 +38,11 @@ namespace Cicm.Database { public partial class Operations { + /// + /// Gets all console companies + /// + /// All console companies + /// true if is correct, false otherwise public bool GetConsoleCompanies(out List entries) { #if DEBUG @@ -67,6 +73,13 @@ namespace Cicm.Database } } + /// + /// Gets the specified number of console companies since the specified start + /// + /// List of console companies + /// Start of query + /// How many entries to retrieve + /// true if is correct, false otherwise public bool GetConsoleCompanies(out List entries, ulong start, ulong count) { #if DEBUG @@ -97,6 +110,11 @@ namespace Cicm.Database } } + /// + /// Gets console company by specified id + /// + /// Id + /// Console company with specified id, null if not found or error public ConsoleCompany GetConsoleCompany(int id) { #if DEBUG @@ -126,6 +144,10 @@ namespace Cicm.Database } } + /// + /// Counts the number of console companies in the database + /// + /// Entries in database public long CountConsoleCompanies() { #if DEBUG @@ -140,6 +162,12 @@ namespace Cicm.Database catch { return 0; } } + /// + /// Adds a new console company to the database + /// + /// Entry to add + /// ID of added entry + /// true if added correctly, false otherwise public bool AddConsoleCompany(ConsoleCompany entry, out long id) { #if DEBUG @@ -167,6 +195,11 @@ namespace Cicm.Database return true; } + /// + /// Updated a console company in the database + /// + /// Updated entry + /// true if updated correctly, false otherwise public bool UpdateConsoleCompany(ConsoleCompany entry) { #if DEBUG @@ -188,6 +221,11 @@ namespace Cicm.Database return true; } + /// + /// Removes a console company from the database + /// + /// ID of entry to remove + /// true if removed correctly, false otherwise public bool RemoveConsoleCompany(long id) { #if DEBUG diff --git a/Cicm.Database/Operations/Cpu.cs b/Cicm.Database/Operations/Cpu.cs index e2ad9cd3..d43c0588 100644 --- a/Cicm.Database/Operations/Cpu.cs +++ b/Cicm.Database/Operations/Cpu.cs @@ -27,6 +27,7 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + using System; using System.Collections.Generic; using System.Data; @@ -37,6 +38,11 @@ namespace Cicm.Database { public partial class Operations { + /// + /// Gets all CPUs + /// + /// All CPUs + /// true if is correct, false otherwise public bool GetCpus(out List entries) { #if DEBUG @@ -67,6 +73,13 @@ namespace Cicm.Database } } + /// + /// Gets the specified number of CPUs since the specified start + /// + /// List of CPUs + /// Start of query + /// How many entries to retrieve + /// true if is correct, false otherwise public bool GetCpus(out List entries, ulong start, ulong count) { #if DEBUG @@ -97,6 +110,11 @@ namespace Cicm.Database } } + /// + /// Gets CPU by specified id + /// + /// Id + /// CPU with specified id, null if not found or error public Cpu GetCpu(int id) { #if DEBUG @@ -126,6 +144,10 @@ namespace Cicm.Database } } + /// + /// Counts the number of CPUs in the database + /// + /// Entries in database public long CountCpus() { #if DEBUG @@ -140,6 +162,12 @@ namespace Cicm.Database catch { return 0; } } + /// + /// Adds a new CPU to the database + /// + /// Entry to add + /// ID of added entry + /// true if added correctly, false otherwise public bool AddCpu(Cpu entry, out long id) { #if DEBUG @@ -167,6 +195,11 @@ namespace Cicm.Database return true; } + /// + /// Updated a CPU in the database + /// + /// Updated entry + /// true if updated correctly, false otherwise public bool UpdateCpu(Cpu entry) { #if DEBUG @@ -188,6 +221,11 @@ namespace Cicm.Database return true; } + /// + /// Removes a CPU from the database + /// + /// ID of entry to remove + /// true if removed correctly, false otherwise public bool RemoveCpu(long id) { #if DEBUG diff --git a/Cicm.Database/Operations/DiskFormat.cs b/Cicm.Database/Operations/DiskFormat.cs index 19aaf23d..b3b71558 100644 --- a/Cicm.Database/Operations/DiskFormat.cs +++ b/Cicm.Database/Operations/DiskFormat.cs @@ -27,6 +27,7 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + using System; using System.Collections.Generic; using System.Data; @@ -37,6 +38,11 @@ namespace Cicm.Database { public partial class Operations { + /// + /// Gets all disk formats + /// + /// All disk formats + /// true if is correct, false otherwise public bool GetDiskFormats(out List entries) { #if DEBUG @@ -67,6 +73,13 @@ namespace Cicm.Database } } + /// + /// Gets the specified number of disk formats since the specified start + /// + /// List of disk formats + /// Start of query + /// How many entries to retrieve + /// true if is correct, false otherwise public bool GetDiskFormats(out List entries, ulong start, ulong count) { #if DEBUG @@ -97,6 +110,11 @@ namespace Cicm.Database } } + /// + /// Gets disk format by specified id + /// + /// Id + /// Disk format with specified id, null if not found or error public DiskFormat GetDiskFormat(int id) { #if DEBUG @@ -126,6 +144,10 @@ namespace Cicm.Database } } + /// + /// Counts the number of disk formats in the database + /// + /// Entries in database public long CountDiskFormats() { #if DEBUG @@ -140,6 +162,12 @@ namespace Cicm.Database catch { return 0; } } + /// + /// Adds a new disk format to the database + /// + /// Entry to add + /// ID of added entry + /// true if added correctly, false otherwise public bool AddDiskFormat(DiskFormat entry, out long id) { #if DEBUG @@ -167,6 +195,11 @@ namespace Cicm.Database return true; } + /// + /// Updated a disk format in the database + /// + /// Updated entry + /// true if updated correctly, false otherwise public bool UpdateDiskFormat(DiskFormat entry) { #if DEBUG @@ -188,6 +221,11 @@ namespace Cicm.Database return true; } + /// + /// Removes a disk format from the database + /// + /// ID of entry to remove + /// true if removed correctly, false otherwise public bool RemoveDiskFormat(long id) { #if DEBUG diff --git a/Cicm.Database/Operations/Dsp.cs b/Cicm.Database/Operations/Dsp.cs index f811f4e9..52f6eb09 100644 --- a/Cicm.Database/Operations/Dsp.cs +++ b/Cicm.Database/Operations/Dsp.cs @@ -27,6 +27,7 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + using System; using System.Collections.Generic; using System.Data; @@ -37,6 +38,11 @@ namespace Cicm.Database { public partial class Operations { + /// + /// Gets all DSPs + /// + /// All DSPs + /// true if is correct, false otherwise public bool GetDsps(out List entries) { #if DEBUG @@ -67,6 +73,13 @@ namespace Cicm.Database } } + /// + /// Gets the specified number of DSPs since the specified start + /// + /// List of DSPs + /// Start of query + /// How many entries to retrieve + /// true if is correct, false otherwise public bool GetDsps(out List entries, ulong start, ulong count) { #if DEBUG @@ -97,6 +110,11 @@ namespace Cicm.Database } } + /// + /// Gets DSP by specified id + /// + /// Id + /// DSP with specified id, null if not found or error public Dsp GetDsp(int id) { #if DEBUG @@ -126,6 +144,10 @@ namespace Cicm.Database } } + /// + /// Counts the number of DSPs in the database + /// + /// Entries in database public long CountDsps() { #if DEBUG @@ -140,6 +162,12 @@ namespace Cicm.Database catch { return 0; } } + /// + /// Adds a new DSP to the database + /// + /// Entry to add + /// ID of added entry + /// true if added correctly, false otherwise public bool AddDsp(Dsp entry, out long id) { #if DEBUG @@ -167,6 +195,11 @@ namespace Cicm.Database return true; } + /// + /// Updated a DSP in the database + /// + /// Updated entry + /// true if updated correctly, false otherwise public bool UpdateDsp(Dsp entry) { #if DEBUG @@ -188,6 +221,11 @@ namespace Cicm.Database return true; } + /// + /// Removes a DSP from the database + /// + /// ID of entry to remove + /// true if removed correctly, false otherwise public bool RemoveDsp(long id) { #if DEBUG diff --git a/Cicm.Database/Operations/Forbidden.cs b/Cicm.Database/Operations/Forbidden.cs index 6fdbe1cc..f92d7ca1 100644 --- a/Cicm.Database/Operations/Forbidden.cs +++ b/Cicm.Database/Operations/Forbidden.cs @@ -27,6 +27,7 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + using System; using System.Collections.Generic; using System.Data; @@ -37,6 +38,11 @@ namespace Cicm.Database { public partial class Operations { + /// + /// Gets all forbidden accesses + /// + /// All forbidden accesses + /// true if is correct, false otherwise public bool GetForbiddens(out List entries) { #if DEBUG @@ -67,6 +73,13 @@ namespace Cicm.Database } } + /// + /// Gets the specified number of forbidden accesses since the specified start + /// + /// List of forbidden accesses + /// Start of query + /// How many entries to retrieve + /// true if is correct, false otherwise public bool GetForbiddens(out List entries, ulong start, ulong count) { #if DEBUG @@ -97,6 +110,11 @@ namespace Cicm.Database } } + /// + /// Gets forbidden entry by specified id + /// + /// Id + /// Forbidden entry with specified id, null if not found or error public Forbidden GetForbidden(int id) { #if DEBUG @@ -126,6 +144,10 @@ namespace Cicm.Database } } + /// + /// Counts the number of Forbidden accesses in the database + /// + /// Entries in database public long CountForbiddens() { #if DEBUG @@ -140,6 +162,12 @@ namespace Cicm.Database catch { return 0; } } + /// + /// Adds a new forbidden to the database + /// + /// Entry to add + /// ID of added entry + /// true if added correctly, false otherwise public bool AddForbidden(Forbidden entry, out long id) { #if DEBUG @@ -168,6 +196,11 @@ namespace Cicm.Database return true; } + /// + /// Updated a forbidden access in the database + /// + /// Updated entry + /// true if updated correctly, false otherwise public bool UpdateForbidden(Forbidden entry) { #if DEBUG @@ -190,6 +223,11 @@ namespace Cicm.Database return true; } + /// + /// Removes a forbidden access from the database + /// + /// ID of entry to remove + /// true if removed correctly, false otherwise public bool RemoveForbidden(long id) { #if DEBUG diff --git a/Cicm.Database/Operations/Gpu.cs b/Cicm.Database/Operations/Gpu.cs index 12b90963..a8116303 100644 --- a/Cicm.Database/Operations/Gpu.cs +++ b/Cicm.Database/Operations/Gpu.cs @@ -27,6 +27,7 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + using System; using System.Collections.Generic; using System.Data; @@ -37,6 +38,11 @@ namespace Cicm.Database { public partial class Operations { + /// + /// Gets all GPUs + /// + /// All GPUs + /// true if is correct, false otherwise public bool GetGpus(out List entries) { #if DEBUG @@ -67,6 +73,13 @@ namespace Cicm.Database } } + /// + /// Gets the specified number of GPUs since the specified start + /// + /// List of GPUs + /// Start of query + /// How many entries to retrieve + /// true if is correct, false otherwise public bool GetGpus(out List entries, ulong start, ulong count) { #if DEBUG @@ -97,6 +110,11 @@ namespace Cicm.Database } } + /// + /// Gets GPU by specified id + /// + /// Id + /// GPU with specified id, null if not found or error public Gpu GetGpu(int id) { #if DEBUG @@ -126,6 +144,10 @@ namespace Cicm.Database } } + /// + /// Counts the number of GPUs in the database + /// + /// Entries in database public long CountGpus() { #if DEBUG @@ -140,6 +162,12 @@ namespace Cicm.Database catch { return 0; } } + /// + /// Adds a new GPU to the database + /// + /// Entry to add + /// ID of added entry + /// true if added correctly, false otherwise public bool AddGpu(Gpu entry, out long id) { #if DEBUG @@ -167,6 +195,11 @@ namespace Cicm.Database return true; } + /// + /// Updated a GPU in the database + /// + /// Updated entry + /// true if updated correctly, false otherwise public bool UpdateGpu(Gpu entry) { #if DEBUG @@ -188,6 +221,11 @@ namespace Cicm.Database return true; } + /// + /// Removes a GPU from the database + /// + /// ID of entry to remove + /// true if removed correctly, false otherwise public bool RemoveGpu(long id) { #if DEBUG diff --git a/Cicm.Database/Operations/Init.cs b/Cicm.Database/Operations/Init.cs index 4718a7b9..2bf8ffed 100644 --- a/Cicm.Database/Operations/Init.cs +++ b/Cicm.Database/Operations/Init.cs @@ -27,6 +27,7 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + using System; using System.Data; using Cicm.Database.Schemas.Sql; @@ -35,6 +36,10 @@ namespace Cicm.Database { public partial class Operations { + /// + /// Initializes tables in the database + /// + /// true if initialized correctly, false otherwise public bool InitializeNewDatabase() { Console.WriteLine("Creating new database version {0}", DB_VERSION); diff --git a/Cicm.Database/Operations/Log.cs b/Cicm.Database/Operations/Log.cs index d0d10710..9899a1e2 100644 --- a/Cicm.Database/Operations/Log.cs +++ b/Cicm.Database/Operations/Log.cs @@ -27,6 +27,7 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + using System; using System.Collections.Generic; using System.Data; @@ -37,6 +38,11 @@ namespace Cicm.Database { public partial class Operations { + /// + /// Gets all log entries + /// + /// All log entries + /// true if is correct, false otherwise public bool GetLogs(out List entries) { #if DEBUG @@ -67,6 +73,13 @@ namespace Cicm.Database } } + /// + /// Gets the specified number of log entries since the specified start + /// + /// List of log entries + /// Start of query + /// How many entries to retrieve + /// true if is correct, false otherwise public bool GetLogs(out List entries, ulong start, ulong count) { #if DEBUG @@ -97,6 +110,11 @@ namespace Cicm.Database } } + /// + /// Gets log entry by specified id + /// + /// Id + /// Log entry with specified id, null if not found or error public Log GetLog(int id) { #if DEBUG @@ -126,6 +144,10 @@ namespace Cicm.Database } } + /// + /// Counts the number of log entries in the database + /// + /// Entries in database public long CountLogs() { #if DEBUG @@ -140,6 +162,12 @@ namespace Cicm.Database catch { return 0; } } + /// + /// Adds a new access log entry to the database + /// + /// Entry to add + /// ID of added entry + /// true if added correctly, false otherwise public bool AddLog(Log entry, out long id) { #if DEBUG @@ -168,6 +196,11 @@ namespace Cicm.Database return true; } + /// + /// Updated an access log in the database + /// + /// Updated entry + /// true if updated correctly, false otherwise public bool UpdateLog(Log entry) { #if DEBUG @@ -190,6 +223,11 @@ namespace Cicm.Database return true; } + /// + /// Removes an access log entry from the database + /// + /// ID of entry to remove + /// true if removed correctly, false otherwise public bool RemoveLog(long id) { #if DEBUG diff --git a/Cicm.Database/Operations/MoneyDonation.cs b/Cicm.Database/Operations/MoneyDonation.cs index 716f0b46..56231a1d 100644 --- a/Cicm.Database/Operations/MoneyDonation.cs +++ b/Cicm.Database/Operations/MoneyDonation.cs @@ -27,6 +27,7 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + using System; using System.Collections.Generic; using System.Data; @@ -37,6 +38,11 @@ namespace Cicm.Database { public partial class Operations { + /// + /// Gets all money donations + /// + /// All money donations + /// true if is correct, false otherwise public bool GetMoneyDonations(out List entries) { #if DEBUG @@ -67,6 +73,13 @@ namespace Cicm.Database } } + /// + /// Gets the specified number of money donations since the specified start + /// + /// List of money donations + /// Start of query + /// How many entries to retrieve + /// true if is correct, false otherwise public bool GetMoneyDonations(out List entries, ulong start, ulong count) { #if DEBUG @@ -97,6 +110,11 @@ namespace Cicm.Database } } + /// + /// Gets money donation by specified id + /// + /// Id + /// Money donation with specified id, null if not found or error public MoneyDonation GetMoneyDonation(int id) { #if DEBUG @@ -126,6 +144,10 @@ namespace Cicm.Database } } + /// + /// Counts the number of money donations in the database + /// + /// Entries in database public long CountMoneyDonations() { #if DEBUG @@ -140,6 +162,12 @@ namespace Cicm.Database catch { return 0; } } + /// + /// Adds a new money donation to the database + /// + /// Entry to add + /// ID of added entry + /// true if added correctly, false otherwise public bool AddMoneyDonation(MoneyDonation entry, out long id) { #if DEBUG @@ -167,6 +195,11 @@ namespace Cicm.Database return true; } + /// + /// Updated a money donation in the database + /// + /// Updated entry + /// true if updated correctly, false otherwise public bool UpdateMoneyDonation(MoneyDonation entry) { #if DEBUG @@ -189,6 +222,11 @@ namespace Cicm.Database return true; } + /// + /// Removes a money donation from the database + /// + /// ID of entry to remove + /// true if removed correctly, false otherwise public bool RemoveMoneyDonation(long id) { #if DEBUG diff --git a/Cicm.Database/Operations/Mpu.cs b/Cicm.Database/Operations/Mpu.cs index 74d4da79..b1dd19cf 100644 --- a/Cicm.Database/Operations/Mpu.cs +++ b/Cicm.Database/Operations/Mpu.cs @@ -27,6 +27,7 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + using System; using System.Collections.Generic; using System.Data; @@ -37,6 +38,11 @@ namespace Cicm.Database { public partial class Operations { + /// + /// Gets all MPUs + /// + /// All MPUs + /// true if is correct, false otherwise public bool GetMpus(out List entries) { #if DEBUG @@ -67,6 +73,13 @@ namespace Cicm.Database } } + /// + /// Gets the specified number of MPUs since the specified start + /// + /// List of MPUs + /// Start of query + /// How many entries to retrieve + /// true if is correct, false otherwise public bool GetMpus(out List entries, ulong start, ulong count) { #if DEBUG @@ -97,6 +110,11 @@ namespace Cicm.Database } } + /// + /// Gets MPU by specified id + /// + /// Id + /// MPU with specified id, null if not found or error public Mpu GetMpu(int id) { #if DEBUG @@ -126,6 +144,10 @@ namespace Cicm.Database } } + /// + /// Counts the number of MPUs in the database + /// + /// Entries in database public long CountMpus() { #if DEBUG @@ -140,6 +162,12 @@ namespace Cicm.Database catch { return 0; } } + /// + /// Adds a new MPU to the database + /// + /// Entry to add + /// ID of added entry + /// true if added correctly, false otherwise public bool AddMpu(Mpu entry, out long id) { #if DEBUG @@ -167,6 +195,11 @@ namespace Cicm.Database return true; } + /// + /// Updated an MPU in the database + /// + /// Updated entry + /// true if updated correctly, false otherwise public bool UpdateMpu(Mpu entry) { #if DEBUG diff --git a/Cicm.Database/Operations/News.cs b/Cicm.Database/Operations/News.cs index 8fca7f62..c550e747 100644 --- a/Cicm.Database/Operations/News.cs +++ b/Cicm.Database/Operations/News.cs @@ -27,6 +27,7 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + using System; using System.Collections.Generic; using System.Data; @@ -37,6 +38,11 @@ namespace Cicm.Database { public partial class Operations { + /// + /// Gets all site news + /// + /// All site news + /// true if is correct, false otherwise public bool GetNews(out List entries) { #if DEBUG @@ -67,6 +73,13 @@ namespace Cicm.Database } } + /// + /// Gets the specified number of site news since the specified start + /// + /// List of site news + /// Start of query + /// How many entries to retrieve + /// true if is correct, false otherwise public bool GetNews(out List entries, ulong start, ulong count) { #if DEBUG @@ -97,6 +110,11 @@ namespace Cicm.Database } } + /// + /// Gets site news by specified id + /// + /// Id + /// Site news with specified id, null if not found or error public News GetNews(int id) { #if DEBUG @@ -126,6 +144,10 @@ namespace Cicm.Database } } + /// + /// Counts the number of site news in the database + /// + /// Entries in database public long CountNews() { #if DEBUG @@ -140,6 +162,12 @@ namespace Cicm.Database catch { return 0; } } + /// + /// Adds a new site news to the database + /// + /// Entry to add + /// ID of added entry + /// true if added correctly, false otherwise public bool AddNews(News entry, out long id) { #if DEBUG @@ -167,6 +195,11 @@ namespace Cicm.Database return true; } + /// + /// Updated a site news in the database + /// + /// Updated entry + /// true if updated correctly, false otherwise public bool UpdateNews(News entry) { #if DEBUG @@ -188,6 +221,11 @@ namespace Cicm.Database return true; } + /// + /// Removes a site news entry from the database + /// + /// ID of entry to remove + /// true if removed correctly, false otherwise public bool RemoveNews(long id) { #if DEBUG diff --git a/Cicm.Database/Operations/Operations.cs b/Cicm.Database/Operations/Operations.cs index 6afd9c5e..9c9ca768 100644 --- a/Cicm.Database/Operations/Operations.cs +++ b/Cicm.Database/Operations/Operations.cs @@ -27,12 +27,14 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + using System.Data; namespace Cicm.Database { public partial class Operations { + /// Last known database version const int DB_VERSION = 2; readonly IDbConnection dbCon; diff --git a/Cicm.Database/Operations/OwnComputer.cs b/Cicm.Database/Operations/OwnComputer.cs index 8cc69925..77f5a1c2 100644 --- a/Cicm.Database/Operations/OwnComputer.cs +++ b/Cicm.Database/Operations/OwnComputer.cs @@ -27,6 +27,7 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + using System; using System.Collections.Generic; using System.Data; @@ -37,6 +38,11 @@ namespace Cicm.Database { public partial class Operations { + /// + /// Gets all owned computers + /// + /// All owned computers + /// true if is correct, false otherwise public bool GetOwnOwnComputers(out List entries) { #if DEBUG @@ -67,6 +73,13 @@ namespace Cicm.Database } } + /// + /// Gets the specified number of owned computers since the specified start + /// + /// List of owned computers + /// Start of query + /// How many entries to retrieve + /// true if is correct, false otherwise public bool GetOwnOwnComputers(out List entries, ulong start, ulong count) { #if DEBUG @@ -97,6 +110,11 @@ namespace Cicm.Database } } + /// + /// Gets owned computer by specified id + /// + /// Id + /// Owned computer with specified id, null if not found or error public OwnComputer GetOwnComputer(int id) { #if DEBUG @@ -126,6 +144,10 @@ namespace Cicm.Database } } + /// + /// Counts the number of owned computers in the database + /// + /// Entries in database public long CountOwnOwnComputers() { #if DEBUG @@ -140,6 +162,12 @@ namespace Cicm.Database catch { return 0; } } + /// + /// Adds a new owned computer to the database + /// + /// Entry to add + /// ID of added entry + /// true if added correctly, false otherwise public bool AddOwnComputer(OwnComputer entry, out long id) { #if DEBUG @@ -169,6 +197,11 @@ namespace Cicm.Database return true; } + /// + /// Updated an owned computer in the database + /// + /// Updated entry + /// true if updated correctly, false otherwise public bool UpdateOwnComputer(OwnComputer entry) { #if DEBUG @@ -193,6 +226,11 @@ namespace Cicm.Database return true; } + /// + /// Removes an owned computer from the database + /// + /// ID of entry to remove + /// true if removed correctly, false otherwise public bool RemoveOwnComputer(long id) { #if DEBUG diff --git a/Cicm.Database/Operations/OwnConsole.cs b/Cicm.Database/Operations/OwnConsole.cs index e49b2468..9eda9c77 100644 --- a/Cicm.Database/Operations/OwnConsole.cs +++ b/Cicm.Database/Operations/OwnConsole.cs @@ -27,6 +27,7 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + using System; using System.Collections.Generic; using System.Data; @@ -37,6 +38,11 @@ namespace Cicm.Database { public partial class Operations { + /// + /// Gets all owned consoles + /// + /// All owned consoles + /// true if is correct, false otherwise public bool GetOwnOwnConsoles(out List entries) { #if DEBUG @@ -67,6 +73,13 @@ namespace Cicm.Database } } + /// + /// Gets the specified number of owned consoles since the specified start + /// + /// List of owned consoles + /// Start of query + /// How many entries to retrieve + /// true if is correct, false otherwise public bool GetOwnOwnConsoles(out List entries, ulong start, ulong count) { #if DEBUG @@ -97,6 +110,11 @@ namespace Cicm.Database } } + /// + /// Gets owned console by specified id + /// + /// Id + /// Owned console with specified id, null if not found or error public OwnConsole GetOwnConsole(int id) { #if DEBUG @@ -126,6 +144,10 @@ namespace Cicm.Database } } + /// + /// Counts the number of owned consoles in the database + /// + /// Entries in database public long CountOwnOwnConsoles() { #if DEBUG @@ -140,6 +162,12 @@ namespace Cicm.Database catch { return 0; } } + /// + /// Adds a new owned console to the database + /// + /// Entry to add + /// ID of added entry + /// true if added correctly, false otherwise public bool AddOwnConsole(OwnConsole entry, out long id) { #if DEBUG @@ -168,6 +196,11 @@ namespace Cicm.Database return true; } + /// + /// Updated an owned console in the database + /// + /// Updated entry + /// true if updated correctly, false otherwise public bool UpdateOwnConsole(OwnConsole entry) { #if DEBUG @@ -191,6 +224,11 @@ namespace Cicm.Database return true; } + /// + /// Removes an owned console from the database + /// + /// ID of entry to remove + /// true if removed correctly, false otherwise public bool RemoveOwnConsole(long id) { #if DEBUG diff --git a/Cicm.Database/Operations/Update.cs b/Cicm.Database/Operations/Update.cs index 4fb9ab28..13b05dd5 100644 --- a/Cicm.Database/Operations/Update.cs +++ b/Cicm.Database/Operations/Update.cs @@ -27,10 +27,15 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + namespace Cicm.Database { public partial class Operations { + /// + /// Updates opened database to last known version + /// + /// true if updated correctly, false otherwise public bool UpdateDatabase() { // Do nothing diff --git a/Cicm.Database/Schemas/Admin.cs b/Cicm.Database/Schemas/Admin.cs index f91ac3bc..f75a55b0 100644 --- a/Cicm.Database/Schemas/Admin.cs +++ b/Cicm.Database/Schemas/Admin.cs @@ -27,12 +27,17 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + namespace Cicm.Database.Schemas { + /// Site administrator public class Admin { - public int id; + /// ID + public int id; + /// Hashed password public string password; + /// Username public string user; } } \ No newline at end of file diff --git a/Cicm.Database/Schemas/BrowserTest.cs b/Cicm.Database/Schemas/BrowserTest.cs index a00e43de..fc698291 100644 --- a/Cicm.Database/Schemas/BrowserTest.cs +++ b/Cicm.Database/Schemas/BrowserTest.cs @@ -27,26 +27,45 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + namespace Cicm.Database.Schemas { + /// Browser test public class BrowserTest { - public ushort id; - public string idstring; - public string browser; - public string version; - public string os; - public string platform; - public bool gif87; - public bool gif89; - public bool jpeg; - public bool png; - public bool pngt; + /// Supports animated GIF public bool agif; - public bool table; + /// Browser name + public string browser; + /// Supports colors public bool colors; - public bool js; - public bool frames; + /// Supports Adobe Flash public bool flash; + /// Supports IFRAMEs + public bool frames; + /// Supports GIF87 + public bool gif87; + /// Supports GIF with transparency (GIF89) + public bool gif89; + /// ID + public ushort id; + /// User agent string + public string idstring; + /// Supports JPEG + public bool jpeg; + /// Supports JavaScript + public bool js; + /// Browser operating system + public string os; + /// Browser architecture + public string platform; + /// Supports PNG + public bool png; + /// Supports PNG with alpha channel + public bool pngt; + /// Supports HTML tables + public bool table; + /// Browser version + public string version; } } \ No newline at end of file diff --git a/Cicm.Database/Schemas/Company.cs b/Cicm.Database/Schemas/Company.cs index 2d3b2e0e..5a6b7502 100644 --- a/Cicm.Database/Schemas/Company.cs +++ b/Cicm.Database/Schemas/Company.cs @@ -27,11 +27,15 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + namespace Cicm.Database.Schemas { + /// Company public class Company { - public int id; + /// Name public string Compania; + /// ID + public int id; } } \ No newline at end of file diff --git a/Cicm.Database/Schemas/Computer.cs b/Cicm.Database/Schemas/Computer.cs index 4a9398b9..49ba4148 100644 --- a/Cicm.Database/Schemas/Computer.cs +++ b/Cicm.Database/Schemas/Computer.cs @@ -27,36 +27,65 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + namespace Cicm.Database.Schemas { + /// Computer public class Computer { - public int id; - public int company; - public int year; - public string model; - public int cpu1; - public float mhz1; - public int cpu2; - public float mhz2; + /// Bits of GPRs of primary CPU public int bits; - public int ram; - public int rom; - public int gpu; - public int vram; - public int colors; - public string res; - public int spu; - public int mpu; - public int sound_channels; - public int music_channels; - public int hdd1; - public int hdd2; - public int hdd3; - public int disk1; + /// Capacity of first removable disk format public string cap1; - public int disk2; + /// Capacity of second removable disk format public string cap2; + /// Maximum colors on screen + public int colors; + /// Free-form comments public string comment; + /// Manufacturer's company ID + public int company; + /// Primary CPU + public int cpu1; + /// Secondary CPU + public int cpu2; + /// ID of first removable disk format + public int disk1; + /// ID of second removable disk format + public int disk2; + /// ID of GPU + public int gpu; + /// ID of first hard disk format + public int hdd1; + /// ID of second hard disk format + public int hdd2; + /// ID of third hard disk format + public int hdd3; + /// ID + public int id; + /// Frequency in MHz of primary CPU + public float mhz1; + /// Frequency in MHz of secondary CPU + public float mhz2; + /// Model name + public string model; + /// ID of MPU + public int mpu; + /// Audio channels supported by the MPU + public int music_channels; + /// Size in kibibytes of program RAM + public int ram; + /// Resolution in WxH pixels + public string res; + /// Size in kibibytes of firmware + public int rom; + /// Audio channels supported by the DSP + public int sound_channels; + /// ID of DSP + public int spu; + /// Size in kibibytes for video RAM + public int vram; + /// Introduction date, 0 if unknown + public int year; } } \ No newline at end of file diff --git a/Cicm.Database/Schemas/Console.cs b/Cicm.Database/Schemas/Console.cs index bea88027..97383883 100644 --- a/Cicm.Database/Schemas/Console.cs +++ b/Cicm.Database/Schemas/Console.cs @@ -27,32 +27,56 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + namespace Cicm.Database.Schemas { public class Console { - public int id; - public int company; - public string name; - public int year; - public int cpu1; - public float mhz1; - public int cpu2; - public float mhz2; + /// Bits of GPRs of primary CPU public int bits; - public int ram; - public int rom; - public int gpu; - public int vram; - public string res; - public int colors; - public int palette; - public int spu; - public int schannels; - public int mpu; - public int mchannels; - public int format; + /// Capacity in kibibytes of storage format public int cap; + /// Maximum colors on screen + public int colors; + /// Free-form comments public string comments; + /// Manufacturer's company ID + public int company; + /// Primary CPU + public int cpu1; + /// Secondary CPU + public int cpu2; + /// ID of storage format + public int format; + /// ID of GPU + public int gpu; + /// ID + public int id; + /// Audio channels supported by the MPU + public int mchannels; + /// Frequency in MHz of primary CPU + public float mhz1; + /// Frequency in MHz of secondary CPU + public float mhz2; + /// ID of MPU + public int mpu; + /// Model name + public string name; + /// Colors on palette + public int palette; + /// Size in kibibytes of program RAM + public int ram; + /// Resolution in WxH pixels + public string res; + /// Size in kibibytes of firmware + public int rom; + /// Audio channels supported by the DSP + public int schannels; + /// ID of DSP + public int spu; + /// Size in kibibytes for video RAM + public int vram; + /// Introduction date, 0 if unknown + public int year; } } \ No newline at end of file diff --git a/Cicm.Database/Schemas/ConsoleCompany.cs b/Cicm.Database/Schemas/ConsoleCompany.cs index 85d8ff2c..4de2e722 100644 --- a/Cicm.Database/Schemas/ConsoleCompany.cs +++ b/Cicm.Database/Schemas/ConsoleCompany.cs @@ -27,11 +27,17 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + namespace Cicm.Database.Schemas { + /// + /// Videogame console manufacturing company + /// public class ConsoleCompany { - public int id; + /// Name public string company; + /// ID + public int id; } } \ No newline at end of file diff --git a/Cicm.Database/Schemas/Cpu.cs b/Cicm.Database/Schemas/Cpu.cs index 02670555..8fed45c7 100644 --- a/Cicm.Database/Schemas/Cpu.cs +++ b/Cicm.Database/Schemas/Cpu.cs @@ -27,11 +27,15 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + namespace Cicm.Database.Schemas { + /// Central Processing Unit public class Cpu { - public int id; + /// Name public string cpu; + /// ID + public int id; } } \ No newline at end of file diff --git a/Cicm.Database/Schemas/DiskFormat.cs b/Cicm.Database/Schemas/DiskFormat.cs index 6e4db611..ee9b2541 100644 --- a/Cicm.Database/Schemas/DiskFormat.cs +++ b/Cicm.Database/Schemas/DiskFormat.cs @@ -27,11 +27,15 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + namespace Cicm.Database.Schemas { + /// Storage format public class DiskFormat { - public int id; + /// Description public string Format; + /// ID + public int id; } } \ No newline at end of file diff --git a/Cicm.Database/Schemas/Dsp.cs b/Cicm.Database/Schemas/Dsp.cs index 56d3a940..fc5f7320 100644 --- a/Cicm.Database/Schemas/Dsp.cs +++ b/Cicm.Database/Schemas/Dsp.cs @@ -7,7 +7,7 @@ // // --[ Description ] ---------------------------------------------------------- // -// High level representation of a DSP (Digital Signal Processor). +// High level representation of a DSP (Digital Sound Processor). // // --[ License ] -------------------------------------------------------------- // @@ -27,11 +27,15 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + namespace Cicm.Database.Schemas { + /// Digital Sound Processor public class Dsp { - public int id; + /// Name public string DSP; + /// ID + public int id; } } \ No newline at end of file diff --git a/Cicm.Database/Schemas/Forbidden.cs b/Cicm.Database/Schemas/Forbidden.cs index 484f46fd..4d63e46b 100644 --- a/Cicm.Database/Schemas/Forbidden.cs +++ b/Cicm.Database/Schemas/Forbidden.cs @@ -27,14 +27,21 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + namespace Cicm.Database.Schemas { + /// Accesses forbidden with HTTP STATUS 403 public class Forbidden { - public int id; + /// User agent public string browser; + /// Date of access public string date; + /// ID + public int id; + /// Access IP public string ip; + /// Referer public string referer; } } \ No newline at end of file diff --git a/Cicm.Database/Schemas/Gpu.cs b/Cicm.Database/Schemas/Gpu.cs index fe043673..acedc736 100644 --- a/Cicm.Database/Schemas/Gpu.cs +++ b/Cicm.Database/Schemas/Gpu.cs @@ -27,11 +27,15 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + namespace Cicm.Database.Schemas { + /// Graphics Processing Unit public class Gpu { - public int id; + /// Name public string gpu; + /// ID + public int id; } } \ No newline at end of file diff --git a/Cicm.Database/Schemas/Log.cs b/Cicm.Database/Schemas/Log.cs index 42eeeaff..9de14404 100644 --- a/Cicm.Database/Schemas/Log.cs +++ b/Cicm.Database/Schemas/Log.cs @@ -27,14 +27,23 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + namespace Cicm.Database.Schemas { + /// + /// Access log + /// public class Log { - public int id; + /// User agent string public string browser; - public string ip; + /// Access date public string date; + /// ID + public int id; + /// Access IP + public string ip; + /// Referer public string referer; } } \ No newline at end of file diff --git a/Cicm.Database/Schemas/MoneyDonation.cs b/Cicm.Database/Schemas/MoneyDonation.cs index e1b09cce..75e715f4 100644 --- a/Cicm.Database/Schemas/MoneyDonation.cs +++ b/Cicm.Database/Schemas/MoneyDonation.cs @@ -27,12 +27,17 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + namespace Cicm.Database.Schemas { + /// Money donations public class MoneyDonation { - public int id; + /// Donator public string donator; + /// ID + public int id; + /// Donation quantity in euros public float quantity; } } \ No newline at end of file diff --git a/Cicm.Database/Schemas/Mpu.cs b/Cicm.Database/Schemas/Mpu.cs index 0885d5bb..c51a2a07 100644 --- a/Cicm.Database/Schemas/Mpu.cs +++ b/Cicm.Database/Schemas/Mpu.cs @@ -27,11 +27,15 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + namespace Cicm.Database.Schemas { + /// Music Processing Unit public class Mpu { + /// ID public int id; + /// Name public string mpu; } } \ No newline at end of file diff --git a/Cicm.Database/Schemas/News.cs b/Cicm.Database/Schemas/News.cs index 5767be34..c21bfbfe 100644 --- a/Cicm.Database/Schemas/News.cs +++ b/Cicm.Database/Schemas/News.cs @@ -27,13 +27,19 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + namespace Cicm.Database.Schemas { + /// Site news public class News { - public int id; - public string date; - public int type; + /// Affected ID public int added_id; + /// Date + public string date; + /// ID + public int id; + /// News type + public int type; } } \ No newline at end of file diff --git a/Cicm.Database/Schemas/OwnComputer.cs b/Cicm.Database/Schemas/OwnComputer.cs index 89204e5d..3dcd2142 100644 --- a/Cicm.Database/Schemas/OwnComputer.cs +++ b/Cicm.Database/Schemas/OwnComputer.cs @@ -27,27 +27,47 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + namespace Cicm.Database.Schemas { + /// Owned computer public class OwnComputer { - public int id; - public int db_id; - public string date; - public int status; - public bool trade; + /// Box present in collection public bool boxed; - public bool manuals; - public int cpu1; - public float mhz1; - public int cpu2; - public float mhz2; - public int ram; - public int vram; - public string rigid; - public int disk1; + /// Capacity of first removable disk format public int cap1; - public int disk2; + /// Capacity of second removable disk format public int cap2; + /// Primary CPU + public int cpu1; + /// Secondary CPU + public int cpu2; + /// Adquired date + public string date; + /// Computer's ID + public int db_id; + /// ID of first removable disk format + public int disk1; + /// ID of second removable disk format + public int disk2; + /// ID + public int id; + /// Original manuals present in collection + public bool manuals; + /// Frequency in MHz of primary CPU + public float mhz1; + /// Frequency in MHz of secondary CPU + public float mhz2; + /// Size in kibibytes of program RAM + public int ram; + /// Rigid disk + public string rigid; + /// Status + public int status; + /// Available for trade + public bool trade; + /// Size in kibibytes for video RAM + public int vram; } } \ No newline at end of file diff --git a/Cicm.Database/Schemas/OwnConsole.cs b/Cicm.Database/Schemas/OwnConsole.cs index d5c71692..ba7520c0 100644 --- a/Cicm.Database/Schemas/OwnConsole.cs +++ b/Cicm.Database/Schemas/OwnConsole.cs @@ -27,16 +27,25 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + namespace Cicm.Database.Schemas { + /// Owned videogame console public class OwnConsole { - public int id; - public int db_id; - public string date; - public int status; - public bool trade; + /// Box present in collection public bool boxed; + /// Adquired date + public string date; + /// Videogame console's ID + public int db_id; + /// ID + public int id; + /// Original manuals present in collection public bool manuals; + /// Status + public int status; + /// Available for trade + public bool trade; } } \ No newline at end of file diff --git a/Cicm.Database/Schemas/Sql/V2.cs b/Cicm.Database/Schemas/Sql/V2.cs index eff740a4..444f9e6f 100644 --- a/Cicm.Database/Schemas/Sql/V2.cs +++ b/Cicm.Database/Schemas/Sql/V2.cs @@ -27,6 +27,7 @@ // ---------------------------------------------------------------------------- // Copyright © 2003-2018 Natalia Portillo *******************************************************************************/ + namespace Cicm.Database.Schemas.Sql { public static class V2