[sr-dev] git:master:7b0ad6b1: app_jsdt Minor update to documentation

Module: kamailio Branch: master Commit: 7b0ad6b1a11687d035d4be92202ae1379f07fb20 URL: https://github.com/kamailio/kamailio/commit/7b0ad6b1a11687d035d4be92202ae13… Author: Olle E. Johansson &lt;oej(a)edvina.net&gt; Committer: Olle E. Johansson &lt;oej(a)edvina.net&gt; Date: 2018-03-08T13:08:08+01:00 app_jsdt Minor update to documentation --- Modified: src/modules/app_jsdt/doc/app_jsdt_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/7b0ad6b1a11687d035d4be92202ae13… Patch: https://github.com/kamailio/kamailio/commit/7b0ad6b1a11687d035d4be92202ae13… --- diff --git a/src/modules/app_jsdt/doc/app_jsdt_admin.xml b/src/modules/app_jsdt/doc/app_jsdt_admin.xml index b0926256d4..d4fd89d377 100644 --- a/src/modules/app_jsdt/doc/app_jsdt_admin.xml +++ b/src/modules/app_jsdt/doc/app_jsdt_admin.xml @@ -17,15 +17,16 @@ <section> <title>Overview</title> <para> - This module allows executing JavaScript scripts from config file. + This module allows executing JavaScript scripts from the Kamailio + configuration file. It exports all KEMI functions to JavaScript in order to access the - current processed SIP message. These functions are within JavaScript - object 'KSR'. + currently processed SIP message. These functions are named within + the JavaScript object 'KSR'. </para> <para> - It includes the Duktape JavaScript engine (http://www.duktape.org), - which is a fast and easy to embed JavaScript interpreter. Exported API - from SIP router to JavaScript is documented in the dokuwiki. + The module is based on the Duktape JavaScript engine (http://www.duktape.org), + which is a fast and easy to embed JavaScript interpreter. The exported API + from Kamailio to JavaScript is documented in the wiki. </para> <para> The module has two JavaScript contexts: @@ -42,7 +43,7 @@ and parameter 'load'. Therefore jsdt_run() cannot execute functions from scripts loaded via jsdt_dofile() in config. This is kind of caching mode, avoiding reading file every time, but you must be sure - you do not have something that is executed by default and requires + you do not have someting that is executed by default and requires access to SIP message. This environment is also used by KEMI framework for the config SIP routing functions. </para> @@ -74,7 +75,7 @@ <listitem> <para> <emphasis>libm</emphasis> - the math library (part of standard - system libraries - it is needed to compile embedded Duktape JS + system libraries - it is needed to complile embedded Duktape JS interpreter). </para> </listitem> @@ -116,7 +117,7 @@ modparam("app_jsdt", "load", "/usr/local/etc/kamailio/js/myscript.js") <function moreinfo="none">jsdt_dofile(path)</function> </title> <para> - Execute the JS script stored in 'path'. The parameter can be + Execute the JavaScript script stored in 'path'. The parameter can be a string with pseudo-variables evaluated at runtime. </para> <example> @@ -134,7 +135,7 @@ jsdt_dofile("/usr/local/etc/kamailio/js/myscript.js"); <function moreinfo="none">jsdt_dostring(script)</function> </title> <para> - Execute the Lua script stored in parameter. The parameter can be + Execute the JavaScript script stored in parameter. The parameter can be a string with pseudo-variables. </para> <example> @@ -248,7 +249,7 @@ if(!jsdt_runstring('KSR.dbg("Hello World from $fU\n")')) <section> <title>Example of usage</title> <para> - Create your JS script and stored on file system, + Create your JS script and store it on the file system, say: '/usr/local/etc/kamailio/js/myscript.js'. </para> <programlisting format="linespecific">