docs: complete XML documentation for all projects with inheritdoc tags

Co-authored-by: andrew-welker <1765622+andrew-welker@users.noreply.github.com>
This commit is contained in:
copilot-swe-agent[bot]
2025-07-22 15:53:01 +00:00
parent 260677a37f
commit 7987eb8f9b
485 changed files with 8099 additions and 2490 deletions

View File

@@ -6,6 +6,9 @@ using System.Linq;
namespace PepperDash.Essentials.WebApiHandlers
{
/// <summary>
/// Represents a ActionPathsHandler
/// </summary>
public class ActionPathsHandler : WebApiBaseRequestHandler
{
private readonly MobileControlSystemController mcController;
@@ -26,6 +29,9 @@ namespace PepperDash.Essentials.WebApiHandlers
}
}
/// <summary>
/// Represents a ActionPathsResponse
/// </summary>
public class ActionPathsResponse
{
[JsonIgnore]
@@ -40,12 +46,21 @@ namespace PepperDash.Essentials.WebApiHandlers
}
}
/// <summary>
/// Represents a ActionPath
/// </summary>
public class ActionPath
{
[JsonProperty("messengerKey")]
/// <summary>
/// Gets or sets the MessengerKey
/// </summary>
public string MessengerKey { get; set; }
[JsonProperty("path")]
/// <summary>
/// Gets or sets the Path
/// </summary>
public string Path { get; set; }
}
}

View File

@@ -8,6 +8,9 @@ using System.Threading.Tasks;
namespace PepperDash.Essentials.WebApiHandlers
{
/// <summary>
/// Represents a MobileAuthRequestHandler
/// </summary>
public class MobileAuthRequestHandler : WebApiBaseRequestAsyncHandler
{
private readonly MobileControlSystemController mcController;

View File

@@ -10,6 +10,9 @@ using System.Linq;
namespace PepperDash.Essentials.WebApiHandlers
{
/// <summary>
/// Represents a MobileInfoHandler
/// </summary>
public class MobileInfoHandler : WebApiBaseRequestHandler
{
private readonly MobileControlSystemController mcController;
@@ -39,6 +42,9 @@ namespace PepperDash.Essentials.WebApiHandlers
}
}
/// <summary>
/// Represents a InformationResponse
/// </summary>
public class InformationResponse
{
[JsonIgnore]
@@ -58,6 +64,9 @@ namespace PepperDash.Essentials.WebApiHandlers
}
}
/// <summary>
/// Represents a MobileControlEdgeServer
/// </summary>
public class MobileControlEdgeServer
{
[JsonIgnore]
@@ -87,6 +96,9 @@ namespace PepperDash.Essentials.WebApiHandlers
}
}
/// <summary>
/// Represents a MobileControlDirectServer
/// </summary>
public class MobileControlDirectServer
{
[JsonIgnore]
@@ -113,6 +125,9 @@ namespace PepperDash.Essentials.WebApiHandlers
}
}
/// <summary>
/// Represents a MobileControlDirectClient
/// </summary>
public class MobileControlDirectClient
{
[JsonIgnore]

View File

@@ -8,6 +8,9 @@ using Serilog.Events;
namespace PepperDash.Essentials.WebApiHandlers
{
/// <summary>
/// Represents a UiClientHandler
/// </summary>
public class UiClientHandler : WebApiBaseRequestHandler
{
private readonly MobileControlWebsocketServer server;
@@ -140,27 +143,51 @@ namespace PepperDash.Essentials.WebApiHandlers
}
}
/// <summary>
/// Represents a ClientRequest
/// </summary>
public class ClientRequest
{
[JsonProperty("roomKey", NullValueHandling = NullValueHandling.Ignore)]
/// <summary>
/// Gets or sets the RoomKey
/// </summary>
public string RoomKey { get; set; }
[JsonProperty("grantCode", NullValueHandling = NullValueHandling.Ignore)]
/// <summary>
/// Gets or sets the GrantCode
/// </summary>
public string GrantCode { get; set; }
[JsonProperty("token", NullValueHandling = NullValueHandling.Ignore)]
/// <summary>
/// Gets or sets the Token
/// </summary>
public string Token { get; set; }
}
/// <summary>
/// Represents a ClientResponse
/// </summary>
public class ClientResponse
{
[JsonProperty("error", NullValueHandling = NullValueHandling.Ignore)]
/// <summary>
/// Gets or sets the Error
/// </summary>
public string Error { get; set; }
[JsonProperty("token", NullValueHandling = NullValueHandling.Ignore)]
/// <summary>
/// Gets or sets the Token
/// </summary>
public string Token { get; set; }
[JsonProperty("path", NullValueHandling = NullValueHandling.Ignore)]
/// <summary>
/// Gets or sets the Path
/// </summary>
public string Path { get; set; }
}
}