pepperdash/Essentials
1
0
Fork 0
mirror of https://github.com/PepperDash/Essentials.git synced 2026-08-31 19:08:29 +00:00
Code Issues Projects Releases Packages 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

22
src/PepperDash.Essentials.Core/InUseTracking/InUseTracking.cs
View file

@ -23,9 +23,9 @@ namespace PepperDash.Essentials.Core
/// </summary>
public BoolFeedback InUseFeedback { get; private set; }
/// <summary>
/// Feedback that changes with the count of users
/// </summary>
/// <summary>
/// Gets or sets the InUseCountFeedback
/// </summary>
public IntFeedback InUseCountFeedback { get; private set; }
public InUseTracking()
@ -39,6 +39,9 @@ namespace PepperDash.Essentials.Core
/// multiple times, provided that the label is different
/// </summary>
/// <param name="label">A label to identify the instance of the user. Treated like a "role", etc.</param>
/// <summary>
/// AddUser method
/// </summary>
public void AddUser(object objectToAdd, string label)
{
// check if an exact object/label pair exists and ignore if so. No double-registers.
@ -53,9 +56,9 @@ namespace PepperDash.Essentials.Core
InUseCountFeedback.FireUpdate();
}
/// <summary>
/// Remove a user object from this tracking
/// </summary>
/// <summary>
/// RemoveUser method
/// </summary>
public void RemoveUser(object objectToRemove, string label)
{
// Find the user object if exists and remove it
@ -70,10 +73,9 @@ namespace PepperDash.Essentials.Core
}
}
/// <summary>
/// Wrapper for label/object pair representing in-use status. Allows the same object to
/// register for in-use with different roles.
/// </summary>
/// <summary>
/// Represents a InUseTrackingObject
/// </summary>
public class InUseTrackingObject
{
public string Label { get; private set; }