Update documentation

JD557 · May 4, 2024 · 64646ab · 64646ab
1 parent 420bb20
commit 64646ab
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/core/shared/src/main/scala/eu/joaocosta/interim/api/Components.scala b/core/shared/src/main/scala/eu/joaocosta/interim/api/Components.scala
@@ -5,7 +5,9 @@ import eu.joaocosta.interim.skins._
 
 /** Object containing the default components.
   *
-  * By convention, all components are functions in the form `def component(id, area, ...params, skin)(value): Value`.
+  * By convention, all components are functions in the form `def component(id, ...params, skin)(area, value): Value`.
+  *
+  * The area parameter can be ommited if there's an area allocator in scope.
   */
 object Components extends Components
 

diff --git a/core/shared/src/main/scala/eu/joaocosta/interim/api/Panels.scala b/core/shared/src/main/scala/eu/joaocosta/interim/api/Panels.scala
@@ -14,7 +14,7 @@ import eu.joaocosta.interim.skins._
   * As such, panels should be called like:
   *
   * ```
-  *  val (value, nextRect) = panel(id, panelRect, ...) {area => ...}
+  *  val (value, nextRect) = panel(id, params..., skins...)(panelRect){area => ...}
   *  panelRect = nextRect
   * ```
   */

diff --git a/core/shared/src/main/scala/eu/joaocosta/interim/api/Primitives.scala b/core/shared/src/main/scala/eu/joaocosta/interim/api/Primitives.scala
@@ -5,6 +5,8 @@ import eu.joaocosta.interim._
 /** Object containing the default primitives.
   *
   * By convention, all components are functions in the form `def primitive(area, color, params...): Unit`.
+  *
+  * The area parameter can be either a `Rect` or a `LayoutAllocator`.
   */
 object Primitives extends Primitives