Improve comments for IntelliJ hovering tooltips

openrndr · Aug 3, 2022 · 738c013 · 738c013
1 parent 1e3b73a
commit 738c013
Showing 1 changed file with 14 additions and 5 deletions.
diff --git a/orx-image-fit/src/commonMain/kotlin/ImageFit.kt b/orx-image-fit/src/commonMain/kotlin/ImageFit.kt
@@ -13,11 +13,20 @@ import kotlin.math.min
  * Available `object-fit` methods (borrowed from CSS)
  */
 enum class FitMethod {
-    Cover,   // Cover target area. Crop the source image if needed.
-    Contain, // Fit image in target area. Add margins if needed.
-    Fill,    // Deform source image to match the target area.
-    None     // Maintain original image scale, crop as needed.
-    // ScaleDown // Not implemented.
+    /** Cover target area. Crop the source image if needed. */
+    Cover,
+
+    /** Fit image in target area. Add margins if needed. */
+    Contain,
+
+    /** Deform source image to match the target area. */
+    Fill,
+
+    /** Maintain original image scale, crop to target area size. */
+    None
+
+    /** Not implemented */
+    // ScaleDown
 }
 
 /**