34 lines
853 B
C#
34 lines
853 B
C#
using System.Collections.Generic;
|
|
|
|
namespace JD.TeaBoxAddinSystem.Bootstrap
|
|
{
|
|
/// <summary>
|
|
/// Interface for command-line help topics.
|
|
/// </summary>
|
|
public interface ICommandLineHelpTopic
|
|
{
|
|
#region Properties
|
|
|
|
/// <summary>
|
|
/// Name(s) of the topic. (ex.: "h", "help")
|
|
/// </summary>
|
|
IEnumerable<string> Names { get; }
|
|
|
|
/// <summary>
|
|
/// Gets the syntax help displayed to the user. (ex.: "/h, /help")
|
|
/// </summary>
|
|
string HelpSyntax { get; }
|
|
|
|
/// <summary>
|
|
/// Short help topic description.
|
|
/// </summary>
|
|
string ShortHelpDescription { get; }
|
|
|
|
/// <summary>
|
|
/// Longer, possibly multi-line, help topic description.
|
|
/// </summary>
|
|
string LongHelpDescription { get; }
|
|
|
|
#endregion
|
|
}
|
|
}
|