chore: Link to demo actualized.

Author: SeriousSoftware

build.sbt

@@ -19,6 +19,7 @@ normalizedName := "main"
 scalaVersion in ThisBuild := "2.11.8"
 
 libraryDependencies ++= Seq(
+  "be.doeraene"   %%% "scalajs-jquery" % "0.9.0",
   "org.scala-js"  %%% "scalajs-dom" % "0.9.1",
   "org.scalatest" %%% "scalatest"   % "3.0.0" % "test",
   "com.lihaoyi"   %%% "scalatags"   % "0.6.0"

src/main/scala-2.11/nl/amsscala/simplegame/Page.scala

@@ -5,12 +5,10 @@ import org.scalajs.dom
 
 import scalatags.JsDom.all._
 
-/**
- *
- */
+/** All related to Html5 visuals */
 protected trait Page {
   // Create the canvas
-  protected val canvas = dom.document.createElement("canvas").asInstanceOf[dom.html.Canvas]
+  private[simplegame] val canvas = dom.document.createElement("canvas").asInstanceOf[dom.html.Canvas]
   canvas.setAttribute("crossOrigin", "anonymous")
   private[this] val ctx = canvas.getContext("2d") // .asInstanceOf[dom.CanvasRenderingContext2D]
   private[this] val (bgImage, heroImage, monsterImage) = (Image("img/background.png"), Image("img/hero.png"), Image("img/monster.png"))

src/main/scala-2.11/nl/amsscala/simplegame/game.scala

@@ -7,9 +7,7 @@ import org.scalajs.dom.ext.KeyCode.{ Down, Left, Right, Up }
 import scala.collection.mutable
 import scala.scalajs.js
 
-/**
- *
- */
+/** The game with its rules. */
 protected trait Game {
   private[this] val framesPerSec = 30
 
@@ -129,7 +127,7 @@ private case class GameState(
 }
 
 /**
- * Monster class, holder for its coordinates, copied as extentension to the Hero class
+ * Monster class, holder for its coordinate, copied as extentension to the Hero class
  *
  * @param pos Monsters' position
  * @tparam T  Numeric generic abstraction

src/main/scala-2.11/nl/amsscala/simplegame/package.scala

@@ -1,21 +1,20 @@
 package nl.amsscala
 
 /**
- * Provides generic class and operators for dealing with 2D positions.
- * As well dealing with 2D areas.
+ * Provides generic class and operators for dealing with 2D positions. As well dealing with 2D areas.
  */
 package object simplegame {
-  // Experimental timestamp and position, displacement is a function of time
-  type keysBufferType = scala.collection.mutable.Map[Int, (Double, Position[Int])]
+  /** Experimental timestamp and position, displacement is a function of time */
+  protected[simplegame]type keysBufferType = scala.collection.mutable.Map[Int, (Double, Position[Int])]
 
   /**
-   * Generic base class Position, holding the two coordinates
+   * Generic base class Position, holding the two ordinates
    *
-   * @param x
-   * @param y
-   * @tparam P
+   * @param x  The abscissa
+   * @param y  The ordinate
+   * @tparam P Numeric type
    */
-  case class Position[P: Numeric](x: P, y: P) {
+  protected[simplegame] case class Position[P: Numeric](x: P, y: P) {
 
     import Numeric.Implicits.infixNumericOps
     import Ordering.Implicits.infixOrderingOps
@@ -45,9 +44,9 @@ package object simplegame {
     /**
      * Check if the square area is within the rectangle area
      *
-     * @param canvasPos
-     * @param side
-     * @return
+     * @param canvasPos Position of the second square
+     * @param side      side of both two squares
+     * @return          False  if a square out of bound
      */
     def isValidPosition(canvasPos: Position[P], side: P): Boolean = {
       // println(s"Testing: $x, $y")

src/test/scala-2.11/nl/amsscala/simplegame/PageSuite.scala

@@ -3,7 +3,7 @@ package nl.amsscala.simplegame
 import org.scalajs.dom
 
 class PageSuite extends SuiteSpec /*with Page*/ {
-val page = new Page {}
+  val page = new Page {}
   describe("A Hero") {
     describe("should tested within the limits") {