changeset 428:8f5125740316

Re #27: Define unit requirements * Move definition and documentation of ID up to interface to ensure it is everywhere
author IBBoard <dev@ibboard.co.uk>
date Sun, 30 Oct 2011 20:33:05 +0000
parents 3882b533d99d
children 7179c585d31d
files API/Objects/Requirement/AbstractRequirement.cs API/Objects/Requirement/IRequirement.cs
diffstat 2 files changed, 9 insertions(+), 7 deletions(-) [+]
line diff
     1.1 --- a/API/Objects/Requirement/AbstractRequirement.cs	Sun Oct 30 20:31:43 2011 +0000
     1.2 +++ b/API/Objects/Requirement/AbstractRequirement.cs	Sun Oct 30 20:33:05 2011 +0000
     1.3 @@ -8,13 +8,6 @@
     1.4  {
     1.5  	public abstract class AbstractRequirement : IRequirement
     1.6  	{
     1.7 -		/// <summary>
     1.8 -		/// Gets the ID of the requirement type. This is used by the requirement factories.
     1.9 -		/// It may be, but is not required to be, the name of the class.
    1.10 -		/// </summary>
    1.11 -		/// <value>
    1.12 -		/// The requirement I.
    1.13 -		/// </value>
    1.14  		public abstract string RequirementID { get; }
    1.15  
    1.16  		public override bool Equals (object obj)
     2.1 --- a/API/Objects/Requirement/IRequirement.cs	Sun Oct 30 20:31:43 2011 +0000
     2.2 +++ b/API/Objects/Requirement/IRequirement.cs	Sun Oct 30 20:33:05 2011 +0000
     2.3 @@ -11,6 +11,15 @@
     2.4  	public interface IRequirement
     2.5  	{
     2.6  		/// <summary>
     2.7 +		/// Gets the ID of the requirement type. This is used by the requirement factories.
     2.8 +		/// It may be, but is not required to be, the name of the class.
     2.9 +		/// </summary>
    2.10 +		/// <value>
    2.11 +		/// The ID of the requirement type.
    2.12 +		/// </value>
    2.13 +		string RequirementID { get; }
    2.14 +
    2.15 +		/// <summary>
    2.16  		/// Checks whether the supplied WarFoundryObject can be added to the supplied army.
    2.17  		/// </summary>
    2.18  		/// <returns>