some docs

Author: AnakinRaW

src/AET.SteamAbstraction/AET.SteamAbstraction/Games/SteamAppManifest.cs

@@ -10,46 +10,46 @@ namespace AET.SteamAbstraction.Games;
 /// Manifest representing an installed Steam game.
 /// <para>Equality matching is only performed on the <see cref="Id"/> and <see cref="Library"/> properties.</para>
 /// </summary>
-public class SteamAppManifest : IEquatable<SteamAppManifest>
+public sealed class SteamAppManifest : IEquatable<SteamAppManifest>
 { 
     /// <summary>
-    /// The library where this game is installed.
+    /// Gets the library where this game is installed.
     /// </summary>
     public ISteamLibrary Library { get; }
 
     /// <summary>
-    /// The file of this manifest.
+    /// Gets the file of this manifest.
     /// </summary>
     public IFileInfo ManifestFile { get; }
 
     /// <summary>
-    /// The game's ID.
+    /// Gets the game's ID.
     /// </summary>
     public uint Id { get; }
 
     /// <summary>
-    /// The game's name.
+    /// Gets the game's name.
     /// </summary>
     public string Name { get; }
 
     /// <summary>
-    /// The game's install directory.
+    /// Gets the game's install directory.
     /// </summary>
     public IDirectoryInfo InstallDir { get; }
 
     /// <summary>
-    /// The state of the game when this instance was created.
+    /// Gets the state of the game when this instance was created.
     /// </summary>
     public SteamAppState State { get; }
 
     /// <summary>
-    /// The depots installed with this game. 
+    /// Gets the depots installed with this game. 
     /// </summary>
     /// <remarks>Usually this includes DLCs, language packs and required shared libraries.</remarks>
     public ISet<uint> Depots { get; }
 
     /// <summary>
-    /// Creates a new instance.
+    /// Initializes a new instance of the <see cref="SteamAppManifest"/> class with the specified game information.
     /// </summary>
     /// <param name="library">The library where this game is installed.</param>
     /// <param name="manifestFile">The file of this manifest.</param>
@@ -58,6 +58,11 @@ public class SteamAppManifest : IEquatable<SteamAppManifest>
     /// <param name="installDir">The game's install directory.</param>
     /// <param name="state">The state of the game when this instance was created.</param>
     /// <param name="depots">The depots installed with this game. </param>
+    /// <exception cref="ArgumentNullException">
+    /// <paramref name="library"/> or <paramref name="manifestFile"/> of <paramref name="installDir"/> or
+    /// <paramref name="depots"/> or <paramref name="name"/> is <see langword="null"/>.
+    /// </exception>
+    /// <exception cref="ArgumentException"><paramref name="name"/> is empty.</exception>
     public SteamAppManifest(
         ISteamLibrary library,
         IFileInfo manifestFile, 

src/AET.SteamAbstraction/AET.SteamAbstraction/ISteamWrapper.cs

@@ -21,31 +21,30 @@ public interface ISteamWrapper : IDisposable
     /// </summary>
     bool IsRunning { get; }
 
-
     /// <summary>
-    /// Gets whether a user is logged in. 
+    /// Gets a value indicating whether a user is logged in. 
     /// </summary>
     bool IsUserLoggedIn { get; }
 
     /// <summary>
-    /// Gets whether the current logged-in user has activated the offline mode.
+    /// Gets a value indicating whether the current logged-in user has activated the offline mode.
     /// <see langword="null"/> if Steam is not installed or the status could not be retrieved.
     /// </summary>
     bool? UserWantsOfflineMode { get; }
 
     /// <summary>
-    /// Checks whether a given game is installed.
+    /// Checks whether the specified game is installed.
     /// </summary>
     /// <param name="gameId">The ID of the game.</param>
-    /// <param name="manifest">The manifest of the installed game or <see langword="null"/>.</param>
-    /// <returns><see langword="true"/> is the game is installed; <see langword="false"/> otherwise.</returns>
-    /// <exception cref="SteamException">if Steam is not installed.</exception>
+    /// <param name="manifest">When this method returns, the manifest of the installed game, if the game is installed or <see langword="null"/>.</param>
+    /// <returns><see langword="true"/> if the game is installed; otherwise, <see langword="false"/>.</returns>
+    /// <exception cref="SteamException">Steam is not installed.</exception>
     bool IsGameInstalled(uint gameId, [NotNullWhen(true)] out SteamAppManifest? manifest);
 
     /// <summary>
     /// Starts the Steam client.
     /// </summary>
-    /// <exception cref="SteamException">if Steam is not installed.</exception>
+    /// <exception cref="SteamException">Steam is not installed.</exception>
     void StartSteam();
 
     /// <summary>
@@ -54,7 +53,7 @@ public interface ISteamWrapper : IDisposable
     /// If the user requested Offline mode, the returned task completes when the Steam client is ready to use.
     /// </para>
     /// </summary>
-    /// <param name="startIfNotRunning">When set to <see langword="true"/> Steam will be started if not already running.
+    /// <param name="startIfNotRunning">When set to <see langword="true"/> Steam will be started, if not already running.
     /// When set to <see langword="false"/> Steam must be started manually.</param>
     /// <param name="cancellation">A token that may be canceled to release the resources from waiting
     /// for Steam and complete the returned Task as canceled.</param>

src/AET.SteamAbstraction/AET.SteamAbstraction/Library/ISteamLibrary.cs

@@ -11,27 +11,27 @@ namespace AET.SteamAbstraction.Library;
 public interface ISteamLibrary : IEquatable<ISteamLibrary>
 {
     /// <summary>
-    /// Physical location of the library.
+    /// Gets the location of the library.
     /// </summary>
     IDirectoryInfo LibraryLocation { get; }
 
     /// <summary>
-    /// The 'steamapps' directory.
+    /// Gets the 'steamapps' directory.
     /// </summary>
     IDirectoryInfo SteamAppsLocation { get; }
 
     /// <summary>
-    /// The 'common' directory of the <see cref="SteamAppsLocation"/>
+    /// Gets the 'common' directory of the <see cref="SteamAppsLocation"/>
     /// </summary>
     IDirectoryInfo CommonLocation { get; }
 
     /// <summary>
-    /// The 'workshop' directory of the <see cref="SteamAppsLocation"/>
+    /// Gets the 'workshop' directory of the <see cref="SteamAppsLocation"/>
     /// </summary>
     IDirectoryInfo WorkshopsLocation { get; }
 
     /// <summary>
-    /// The installed game manifests of this library.
+    /// Gets the installed game manifests of this library.
     /// </summary>
     /// <returns>Collection of game manifests.</returns>
     IEnumerable<SteamAppManifest> GetApps();

src/AET.SteamAbstraction/AET.SteamAbstraction/Registry/ISteamRegistry.cs

@@ -9,17 +9,17 @@ namespace AET.SteamAbstraction.Registry;
 internal interface ISteamRegistry : IDisposable
 {
     /// <summary>
-    /// Id of the logged-in user.
+    /// Gets the ID of the logged-in user.
     /// </summary>
     int? ActiveUserId { get; set; }
 
     /// <summary>
-    /// The executable of the Steam client.
+    /// Gets the executable of the Steam client.
     /// </summary>
     IFileInfo? ExecutableFile { get; }
 
     /// <summary>
-    /// The installation directory of the Steam client
+    /// Gets the installation directory of the Steam client
     /// </summary>
     IDirectoryInfo? InstallationDirectory { get; }
 }

src/AET.SteamAbstraction/AET.SteamAbstraction/SteamException.cs

@@ -3,22 +3,31 @@
 namespace AET.SteamAbstraction;
 
 /// <summary>
-/// Exception which gets thrown if anything Steam related failed.
+/// The exception that is thrown if anything Steam related fails.
 /// </summary>
 public class SteamException : Exception
 {
-    /// <inheritdoc/>
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SteamException"/> class.
+    /// </summary>
     public SteamException()
     {
     }
 
-    /// <inheritdoc/>
-    public SteamException(string message) : base(message)
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SteamException"/> class with a specified error message.
+    /// </summary>
+    /// <param name="message">The message that describes the error.</param>
+    public SteamException(string? message) : base(message)
     {
     }
 
-    /// <inheritdoc/>
-    public SteamException(string message, Exception exception) : base(message, exception)
+    /// <summary>
+    /// Initializes a new instance of the <see cref="SteamException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
+    /// </summary>
+    /// <param name="message">The error message that explains the reason for the exception.</param>
+    /// <param name="exception">The exception that is the cause of the current exception, or a null reference if no inner exception is specified.</param>
+    public SteamException(string? message, Exception? exception) : base(message, exception)
     {
     }
 }

src/AET.SteamAbstraction/AET.SteamAbstraction/SteamNotFoundException.cs

@@ -1,6 +1,6 @@
 namespace AET.SteamAbstraction;
 
 /// <summary>
-/// Exception which gets thrown if an installation of Steam was not found.
+/// The exception that is thrown if an installation of Steam is not found.
 /// </summary>
 public sealed class SteamNotFoundException : SteamException;