gsadmin/PSProxmoxVE
1
0
Fork 0
mirror of https://github.com/GoodOlClint/PSProxmoxVE.git synced 2026-08-21 10:16:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add XML doc comments to Core public API and remove CS1591 suppression

Browse Source 
- Add missing XML doc comments to all public types and members in
  PSProxmoxVE.Core (Authentication, Exceptions, Models, Client)
- Remove CS1591 suppression from PSProxmoxVE.Core.csproj
- Build succeeds with 0 warnings

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Clint Branham
2026-03-20 12:21:54 -05:00
parent ffec75b461
commit 14cbff9877
16 changed files with 111 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/PSProxmoxVE.Core/Exceptions/PveVersionException.cs
+15 -1
View File
@@ -3,13 +3,22 @@ using PSProxmoxVE.Core.Authentication;
namespace PSProxmoxVE.Core.Exceptions
{
/// <summary>Exception thrown when the connected Proxmox VE server does not meet the minimum version requirement for an operation</summary>
/// <summary>Exception thrown when the connected Proxmox VE server does not meet the minimum version requirement for an operation.</summary>
public class PveVersionException : Exception
{
/// <summary>The minimum required major version number.</summary>
public int RequiredMajor { get; }
/// <summary>The minimum required minor version number.</summary>
public int RequiredMinor { get; }
/// <summary>The actual server version that did not meet the requirement.</summary>
public PveVersion ActualVersion { get; }
/// <summary>Initializes a new instance for a version requirement that was not met.</summary>
/// <param name="requiredMajor">The minimum required major version.</param>
/// <param name="requiredMinor">The minimum required minor version.</param>
/// <param name="actualVersion">The actual server version detected.</param>
public PveVersionException(int requiredMajor, int requiredMinor, PveVersion actualVersion)
: base($"This operation requires Proxmox VE {requiredMajor}.{requiredMinor} or later. Connected server is version {actualVersion}.")
{
@@ -18,6 +27,11 @@ namespace PSProxmoxVE.Core.Exceptions
ActualVersion = actualVersion;
}
/// <summary>Initializes a new instance for a version requirement that was not met, with an inner exception.</summary>
/// <param name="requiredMajor">The minimum required major version.</param>
/// <param name="requiredMinor">The minimum required minor version.</param>
/// <param name="actualVersion">The actual server version detected.</param>
/// <param name="innerException">The exception that caused this failure.</param>
public PveVersionException(int requiredMajor, int requiredMinor, PveVersion actualVersion, Exception innerException)
: base($"This operation requires Proxmox VE {requiredMajor}.{requiredMinor} or later. Connected server is version {actualVersion}.", innerException)
{