Add docstring

Sj-Si · Sj-Si · commit 7128474ac3e6 · 2025-11-11T17:47:55.000-05:00
diff --git a/android/app/src/main/java/com/steve1316/uma_android_automation/utils/CustomImageUtils.kt b/android/app/src/main/java/com/steve1316/uma_android_automation/utils/CustomImageUtils.kt
@@ -1577,6 +1577,11 @@ class CustomImageUtils(context: Context, private val game: Game) : ImageUtils(co
 		)
 	}
 
+    /**
+    * Gets the filled percentage of the energy bar.
+    *
+    * @return If energy bar is detected, returns the filled percentage, else returns null.
+    */
     fun analyzeEnergyBar(): Int? {
         val (sourceBitmap, templateBitmap) = getBitmaps("energy")
         if (templateBitmap == null) {

Original file line number	Diff line number	Diff line change
`@@ -1577,6 +1577,11 @@ class CustomImageUtils(context: Context, private val game: Game) : ImageUtils(co`
`1577`	`1577`	`)`
`1578`	`1578`	`}`
`1579`	`1579`
	`1580`	`+ /**`
	`1581`	`+ * Gets the filled percentage of the energy bar.`
	`1582`	`+ *`
	`1583`	`+ * @return If energy bar is detected, returns the filled percentage, else returns null.`
	`1584`	`+ */`
`1580`	`1585`	`fun analyzeEnergyBar(): Int? {`
`1581`	`1586`	`val (sourceBitmap, templateBitmap) = getBitmaps("energy")`
`1582`	`1587`	`if (templateBitmap == null) {`