wip

Author: point85

ShiftSharp/Break.cs

@@ -22,7 +22,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 */
 
-
 using NodaTime;
 
 namespace Point85.ShiftSharp.Schedule
@@ -32,10 +31,21 @@ namespace Point85.ShiftSharp.Schedule
 	/// </summary> 
 	public class Break : TimePeriod
 	{
+		/// <summary>
+		/// Break constructor
+		/// </summary>
+		/// <param name="name">Name of break</param>
+		/// <param name="description">Description of break</param>
+		/// <param name="start">Start time of break</param>
+		/// <param name="duration">Duration of break</param>
 		public Break(string name, string description, LocalTime start, Duration duration) : base(name, description, start, duration)
 		{
 		}
 
+		/// <summary>
+		/// A break is a working period
+		/// </summary>
+		/// <returns>True</returns>
 		public override bool IsWorkingPeriod()
 		{
 			return true;

ShiftSharp/DayOff.cs

@@ -22,7 +22,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 */
 
-
 using NodaTime;
 
 namespace Point85.ShiftSharp.Schedule
@@ -37,6 +36,10 @@ internal DayOff(string name, string description, LocalTime start, Duration durat
 		{
 		}
 
+		/// <summary>
+		/// A DayOff is not a working period
+		/// </summary>
+		/// <returns>False</returns>
 		public override bool IsWorkingPeriod()
 		{
 			return false;

ShiftSharp/Named.cs

@@ -22,7 +22,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 */
 
-
 using System;
 
 namespace Point85.ShiftSharp.Schedule
@@ -32,17 +31,26 @@ namespace Point85.ShiftSharp.Schedule
 	/// </summary>
 	public abstract class Named
 	{
-		// name
+		/// <summary>
+		/// name
+		/// </summary>
 		public string Name { get; set; }
 
-		// description
+		/// <summary>
+		/// description
+		/// </summary>
 		public string Description { get; set; }
 
 		protected Named()
 		{
 
 		}
 
+		/// <summary>
+		/// Constructor
+		/// </summary>
+		/// <param name="name">Name</param>
+		/// <param name="description">Description</param>
 		protected Named(string name, string description)
 		{
 			Name = name ?? throw new Exception(WorkSchedule.GetMessage("name.not.defined"));

ShiftSharp/NonWorkingPeriod.cs

@@ -33,15 +33,24 @@ namespace Point85.ShiftSharp.Schedule
 	/// </summary>
 	public class NonWorkingPeriod : Named, IComparable<NonWorkingPeriod>
 	{
-		// owning work schedule
+		/// <summary>
+		/// owning work schedule
+		/// </summary>
 		public WorkSchedule WorkSchedule { get; internal set; }
 
-		// starting date and time of day
+		/// <summary>
+		/// starting date and time of day
+		/// </summary>
 		public LocalDateTime StartDateTime { get; set; }
 
-		// duration of period
+		/// <summary>
+		/// duration of period
+		/// </summary>
 		public Duration Duration;
 
+		/// <summary>
+		/// Constructor
+		/// </summary>
 		public NonWorkingPeriod() : base()
 		{
 		}

ShiftSharp/Rotation.cs

@@ -22,7 +22,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 */
 
-
 using NodaTime;
 using System;
 using System.Collections.Generic;
@@ -34,10 +33,14 @@ namespace Point85.ShiftSharp.Schedule
 	/// </summary>
 	public class Rotation : Named, IComparable<Rotation>
 	{
-		// working periods in the rotation
+		/// <summary>
+		/// working periods in the rotation
+		/// </summary>
 		public List<RotationSegment> RotationSegments { get; private set; } = new List<RotationSegment>();
 
-		// list of working and non-working days
+		/// <summary>
+		/// list of working and non-working days
+		/// </summary>
 		private List<TimePeriod> periods;
 
 		// name of the day off time period
@@ -60,33 +63,26 @@ static Rotation()
 			DAY_OFF = dayOff;
 		}
 
-		/**
-		 * Default constructor
-		 */
+		/// <summary>
+		/// default constructor
+		/// </summary>
 		public Rotation() : base()
 		{
 		}
 
-		/**
-		 * Constructor
-		 * 
-		 * @param name
-		 *            Rotation name
-		 * @param description
-		 *            Description
-		 * @throws Exception
-		 *             Exception
-		 */
+		/// <summary>
+		/// Constructor
+		/// </summary>
+		/// <param name="name">name of rotation</param>
+		/// <param name="description">description of rotation</param>
 		public Rotation(string name, string description) : base(name, description)
 		{
-
 		}
 
-		/**
-		 * Get the shifts and off-shifts in the rotation
-		 * 
-		 * @return List of periods
-		 */
+		/// <summary>
+		/// get the shifts and off-shifts in the rotation
+		/// </summary>
+		/// <returns>List of time periods</returns>
 		public List<TimePeriod> GetPeriods()
 		{
 			if (periods == null)
@@ -114,36 +110,31 @@ public List<TimePeriod> GetPeriods()
 					}
 				}
 			}
-
 			return periods;
 		}
 
-		/**
-		 * Get the number of days in the rotation
-		 * 
-		 * @return Day count
-		 */
-
+		/// <summary>
+		/// Get the number of days in the rotation
+		/// </summary>
+		/// <returns></returns>
 		public int GetDayCount()
 		{
 			return GetPeriods().Count;
 		}
 
-		/**
-		 * Get the duration of this rotation
-		 * 
-		 * @return Duration
-		 */
+		/// <summary>
+		/// Get the duration of this rotation
+		/// </summary>
+		/// <returns>Duration</returns>
 		public Duration GetDuration()
 		{
 			return Duration.FromDays(GetPeriods().Count);
 		}
 
-		/**
-		 * Get the shift rotation's total working time
-		 * 
-		 * @return Duration of working time
-		 */
+		/// <summary>
+		/// Get the shift rotation's total working time
+		/// </summary>
+		/// <returns>Duration</returns>
 		public Duration GetWorkingTime()
 		{
 			Duration sum = Duration.Zero;
@@ -158,20 +149,14 @@ public Duration GetWorkingTime()
 			return sum;
 		}
 
-		/**
-		 * Add a working period to this rotation. A working period starts with a
-		 * shift and specifies the number of days on and days off
-		 * 
-		 * @param startingShift
-		 *            {@link Shift} that starts the period
-		 * @param daysOn
-		 *            Number of days on shift
-		 * @param daysOff
-		 *            Number of days off shift
-		 * @return {@link RotationSegment}
-		 * @throws Exception
-		 *             Exception
-		 */
+		/// <summary>
+		/// Add a working period to this rotation. A working period starts with a
+		/// shift and specifies the number of days on and days off.
+		/// </summary>
+		/// <param name="startingShift">Starting shift of rotation</param>
+		/// <param name="daysOn">Number of day on shift</param>
+		/// <param name="daysOff">Number of days off shift</param>
+		/// <returns>Part of the rotation</returns>
 		public RotationSegment AddSegment(Shift startingShift, int daysOn, int daysOff)
 		{
 			if (startingShift == null)
@@ -184,14 +169,20 @@ public RotationSegment AddSegment(Shift startingShift, int daysOn, int daysOff)
 			return segment;
 		}
 
+		/// <summary>
+		/// Compare thsi rotation to another rotation
+		/// </summary>
+		/// <param name="other">Other rotation</param>
+		/// <returns></returns>
 		public int CompareTo(Rotation other)
 		{
 			return Name.CompareTo(other.Name);
 		}
 
-		/**
-		 * Build a string representation of this rotation
-		 */
+		/// <summary>
+		/// Build a string representation of this rotation
+		/// </summary>
+		/// <returns>String</returns>
 		public override string ToString()
 		{
 			string named = base.ToString();

ShiftSharp/RotationSegment.cs

@@ -23,10 +23,6 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 */
 
 using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
 
 namespace Point85.ShiftSharp.Schedule
 {
@@ -41,21 +37,29 @@ public class RotationSegment : IComparable<RotationSegment>
 		/// </summary>
 		public Rotation Rotation { get; private set; }
 
-		// strict ordering
+		/// <summary>
+		/// ordering within the rotation
+		/// </summary>
 		public int Sequence { get; set; } = 0;
 
-		// shift that starts this segment
+		/// <summary>
+		/// shift that starts this segment
+		/// </summary>
 		public Shift StartingShift { get; set; }
 
-		// number of days on
+		/// <summary>
+		/// number of days on shift
+		/// </summary>
 		public int DaysOn { get; set; } = 0;
 
-		// number of days off
+		/// <summary>
+		/// number of days off shift
+		/// </summary>
 		public int DaysOff { get; set; } = 0;
 
-		/**
-		 * Constructor
-		 */
+		/// <summary>
+		/// Constructor
+		/// </summary>
 		public RotationSegment()
 		{
 		}
@@ -68,13 +72,12 @@ internal RotationSegment(Shift startingShift, int daysOn, int daysOff, Rotation
 			this.Rotation = rotation;
 		}
 
-		/**
-		 * Compare this rotation segment to another one.
-		 * 
-		 * @param other
-		 *            rotation segment
-		 * @return -1 if less than, 0 if equal and 1 if greater than
-		 */
+
+		/// <summary>
+		/// Compare this rotation segment to
+		/// </summary>
+		/// <param name="other">Other rotation segment</param>
+		/// <returns>-1 if less than, 0 if equal and 1 if greater than</returns>		
 		public int CompareTo(RotationSegment other)
 		{
 			int value = 0;