New auto-generated docs

Author: projectkk2glider

README.md

@@ -16,5 +16,7 @@ Part IV addresses common issues in converting Lua scripts that were originally w
 
 Part V covers advanced topics with examples
 
-
+[//]: <> (LUADOC-BEGIN:timestamp)
+<div class="footer">last updated on 2016/12/17 20:14:31 UTC</div>
+[//]: <> (LUADOC-END:timestamp)
 

SUMMARY.md

@@ -51,7 +51,7 @@
       * [model.deleteMixes()](model/deleteMixes.md)
       * [model.getCurve(curve)](model/getCurve.md)
       * [model.getCustomFunction(function)](model/getCustomFunction.md)
-      * [model.getGlobalVariable(index [, phase])](model/getGlobalVariable.md)
+      * [model.getGlobalVariable(index [, flight_mode])](model/getGlobalVariable.md)
       * [model.getInfo()](model/getInfo.md)
       * [model.getInput(input, line)](model/getInput.md)
       * [model.getInputsCount(input)](model/getInputsCount.md)
@@ -65,7 +65,7 @@
       * [model.insertMix(channel, line, value)](model/insertMix.md)
       * [model.resetTimer(timer)](model/resetTimer.md)
       * [model.setCustomFunction(function, value)](model/setCustomFunction.md)
-      * [model.setGlobalVariable(index, phase, value)](model/setGlobalVariable.md)
+      * [model.setGlobalVariable(index, flight_mode, value)](model/setGlobalVariable.md)
       * [model.setInfo(value)](model/setInfo.md)
       * [model.setLogicalSwitch(switch, value)](model/setLogicalSwitch.md)
       * [model.setModule(index, value)](model/setModule.md)

general/getValue.md

@@ -18,7 +18,8 @@ To get a telemetry value simply use it's sensor name. For example:
  * to get the current altitude use the source "Alt"
  * to get the minimum altitude use the source "Alt-", to get the maximum use "Alt+"
 
-@status current Introduced in 2.0.0, changed in 2.1.0
+@status current Introduced in 2.0.0, changed in 2.1.0, `Cels+` and 
+`Cels-` added in 2.1.9
 
 
 #### Parameters
@@ -53,6 +54,8 @@ case the returned value is 0):
 
 ##### Notice
 Getting a value by its numerical identifier is faster then by its name.
+While `Cels` sensor returns current values of all cells in a table, a `Cels+` or 
+`Cels-` will return a single value - the maximum or minimum Cels value.
 
 
 

model/getGlobalVariable.md

@@ -1,6 +1,6 @@
 <!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
 
-## model.getGlobalVariable(index [, phase])
+## model.getGlobalVariable(index [, flight_mode])
 
 
 
@@ -9,7 +9,7 @@ Return current global variable value
 Example:
 
 ```lua
-  -- get GV3 (index = 2) from flight phase 1 (phase = 0)
+  -- get GV3 (index = 2) from Flight mode 0 (FM0)
   val = model.getGlobalVariable(2, 0)
 ```
 
@@ -18,7 +18,7 @@ Example:
 
 * `index`  zero based global variable index, use 0 for GV1, 8 for GV9
 
-* `phase`  zero based phase index, use 0 for Phase 1, 5 for Phase 6
+* `flight_mode`  Flight mode number (0 = FM0, 8 = FM8)
 
 
 

model/setGlobalVariable.md

@@ -1,6 +1,6 @@
 <!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
 
-## model.setGlobalVariable(index, phase, value)
+## model.setGlobalVariable(index, flight_mode, value)
 
 
 
@@ -11,24 +11,21 @@ Sets current global variable value. See also model.getGlobalVariable()
 
 * `index`  zero based global variable index, use 0 for GV1, 8 for GV9
 
-* `phase`  zero based phase index, use 0 for Phase 1, 5 for Phase 6
-   
+* `flight_mode`  Flight mode number (0 = FM0, 8 = FM8)
+
 * `value`  new value for global variable. Permitted range is
-from -1024 to 1024. 
-    
+from -1024 to 1024.
+
 
 
 #### Return value
 
 none
 
 ##### Notice
-If a parameter is missing from the value, then 
-that parameter remains unchanged.
-
-
-Global variable can only store integer values, 
-any floating point value is converted (todo check how) into integer value.
+Global variable can only store integer values,
+any floating point value is converted into integer value
+by truncating everything behind a floating point.
 
 
 

styles/luaref.css

@@ -18,3 +18,10 @@
     color: white !important;
     padding: 0.5em;
 }
+
+.footer {
+    text-align: center;
+    font-size: 70%;
+    color: grey;
+    padding: 0.5em;
+}