Documented Verb

This commit is contained in:
Lukasz Baldyga committed 2020-11-02 09:35:58 +00:00
1 parent 8bb4f9b148
commit 01a45a2649
1 file changed
+10
@@ -5,8 +5,18 @@ using System.Text;
using System.Threading.Tasks; using System.Threading.Tasks;
namespace Advanced_Software_Engineering { namespace Advanced_Software_Engineering {
/// <summary>
/// Verb is an interface for executing and getting the descriptions of Verbs. Some Verbs draw lines, some verbs will assign
/// </summary>
public interface Verb { public interface Verb {
/// <summary>
/// This executes the verb to the drawer inside it.
/// </summary>
void ExecuteVerb(); void ExecuteVerb();
/// <summary>
/// The description of what the Verb will do.
/// </summary>
/// <returns>A string description of what the Verb will do</returns>
string GetDescription(); string GetDescription();
} }
} }