docs(plugin): add some documentation to logic functions

anarchuser · anarchuser · commit 550808d06f9e · 2020-09-09T15:05:10.000+02:00
diff --git a/plugin/src/shared/sc/plugin2021/util/GameRuleLogic.kt b/plugin/src/shared/sc/plugin2021/util/GameRuleLogic.kt
@@ -113,6 +113,7 @@ object GameRuleLogic {
         } catch (e: ArrayIndexOutOfBoundsException) { false }
     }
     
+    /** Returns true if the given [Coordinates] touch a corner of a field of same color. */
     @JvmStatic
     fun cornersOnColor(board: Board, position: Coordinates, color: Color): Boolean = listOf(
             Vector(1, 1),
@@ -124,6 +125,7 @@ object GameRuleLogic {
         } catch (e: ArrayIndexOutOfBoundsException) { false }
     }
     
+    /** Returns true if the given [Coordinates] are a corner. */
     @JvmStatic
     fun isOnCorner(position: Coordinates): Boolean =
             Corner.asSet().contains(position)

Original file line number	Diff line number	Diff line change
`@@ -113,6 +113,7 @@ object GameRuleLogic {`
`113`	`113`	`} catch (e: ArrayIndexOutOfBoundsException) { false }`
`114`	`114`	`}`
`115`	`115`
	`116`	`+ /** Returns true if the given [Coordinates] touch a corner of a field of same color. */`
`116`	`117`	`@JvmStatic`
`117`	`118`	`fun cornersOnColor(board: Board, position: Coordinates, color: Color): Boolean = listOf(`
`118`	`119`	`Vector(1, 1),`
`@@ -124,6 +125,7 @@ object GameRuleLogic {`
`124`	`125`	`} catch (e: ArrayIndexOutOfBoundsException) { false }`
`125`	`126`	`}`
`126`	`127`
	`128`	`+ /** Returns true if the given [Coordinates] are a corner. */`
`127`	`129`	`@JvmStatic`
`128`	`130`	`fun isOnCorner(position: Coordinates): Boolean =`
`129`	`131`	`Corner.asSet().contains(position)`