Added documentation

1 files changed, 23 insertions, 7 deletions

diff --git a/Sources/SwiftyCrop/Models/CropViewModel.swift b/Sources/SwiftyCrop/Models/CropViewModel.swift
index b2eb929..e27f1ad 100644
--- a/Sources/SwiftyCrop/Models/CropViewModel.swift
+++ b/Sources/SwiftyCrop/Models/CropViewModel.swift
@@ -22,6 +22,7 @@ class CropViewModel: ObservableObject {
     
     /**
      Calculates the max points that the image can be dragged to.
+     - Returns: A CGPoint representing the maximum points to which the image can be dragged.
      */
     func calculateDragGestureMax() -> CGPoint {
         let yLimit = ((imageSizeInView.height / 2) * scale) - maskRadius
@@ -31,6 +32,7 @@ class CropViewModel: ObservableObject {
     
     /**
      Calculates the maximum magnification values that are applied when zooming the image, so that the image can not be zoomed out of its own size.
+     - Returns: A tuple (CGFloat, CGFloat) representing the minimum and maximum magnification scale values. The first value is the minimum scale at which the image can be displayed without being smaller than its own size. The second value is the preset maximum magnification scale.
      */
     func calculateMagnificationGestureMaxValues() -> (CGFloat, CGFloat) {
         let minScale = (maskRadius * 2) / min(imageSizeInView.width, imageSizeInView.height)
@@ -39,20 +41,30 @@ class CropViewModel: ObservableObject {
     
     /**
      Crops the image to the part that is dragged/zoomed inside the view. Cropped image will **always** be a square, no matter what mask shape is used.
+     - Parameters:
+        - image: The UIImage to crop
+     - Returns: A cropped UIImage if the cropping operation is successful; otherwise nil.
      */
     func crop(_ image: UIImage) -> UIImage? {
         guard let orientedImage = image.correctlyOriented else {
             return nil
         }
-        let factor = min((orientedImage.size.width / imageSizeInView.width), (orientedImage.size.height / imageSizeInView.height)) /// The relation factor of the originals image width/height and the width/height of the image displayed in the view (initial)
+        // The relation factor of the originals image width/height and the width/height of the image displayed in the view (initial)
+        let factor = min((orientedImage.size.width / imageSizeInView.width), (orientedImage.size.height / imageSizeInView.height))
         let centerInOriginalImage = CGPoint(x: orientedImage.size.width / 2, y: orientedImage.size.height / 2)
-        let cropRadiusInOriginalImage = (maskRadius * factor) / scale /// Calculate the crop radius inside the original image which based on the mask radius
-        let offsetX = offset.width * factor /// The x offset the image has by dragging
-        let offsetY = offset.height * factor /// The y offset the image has by dragging
-        let cropRectX = (centerInOriginalImage.x - cropRadiusInOriginalImage) - (offsetX / scale) /// Calculates the x coordinate of the crop rectangle inside the original image
-        let cropRectY = (centerInOriginalImage.y - cropRadiusInOriginalImage) - (offsetY / scale) /// Calculates the y coordinate of the crop rectangle inside the original image
+        // Calculate the crop radius inside the original image which based on the mask radius
+        let cropRadiusInOriginalImage = (maskRadius * factor) / scale
+        // The x offset the image has by dragging
+        let offsetX = offset.width * factor
+        // The y offset the image has by dragging
+        let offsetY = offset.height * factor
+        // Calculates the x coordinate of the crop rectangle inside the original image
+        let cropRectX = (centerInOriginalImage.x - cropRadiusInOriginalImage) - (offsetX / scale)
+        // Calculates the y coordinate of the crop rectangle inside the original image
+        let cropRectY = (centerInOriginalImage.y - cropRadiusInOriginalImage) - (offsetY / scale)
         let cropRectCoordinate = CGPoint(x: cropRectX, y: cropRectY)
-        let cropRectDimension = cropRadiusInOriginalImage * 2 /// Cropped rects dimension is twice its radius (diameter), since it's always a square it's used both for width and height
+        // Cropped rects dimension is twice its radius (diameter), since it's always a square it's used both for width and height
+        let cropRectDimension = cropRadiusInOriginalImage * 2
         
         let cropRect = CGRect(
             x: cropRectCoordinate.x,
@@ -71,6 +83,10 @@ class CropViewModel: ObservableObject {
 }
 
 private extension UIImage {
+    /**
+     A UIImage instance with corrected orientation. If the instance's orientation is already `.up`, it simply returns the original.
+     - Returns: An optional UIImage that represents the correctly oriented image.
+     */
     var correctlyOriented: UIImage? {
         if imageOrientation == .up { return self }