lib/emscripten: add missing doc

Signed-off-by: Alexis Laferrière <alexis.laf@xymus.net>

diff --git a/lib/emscripten.nit b/lib/emscripten.nit
index 3b4b5aa..3fd2fff 100644 (file)
--- a/lib/emscripten.nit
+++ b/lib/emscripten.nit
@@ -14,6 +14,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# Platform for the _emscripten_ framework
+#
+# Importing this module from your project will tell _nitg_ to compile
+# to JavaScript for the _emscripten_ framework.
 module emscripten is platform
 
 `{
@@ -22,11 +26,15 @@ module emscripten is platform
 `}
 
 redef class Text
+       # Run `self` as JavaScript code
        fun run_js do run_js_native(self.escape_to_js.to_cstring)
+
        private fun run_js_native(script: NativeString) `{ emscripten_run_script(script); `}
 
-       fun escape_to_js: String do return self.replace('\n', "\\n")
+       # Escape the content of `self` to pass to JavaScript code
+       fun escape_to_js: Text do return replace('\n', "\\n")
 
+       # Raise a JavaScript alert
        fun alert do "alert('{self.escape_to_js}')".run_js
 end