Skip to content

Commit 0a991cf

Browse files
committed
docs: remove commented out code and associated XML comments
1 parent 18088d3 commit 0a991cf

1 file changed

Lines changed: 30 additions & 40 deletions

File tree

src/PepperDash.Core/Device.cs

Lines changed: 30 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -5,35 +5,25 @@
55
namespace PepperDash.Core
66
{
77
//*********************************************************************************************************
8-
/// <summary>
9-
/// Represents a Device
10-
/// </summary>
8+
/// <summary>
9+
/// Represents a Device
10+
/// </summary>
1111
public class Device : IKeyName
1212
{
1313

1414
/// <summary>
1515
/// Unique Key
1616
/// </summary>
1717
public string Key { get; protected set; }
18-
/// <summary>
19-
/// Gets or sets the Name
20-
/// </summary>
18+
/// <summary>
19+
/// Gets or sets the Name
20+
/// </summary>
2121
public string Name { get; protected set; }
2222
/// <summary>
2323
///
2424
/// </summary>
2525
public bool Enabled { get; protected set; }
2626

27-
/// <summary>
28-
/// A place to store reference to the original config object, if any. These values should
29-
/// NOT be used as properties on the device as they are all publicly-settable values.
30-
/// </summary>
31-
//public DeviceConfig Config { get; private set; }
32-
/// <summary>
33-
/// Helper method to check if Config exists
34-
/// </summary>
35-
//public bool HasConfig { get { return Config != null; } }
36-
3727
List<Action> _PreActivationActions;
3828
List<Action> _PostActivationActions;
3929

@@ -86,19 +76,19 @@ public void AddPreActivationAction(Action act)
8676
/// Adds a post activation action
8777
/// </summary>
8878
/// <param name="act"></param>
89-
/// <summary>
90-
/// AddPostActivationAction method
91-
/// </summary>
79+
/// <summary>
80+
/// AddPostActivationAction method
81+
/// </summary>
9282
public void AddPostActivationAction(Action act)
9383
{
9484
if (_PostActivationActions == null)
9585
_PostActivationActions = new List<Action>();
9686
_PostActivationActions.Add(act);
9787
}
9888

99-
/// <summary>
100-
/// PreActivate method
101-
/// </summary>
89+
/// <summary>
90+
/// PreActivate method
91+
/// </summary>
10292
public void PreActivate()
10393
{
10494
if (_PreActivationActions != null)
@@ -115,9 +105,9 @@ public void PreActivate()
115105
});
116106
}
117107

118-
/// <summary>
119-
/// Activate method
120-
/// </summary>
108+
/// <summary>
109+
/// Activate method
110+
/// </summary>
121111
public bool Activate()
122112
{
123113
//if (_PreActivationActions != null)
@@ -128,9 +118,9 @@ public bool Activate()
128118
return result;
129119
}
130120

131-
/// <summary>
132-
/// PostActivate method
133-
/// </summary>
121+
/// <summary>
122+
/// PostActivate method
123+
/// </summary>
134124
public void PostActivate()
135125
{
136126
if (_PostActivationActions != null)
@@ -153,9 +143,9 @@ public void PostActivate()
153143
/// do not need to call base.CustomActivate()
154144
/// </summary>
155145
/// <returns>true if device activated successfully.</returns>
156-
/// <summary>
157-
/// CustomActivate method
158-
/// </summary>
146+
/// <summary>
147+
/// CustomActivate method
148+
/// </summary>
159149
public virtual bool CustomActivate() { return true; }
160150

161151
/// <summary>
@@ -182,15 +172,15 @@ public void OnFalse(object o, Action a)
182172
if (o is bool && !(bool)o) a();
183173
}
184174

185-
/// <summary>
186-
/// Returns a string representation of the object, including its key and name.
187-
/// </summary>
188-
/// <remarks>The returned string is formatted as "{Key} - {Name}". If the <c>Name</c> property is
189-
/// null or empty, "---" is used in place of the name.</remarks>
190-
/// <returns>A string that represents the object, containing the key and name in the format "{Key} - {Name}".</returns>
191-
/// <summary>
192-
/// ToString method
193-
/// </summary>
175+
/// <summary>
176+
/// Returns a string representation of the object, including its key and name.
177+
/// </summary>
178+
/// <remarks>The returned string is formatted as "{Key} - {Name}". If the <c>Name</c> property is
179+
/// null or empty, "---" is used in place of the name.</remarks>
180+
/// <returns>A string that represents the object, containing the key and name in the format "{Key} - {Name}".</returns>
181+
/// <summary>
182+
/// ToString method
183+
/// </summary>
194184
public override string ToString()
195185
{
196186
return string.Format("{0} - {1}", Key, string.IsNullOrEmpty(Name) ? "---" : Name);

0 commit comments

Comments
 (0)