Browse Source

Added XML comments to TextInFileIsValid function.

master
Craig Oates 6 years ago
parent
commit
a303b28fe9
  1. 11
      WetPancake/ProductServices.fs

11
WetPancake/ProductServices.fs

@ -44,6 +44,17 @@ module Pancake =
| :? InvalidOperationException -> return text
}
/// <summary>
/// Checks the text within the specified file to see if it contains a vaild end token.
/// They are '.', '!' and '?'.
/// </summary>
/// <param name="filePath">
/// The path of the .txt file being tested.
/// </param>
/// <remarks>
/// This function does not check to see if the filepath is valid.
/// Be sure to check the path is valid before calling this function.
/// </remarks>
let TextInFileIsValidAsync filePath =
async {
return DataAccess.LoadFile filePath |> TextContainsValidEndToken

Loading…
Cancel
Save