From 52352d4bec0d5e1690b76496a69b043473c006d8 Mon Sep 17 00:00:00 2001
From: "OPTIMUS-PRIME\\craig" <craig@craigoates.net>
Date: Sat, 8 Sep 2018 17:42:09 +0100
Subject: [PATCH] add XML comment to public facing code in library project.

---
 SmoulderingBeachBall/Domain.fs   | 18 +++++++++++++++++-
 SmoulderingBeachBall/Services.fs |  7 +++++++
 2 files changed, 24 insertions(+), 1 deletion(-)

diff --git a/SmoulderingBeachBall/Domain.fs b/SmoulderingBeachBall/Domain.fs
index 286c5d8..d1687bc 100644
--- a/SmoulderingBeachBall/Domain.fs
+++ b/SmoulderingBeachBall/Domain.fs
@@ -1,18 +1,34 @@
 namespace SmoulderingBeachBall.Domain
 
     [<AutoOpen>]
+    /// A collection of types used to describe a Smouldering Beach Ball image. 
     module DomainTypes =
 
         open System.Drawing
 
+        /// <summary>
+        /// The type of overly the image should have.
+        /// Border creates a border around the base image.
+        /// Full creates a border and a 'X' over the base image.
+        /// </summary>
         type OverlayType =
             | Border
             | Full
         
+        /// <summary>
+        /// The specification for the overlay.
+        /// You define the overlays colour and overlay type here.
+        /// </summary>
         type OverlaySpec =
             { colour: Brush;
               overlayType: OverlayType }
-        
+
+        /// <summary>
+        /// The specification for the whole image.
+        /// Set the width, height, colour, save location and overlay here.
+        /// The overlay requires an OverlaySpec if an overlay is desired.
+        /// To create an image without an overlay, just use 'None'.
+        /// </summary>
         type ImageSpec =
             { width: int;
               height: int;
diff --git a/SmoulderingBeachBall/Services.fs b/SmoulderingBeachBall/Services.fs
index f394b55..c42b148 100644
--- a/SmoulderingBeachBall/Services.fs
+++ b/SmoulderingBeachBall/Services.fs
@@ -1,5 +1,6 @@
 namespace SmoulderingBeachBall
 
+/// Provides the public facing functions of Smouldering Beach Ball.
 module Services =
 
     open System
@@ -7,6 +8,12 @@ module Services =
     open InternalServices.Validation
     open InternalServices.Drawing
 
+    /// <summary>
+    /// Creates an image using the specification provided by the ImageSpec.
+    /// </summary>
+    /// <param name="spec">
+    /// The image specification which describes how the image should look.
+    /// </param>
     let makeImage (spec: ImageSpec) =
         async {
             try