From 112c05cb5e460e277ea93604ba1bb5d6ea010f0a Mon Sep 17 00:00:00 2001 From: Michael Date: Sun, 16 Apr 2017 08:12:30 -0400 Subject: [PATCH] Document the App Launcher Daemon --- ShiftOS_TheReturn/AppLauncherDaemon.cs | 32 ++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/ShiftOS_TheReturn/AppLauncherDaemon.cs b/ShiftOS_TheReturn/AppLauncherDaemon.cs index 5e3bd72..d1506b2 100644 --- a/ShiftOS_TheReturn/AppLauncherDaemon.cs +++ b/ShiftOS_TheReturn/AppLauncherDaemon.cs @@ -34,8 +34,17 @@ using ShiftOS.Objects.ShiftFS; namespace ShiftOS.Engine { + /// + /// Provides functionality for pulling data about the App Launcher. + /// public static class AppLauncherDaemon { + /// + /// Extension method that allows you to determine if a list of s contains a given name. + /// + /// The list of assembly names + /// The name to look for. + /// Whether or not the name was found in the list. public static bool Contains(this AssemblyName[] asms, string name) { foreach(var asm in asms) @@ -46,6 +55,10 @@ namespace ShiftOS.Engine return false; } + /// + /// Pulls a list of all available App Launcher items. + /// + /// A containing all available App Launcher items. public static List Available() { List win = new List(); @@ -111,20 +124,39 @@ namespace ShiftOS.Engine } + /// + /// Provides a data object for app launcher items + /// public class LauncherItem { + /// + /// Display data including icons, names, and the category of the item. + /// public LauncherAttribute DisplayData { get; internal set; } + /// + /// A .NET that is associated with this item. + /// public Type LaunchType { get; internal set; } } + /// + /// Provides the ability to run Lua scripts from the App Launcher. + /// public class LuaLauncherItem : LauncherItem { + /// + /// Creates a new instance of the . + /// + /// A script file to run when the item is activated. public LuaLauncherItem(string file) { LaunchPath = file; } + /// + /// Gets or sets the launch path of this App Launcher item. + /// public string LaunchPath { get; private set; } } }