fix all warnings, add more docs

Author: Zechiax

Modrinth.Net/Extensions/EnumerableExtensions.cs

@@ -2,8 +2,18 @@
 
 namespace Modrinth.Extensions;
 
+/// <summary>
+///     Extensions for <see cref="IEnumerable{T}" />
+/// </summary>
 public static class EnumerableExtensions
 {
+    /// <summary>
+    ///     Converts an <see cref="IEnumerable{T}" /> to a query string for Modrinth
+    ///     <para> It needs to be in format like this: ["AABBCCDD", "EEFFGGHH"] </para>
+    /// </summary>
+    /// <param name="items"></param>
+    /// <typeparam name="T"></typeparam>
+    /// <returns></returns>
     public static string ToModrinthQueryString<T>(this IEnumerable<T> items)
     {
         // It needs to be in format like this: ["AABBCCDD", "EEFFGGHH"]

Modrinth.Net/Extensions/ProjectExtensions.cs

@@ -3,6 +3,9 @@
 
 namespace Modrinth.Extensions;
 
+/// <summary>
+///     Extensions for <see cref="Project" />
+/// </summary>
 public static class ProjectExtensions
 {
     /// <summary>

Modrinth.Net/Extensions/ProjectTypeExtensions.cs

@@ -2,6 +2,9 @@
 
 namespace Modrinth.Extensions;
 
+/// <summary>
+///     Extensions for <see cref="ProjectType" />
+/// </summary>
 public static class ProjectTypeExtensions
 {
     /// <summary>

Modrinth.Net/Extensions/StringExtensions.cs

@@ -1,13 +1,19 @@
 namespace Modrinth.Extensions;
 
+/// <summary>
+///     Extensions for <see cref="string" />
+/// </summary>
 public static class StringExtensions
 {
     /// <summary>
-    ///     Add text in quotes if text contains specific char
+    ///     Escapes the specified input string with double quotes if it contains the specified character.
     /// </summary>
-    /// <param name="text"></param>
-    /// <param name="contains">The char to check if the text contains</param>
-    /// <returns></returns>
+    /// <param name="text">The input string to check for the specified character.</param>
+    /// <param name="contains">The character to check if it is contained in the input string. Defaults to a space character.</param>
+    /// <returns>
+    ///     The input string enclosed within double quotes if it contains the specified character;
+    ///     otherwise, the input string as is.
+    /// </returns>
     public static string EscapeIfContains(this string text, char contains = ' ')
     {
         return !string.IsNullOrEmpty(text) && text.Contains(contains) ? string.Concat('"', text, '"') : text;

Modrinth.Net/Extensions/VersionExtensions.cs

@@ -3,6 +3,9 @@
 
 namespace Modrinth.Extensions;
 
+/// <summary>
+///     Extensions for <see cref="Models.Version" />
+/// </summary>
 public static class VersionExtensions
 {
     /// <summary>

Modrinth.Net/Facet.cs

@@ -3,6 +3,9 @@
 
 namespace Modrinth;
 
+/// <summary>
+///     A facet for the filtering of results
+/// </summary>
 public abstract class Facet
 {
     /// <summary>
@@ -46,17 +49,32 @@ public static Facet<string> ProjectType(ProjectType projectType)
     }
 }
 
+/// <summary>
+///     A facet for the filtering of results, with a specific type
+/// </summary>
+/// <typeparam name="T"></typeparam>
 public class Facet<T> : Facet
 {
-    public Facet(FacetType type, T value)
+    internal Facet(FacetType type, T value)
     {
         Type = type;
         Value = value;
     }
 
+    /// <summary>
+    ///     The type of the facet
+    /// </summary>
     public FacetType Type { get; }
+
+    /// <summary>
+    ///     The value of the facet
+    /// </summary>
     public T Value { get; }
 
+    /// <summary>
+    ///     Returns a string representation of the facet, so that it is usable in API requests
+    /// </summary>
+    /// <returns></returns>
     public override string ToString()
     {
         return Type switch
@@ -70,10 +88,28 @@ public override string ToString()
     }
 }
 
+/// <summary>
+///     The type of a facet
+/// </summary>
 public enum FacetType
 {
+    /// <summary>
+    ///     The facet is for filtering by category
+    /// </summary>
     Categories,
+
+    /// <summary>
+    ///     The facet is for filtering by Minecraft version
+    /// </summary>
     Versions,
+
+    /// <summary>
+    ///     The facet is for filtering by license
+    /// </summary>
     License,
+
+    /// <summary>
+    ///     The facet is for filtering by project type
+    /// </summary>
     ProjectType
 }

Modrinth.Net/Http/Requester.cs

@@ -22,6 +22,11 @@ public class Requester : IRequester
         }
     };
 
+    /// <summary>
+    ///     Creates a new <see cref="Requester" /> with the specified <see cref="ModrinthClientConfig" />
+    /// </summary>
+    /// <param name="config"> The config to use </param>
+    /// <param name="httpClient"> The <see cref="HttpClient" /> to use, if null a new one will be created </param>
     public Requester(ModrinthClientConfig config, HttpClient? httpClient = null)
     {
         _config = config;

Modrinth.Net/Models/Enums/Version/DependencyType.cs

@@ -1,5 +1,8 @@
 namespace Modrinth.Models.Enums.Version;
 
+/// <summary>
+///     The type of a dependency
+/// </summary>
 public enum DependencyType
 {
     /// <summary>

Modrinth.Net/Models/Enums/Version/VersionRequestedStatus.cs

@@ -1,9 +1,27 @@
 namespace Modrinth.Models.Enums.Version;
 
+/// <summary>
+///     The requested status of a version
+/// </summary>
 public enum VersionRequestedStatus
 {
+    /// <summary>
+    ///     The version is requested to be listed
+    /// </summary>
     Listed,
+
+    /// <summary>
+    ///     The version is requested to be archived
+    /// </summary>
     Archived,
+
+    /// <summary>
+    ///     The version is requested to be in a draft
+    /// </summary>
     Draft,
+
+    /// <summary>
+    ///     The version is requested to be unlisted
+    /// </summary>
     Unlisted
 }

Modrinth.Net/Models/Enums/Version/VersionStatus.cs

@@ -1,11 +1,37 @@
 namespace Modrinth.Models.Enums.Version;
 
+/// <summary>
+///     The status of a version
+/// </summary>
 public enum VersionStatus
 {
+    /// <summary>
+    ///     The version is listed
+    /// </summary>
     Listed,
+
+    /// <summary>
+    ///     The version is archived
+    /// </summary>
     Archived,
+
+    /// <summary>
+    ///     The version is in a draft
+    /// </summary>
     Draft,
+
+    /// <summary>
+    ///     The version is unlisted
+    /// </summary>
     Unlisted,
+
+    /// <summary>
+    ///     The version is scheduled for release
+    /// </summary>
     Scheduled,
+
+    /// <summary>
+    ///     The version status is unknown
+    /// </summary>
     Unknown
 }

Modrinth.Net/Models/File.cs

@@ -4,6 +4,9 @@
 #pragma warning disable CS8618
 namespace Modrinth.Models;
 
+/// <summary>
+///     A file of a project version
+/// </summary>
 public class File
 {
     /// <summary>
@@ -21,6 +24,9 @@ public class File
     /// </summary>
     public string FileName { get; set; }
 
+    /// <summary>
+    ///     Whether the file is the primary file of the version
+    /// </summary>
     public bool Primary { get; set; }
 
     /// <summary>

Modrinth.Net/Models/Notification.cs

@@ -1,6 +1,7 @@
 using System.Text.Json.Serialization;
 using Modrinth.Models.Enums;
 
+#pragma warning disable CS8618
 namespace Modrinth.Models;
 
 /// <summary>

Modrinth.Net/Models/PayoutData.cs

@@ -1,6 +1,7 @@
 using System.Text.Json.Serialization;
 using Modrinth.Models.Enums;
 
+#pragma warning disable CS8618
 namespace Modrinth.Models;
 
 /// <summary>

Modrinth.Net/Models/Version.cs

@@ -70,7 +70,11 @@ public class Version
     [JsonPropertyName("author_id")]
     public string AuthorId { get; set; }
 
-    [JsonPropertyName("date_published")] public DateTime DatePublished { get; set; }
+    /// <summary>
+    ///     The time at which this version was created
+    /// </summary>
+    [JsonPropertyName("date_published")]
+    public DateTime DatePublished { get; set; }
 
     /// <summary>
     ///     The number of times this version has been downloaded