@ -2,7 +2,8 @@ Instead of running through every line of code in the project, I will provide a s
## GridPainter.fs (public)
Name-space: `DeathSocket`
- Name-space: `DeathSocket`
- Module: `GridPainter`
This is the public facing part of the library, the API. When people add this project to theirs, they will call the functions in here. Which, in turn, will call the `internal` functions within the rest of the library. End-users will use this file and the types defined in "Domain.fs" extensively.
@ -10,7 +11,8 @@ This is the public facing part of the library, the API. When people add this pro
## ValidationServices.fs (internal)
Name-space: `ValidationServices`
- Name-space: N.A.
- Module: `ValidationServices`
The functions is this file perform validation checks -- as the name implies. File extension and path checks are examples of the types of checks found in here.
@ -18,7 +20,8 @@ The functions is this file perform validation checks -- as the name implies. Fil
## ColourServices.fs (internal)
Name-space: `ColourServices`
- Name-space: N.A.
- Module: `ColourServices`
This file deals with converting/creating `Colors` and `Brushes` which are used to draw the grid. The colours and brushes are derived from the `System.Drawing` name-space.
@ -37,7 +40,8 @@ If you're wondering, I decided to go with `System.Drawing`, instead of `system.m
## ImagePrep.fs
Name-space: `ImagePrep`
- Name-space: N.A.
- Module: `ImagePrep`
This file provides functions which aids the functions in "ImageServices.fs". Within this file, you will find the *SkiaSharp* functions separated from the *System.Drawing* ones via comments. The functions not grouped together via those comments work with both libraries/name-spaces.
@ -45,7 +49,8 @@ This file provides functions which aids the functions in "ImageServices.fs". Wit
## ImageServices.fs (internal)
Name-space: `ImageServices`
- Name-space: N.A.
- Module: `ImageServices`
This file focuses on creating and saving the new image, with its grid. You will see **a** lot of duplicated code in here but do not worry too much. There are comments within the file explaining the rationale behind it. The short version why is to reduce the memory footprint of the library at run-time. I decided to solve this by utilising the `use` keyword. This means I do not need to manually dispose of images which reduces the chances of memory leaks. The result of this is duplicated but self-contained (I.E. function bound/scoped) code.
