Documented IVerbChunk

This commit is contained in:
Lukasz Baldyga committed 2020-12-04 17:10:34 +00:00
1 parent e84fed3f8c
commit ab37eaf3d0
1 file changed
+16 -4
@@ -1,11 +1,23 @@
namespace Advanced_Software_Engineering.Verbs.Flow { namespace Advanced_Software_Engineering.Verbs.Flow {
/// <summary>
/// A Collection of chunks to be executed. They extend IVerb because they should be interchangable.
/// </summary>
public interface IVerbChunk : IVerb { public interface IVerbChunk : IVerb {
/// <summary>
/// Adds a verb to the verb list
/// </summary>
/// <param name="verb">The verb to add</param>
void AddVerb(IVerb verb); void AddVerb(IVerb verb);
void ExecuteVerb(); /// <summary>
/// Execute the whole chunk
/// </summary>
new void ExecuteVerb();
string GetDescription(); /// <summary>
/// Gets the description of what the chunk will do
/// </summary>
/// <returns>A description of the chunk's actions</returns>
new string GetDescription();
} }
} }