pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-02-11 02:35:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: complete XML documentation for all projects with inheritdoc tags

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

7
src/PepperDash.Essentials.Core/Queues/ComsMessage.cs
View File

@@ -4,7 +4,7 @@ using PepperDash.Core;
namespace PepperDash.Essentials.Core.Queues
{
/// <summary>
/// IBasicCommunication Message for IQueue
/// Represents a ComsMessage
/// </summary>
public class ComsMessage : IQueueMessage
{
@@ -48,7 +48,7 @@ namespace PepperDash.Essentials.Core.Queues
}
/// <summary>
/// Dispatchs the string/byte[] to the IBasicCommunication specified
/// Dispatch method
/// </summary>
public void Dispatch()
{
@@ -63,8 +63,9 @@ namespace PepperDash.Essentials.Core.Queues
}
/// <summary>
/// Shows either the byte[] or string to be sent
/// ToString method
/// </summary>
/// <inheritdoc />
public override string ToString()
{
return _bytes != null ? _bytes.ToString() : _string;

8
src/PepperDash.Essentials.Core/Queues/GenericQueue.cs
View File

@@ -24,7 +24,7 @@ namespace PepperDash.Essentials.Core.Queues
private const Thread.eThreadPriority _defaultPriority = Thread.eThreadPriority.MediumPriority;
/// <summary>
/// If the instance has been disposed.
/// Gets or sets the Disposed
/// </summary>
public bool Disposed { get; private set; }
@@ -208,6 +208,9 @@ namespace PepperDash.Essentials.Core.Queues
return null;
}
/// <summary>
/// Enqueue method
/// </summary>
public void Enqueue(IQueueMessage item)
{
if (Disposed)
@@ -221,8 +224,7 @@ namespace PepperDash.Essentials.Core.Queues
}
/// <summary>
/// Disposes the thread and cleans up resources. Thread cannot be restarted once
/// disposed.
/// Dispose method
/// </summary>
public void Dispose()
{

3
src/PepperDash.Essentials.Core/Queues/IQueue.cs
View File

@@ -3,6 +3,9 @@ using PepperDash.Core;
namespace PepperDash.Essentials.Core.Queues
{
/// <summary>
/// Defines the contract for IQueue
/// </summary>
public interface IQueue<T> : IKeyed, IDisposable where T : class
{
void Enqueue(T item);

3
src/PepperDash.Essentials.Core/Queues/IQueueMessage.cs
View File

@@ -2,6 +2,9 @@
namespace PepperDash.Essentials.Core.Queues
{
/// <summary>
/// Defines the contract for IQueueMessage
/// </summary>
public interface IQueueMessage
{
void Dispatch();

6
src/PepperDash.Essentials.Core/Queues/ProcessStringMessage.cs
View File

@@ -3,7 +3,7 @@
namespace PepperDash.Essentials.Core.Queues
{
/// <summary>
/// Message class for processing strings via an IQueue
/// Represents a ProcessStringMessage
/// </summary>
public class ProcessStringMessage : IQueueMessage
{
@@ -36,6 +36,10 @@ namespace PepperDash.Essentials.Core.Queues
/// To string
/// </summary>
/// <returns>The current message</returns>
/// <summary>
/// ToString method
/// </summary>
/// <inheritdoc />
public override string ToString()
{
return _message ?? String.Empty;

2
src/PepperDash.Essentials.Core/Queues/StringResponseProcessor.cs
View File

@@ -94,7 +94,7 @@ namespace PepperDash.Essentials.Core.Queues
}
/// <summary>
/// If the instance has been disposed or not. If it has, you can not use it anymore
/// Gets or sets the Disposed
/// </summary>
public bool Disposed { get; private set; }