Add XML documentation.

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
     {
+        /// <summary>
+        ///     Gets all consoles
+        /// </summary>
+        /// <param name="entries">All consoles</param>
+        /// <returns><c>true</c> if <see cref="entries" /> is correct, <c>false</c> otherwise</returns>
         public bool GetConsoles(out List<Console> entries)
         {
             #if DEBUG
@@ -66,6 +72,13 @@ namespace Cicm.Database
             }
         }
 
+        /// <summary>
+        ///     Gets the specified number of videogame consoles since the specified start
+        /// </summary>
+        /// <param name="entries">List of videogame consoles</param>
+        /// <param name="start">Start of query</param>
+        /// <param name="count">How many entries to retrieve</param>
+        /// <returns><c>true</c> if <see cref="entries" /> is correct, <c>false</c> otherwise</returns>
         public bool GetConsoles(out List<Console> entries, ulong start, ulong count)
         {
             #if DEBUG
@@ -96,6 +109,11 @@ namespace Cicm.Database
             }
         }
 
+        /// <summary>
+        ///     Gets videogame console by specified id
+        /// </summary>
+        /// <param name="id">Id</param>
+        /// <returns>Videogame console with specified id, <c>null</c> if not found or error</returns>
         public Console GetConsole(int id)
         {
             #if DEBUG
@@ -125,6 +143,10 @@ namespace Cicm.Database
             }
         }
 
+        /// <summary>
+        ///     Counts the number of videogame consoles in the database
+        /// </summary>
+        /// <returns>Entries in database</returns>
         public long CountConsoles()
         {
             #if DEBUG
@@ -139,6 +161,12 @@ namespace Cicm.Database
             catch { return 0; }
         }
 
+        /// <summary>
+        ///     Adds a new videogame console to the database
+        /// </summary>
+        /// <param name="entry">Entry to add</param>
+        /// <param name="id">ID of added entry</param>
+        /// <returns><c>true</c> if added correctly, <c>false</c> otherwise</returns>
         public bool AddConsole(Console entry, out long id)
         {
             #if DEBUG
@@ -168,6 +196,11 @@ namespace Cicm.Database
             return true;
         }
 
+        /// <summary>
+        ///     Updated an videogame console in the database
+        /// </summary>
+        /// <param name="entry">Updated entry</param>
+        /// <returns><c>true</c> if updated correctly, <c>false</c> otherwise</returns>
         public bool UpdateConsole(Console entry)
         {
             #if DEBUG
@@ -193,6 +226,11 @@ namespace Cicm.Database
             return true;
         }
 
+        /// <summary>
+        ///     Removes a videogame console from the database
+        /// </summary>
+        /// <param name="id">ID of entry to remove</param>
+        /// <returns><c>true</c> if removed correctly, <c>false</c> otherwise</returns>
         public bool RemoveConsole(long id)
         {
             #if DEBUG