annotate Limits/ILimit.cs @ 81:09f71d10c249

* Fix documentation - we're now using ISO codes (or should be, although we do handle invalid ones) no-open-ticket
author IBBoard <dev@ibboard.co.uk>
date Sun, 18 Apr 2010 14:09:16 +0000
parents 44bc5bd5c2f3
children 90b9a3fe3c18
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
57
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1 // This file (ILimit.cs) is a part of the IBBoard project and is copyright 2009 IBBoard
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
2 //
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
3 // The file and the library/program it is in are licensed and distributed, without warranty, under the GNU Affero GPL license, either version 3 of the License or (at your option) any later version. Please see COPYING for more information and the full license.
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
4
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
5 using System;
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
6
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
7 namespace IBBoard.Limits
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
8 {
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
9 /// <summary>
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
10 /// The interface for all limits
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
11 /// </summary>
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
12 public interface ILimit
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
13 {
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
14 /// <summary>
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
15 /// Gets the limited number, based on the limit that this <code>Limit</code> represents and the number it is limiting (<code>size</code>).
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
16 /// </summary>
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
17 /// <param name="size">
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
18 /// The number to be limited
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
19 /// </param>
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
20 /// <returns>
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
21 /// the limited number, as defined by the implementation of the limit
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
22 /// </returns>
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
23 int GetLimit(int size);
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
24 }
44bc5bd5c2f3 Re #24: Add limit objects
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
25 }