aboutsummaryrefslogtreecommitdiff
path: root/ShiftOS_TheReturn/ConsoleEx.cs
diff options
context:
space:
mode:
authorMichael <[email protected]>2017-04-16 09:48:33 -0400
committerMichael <[email protected]>2017-04-16 09:48:33 -0400
commita0fc2b5e701659d1ed17eba9c2888cae6d519c1e (patch)
tree4a76428de6c261f5d0f003f471de9813d4abed10 /ShiftOS_TheReturn/ConsoleEx.cs
parentc1457428399f815d51dd535752b74ce3bcb484af (diff)
downloadshiftos_thereturn-a0fc2b5e701659d1ed17eba9c2888cae6d519c1e.tar.gz
shiftos_thereturn-a0fc2b5e701659d1ed17eba9c2888cae6d519c1e.tar.bz2
shiftos_thereturn-a0fc2b5e701659d1ed17eba9c2888cae6d519c1e.zip
More documentation
Diffstat (limited to 'ShiftOS_TheReturn/ConsoleEx.cs')
-rw-r--r--ShiftOS_TheReturn/ConsoleEx.cs24
1 files changed, 24 insertions, 0 deletions
diff --git a/ShiftOS_TheReturn/ConsoleEx.cs b/ShiftOS_TheReturn/ConsoleEx.cs
index 69f6a18..90f9cc0 100644
--- a/ShiftOS_TheReturn/ConsoleEx.cs
+++ b/ShiftOS_TheReturn/ConsoleEx.cs
@@ -6,8 +6,14 @@ using System.Threading.Tasks;
namespace ShiftOS.Engine
{
+ /// <summary>
+ /// Provides extra eye candy data that can be used by ShiftOS terminals.
+ /// </summary>
public static class ConsoleEx
{
+ /// <summary>
+ /// Initializes the <see cref="ConsoleEx"/> class, performing core configuration.
+ /// </summary>
static ConsoleEx()
{
ForegroundColor = ConsoleColor.White;
@@ -18,11 +24,29 @@ namespace ShiftOS.Engine
Underline = false;
}
+ /// <summary>
+ /// Gets or sets the foreground color of text in the Terminal.
+ /// </summary>
public static ConsoleColor ForegroundColor { get; set; }
+
+ /// <summary>
+ /// Gets or sets the background color of text in the Terminal.
+ /// </summary>
public static ConsoleColor BackgroundColor { get; set; }
+ /// <summary>
+ /// Gets or sets whether text in the Terminal is bold.
+ /// </summary>
public static bool Bold { get; set; }
+
+ /// <summary>
+ /// Gets or sets whether text in the Terminal is italic.
+ /// </summary>
public static bool Italic { get; set; }
+
+ /// <summary>
+ /// Gets or sets whether text in the Terminal is underlined.
+ /// </summary>
public static bool Underline { get; set; }
}
}