mirror of
https://github.com/PepperDash/Essentials.git
synced 2026-02-10 02:05:08 +00:00
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:
@@ -3,6 +3,9 @@ using PepperDash.Essentials.Core;
|
||||
|
||||
namespace PepperDash.Essentials.Core.PageManagers
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a DiscPlayerMediumPageManager
|
||||
/// </summary>
|
||||
public class DiscPlayerMediumPageManager : MediumLeftSwitchablePageManager
|
||||
{
|
||||
IDiscPlayerControls Player;
|
||||
@@ -14,6 +17,10 @@ namespace PepperDash.Essentials.Core.PageManagers
|
||||
TriList = trilist;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Show method
|
||||
/// </summary>
|
||||
/// <inheritdoc />
|
||||
public override void Show()
|
||||
{
|
||||
uint offset = GetOffsetJoin();
|
||||
@@ -33,6 +40,10 @@ namespace PepperDash.Essentials.Core.PageManagers
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Hide method
|
||||
/// </summary>
|
||||
/// <inheritdoc />
|
||||
public override void Hide()
|
||||
{
|
||||
TriList.BooleanInput[BackingPageJoin].BoolValue = false;
|
||||
|
||||
@@ -21,6 +21,9 @@ namespace PepperDash.Essentials.Core.PageManagers
|
||||
/// </summary>
|
||||
/// <param name="deviceType">1 through 49, as defined in some constants somewhere!</param>
|
||||
/// <returns></returns>
|
||||
/// <summary>
|
||||
/// GetOffsetJoin method
|
||||
/// </summary>
|
||||
public uint GetOffsetJoin(uint deviceType)
|
||||
{
|
||||
return 10000 + (deviceType * 100);
|
||||
@@ -47,11 +50,18 @@ namespace PepperDash.Essentials.Core.PageManagers
|
||||
BackingPageJoin = join;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Show method
|
||||
/// </summary>
|
||||
/// <inheritdoc />
|
||||
public override void Show()
|
||||
{
|
||||
TriList.BooleanInput[BackingPageJoin].BoolValue = true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Hide method
|
||||
/// </summary>
|
||||
public override void Hide()
|
||||
{
|
||||
TriList.BooleanInput[BackingPageJoin].BoolValue = false;
|
||||
|
||||
@@ -9,10 +9,16 @@ using Serilog.Events;
|
||||
|
||||
namespace PepperDash.Essentials.Core.PageManagers
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a ThreePanelPlusOnePageManager
|
||||
/// </summary>
|
||||
public class ThreePanelPlusOnePageManager : PageManager
|
||||
{
|
||||
protected BasicTriListWithSmartObject TriList;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the Position5TabsId
|
||||
/// </summary>
|
||||
public uint Position5TabsId { get; set; }
|
||||
|
||||
/// <summary>
|
||||
@@ -79,6 +85,10 @@ namespace PepperDash.Essentials.Core.PageManagers
|
||||
(uo as Action<bool>)(args.Sig.BoolValue);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Hide method
|
||||
/// </summary>
|
||||
/// <inheritdoc />
|
||||
public override void Hide()
|
||||
{
|
||||
var fixedSigs = FixedVisibilityJoins.Select(u => TriList.BooleanInput[u]).ToList();
|
||||
@@ -109,13 +119,25 @@ namespace PepperDash.Essentials.Core.PageManagers
|
||||
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// Represents a SetTopBoxThreePanelPageManager
|
||||
/// </summary>
|
||||
public class SetTopBoxThreePanelPageManager : ThreePanelPlusOnePageManager
|
||||
{
|
||||
ISetTopBoxControls SetTopBox;
|
||||
DevicePresetsView PresetsView;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the DpadSmartObjectId
|
||||
/// </summary>
|
||||
public uint DpadSmartObjectId { get; set; }
|
||||
/// <summary>
|
||||
/// Gets or sets the NumberPadSmartObjectId
|
||||
/// </summary>
|
||||
public uint NumberPadSmartObjectId { get; set; }
|
||||
/// <summary>
|
||||
/// Gets or sets the PresetsSmartObjectId
|
||||
/// </summary>
|
||||
public uint PresetsSmartObjectId { get; set; }
|
||||
|
||||
/// <summary>
|
||||
@@ -176,6 +198,10 @@ namespace PepperDash.Essentials.Core.PageManagers
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Show method
|
||||
/// </summary>
|
||||
/// <inheritdoc />
|
||||
public override void Show()
|
||||
{
|
||||
if(PresetsView != null)
|
||||
@@ -183,6 +209,10 @@ namespace PepperDash.Essentials.Core.PageManagers
|
||||
base.Show();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Hide method
|
||||
/// </summary>
|
||||
/// <inheritdoc />
|
||||
public override void Hide()
|
||||
{
|
||||
if (PresetsView != null)
|
||||
|
||||
@@ -4,10 +4,9 @@ using PepperDash.Essentials.Core.Presets;
|
||||
|
||||
namespace PepperDash.Essentials.Core.PageManagers
|
||||
{
|
||||
/// <summary>
|
||||
/// A fixed-layout page manager that expects a DPad on the right, fixed portion of the page, and a two/three
|
||||
/// tab switchable area on the left for presets, numeric and transport controls
|
||||
/// </summary>
|
||||
/// <summary>
|
||||
/// Represents a SetTopBoxMediumPageManager
|
||||
/// </summary>
|
||||
public class SetTopBoxMediumPageManager : MediumLeftSwitchablePageManager
|
||||
{
|
||||
ISetTopBoxControls SetTopBox;
|
||||
@@ -22,6 +21,10 @@ namespace PepperDash.Essentials.Core.PageManagers
|
||||
PresetsView = new DevicePresetsView(trilist, stb.TvPresets);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Show method
|
||||
/// </summary>
|
||||
/// <inheritdoc />
|
||||
public override void Show()
|
||||
{
|
||||
if(PresetsView != null)
|
||||
@@ -51,6 +54,10 @@ namespace PepperDash.Essentials.Core.PageManagers
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Hide method
|
||||
/// </summary>
|
||||
/// <inheritdoc />
|
||||
public override void Hide()
|
||||
{
|
||||
TriList.BooleanInput[BackingPageJoin].BoolValue = false;
|
||||
|
||||
@@ -4,9 +4,9 @@ using PepperDash.Essentials.Core;
|
||||
|
||||
namespace PepperDash.Essentials.Core.PageManagers
|
||||
{
|
||||
/// <summary>
|
||||
/// A simple class that hides and shows the default subpage for a given source type
|
||||
/// </summary>
|
||||
/// <summary>
|
||||
/// Represents a SinglePageManager
|
||||
/// </summary>
|
||||
public class SinglePageManager : PageManager
|
||||
{
|
||||
BasicTriList TriList;
|
||||
@@ -18,11 +18,18 @@ namespace PepperDash.Essentials.Core.PageManagers
|
||||
BackingPageJoin = pageJoin;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Show method
|
||||
/// </summary>
|
||||
/// <inheritdoc />
|
||||
public override void Show()
|
||||
{
|
||||
TriList.BooleanInput[BackingPageJoin].BoolValue = true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Hide method
|
||||
/// </summary>
|
||||
public override void Hide()
|
||||
{
|
||||
TriList.BooleanInput[BackingPageJoin].BoolValue = false;
|
||||
|
||||
Reference in New Issue
Block a user