kjuulh/rhai
1
0
Fork 0
Code Issues 1 Pull Requests 1 Packages Projects Releases Wiki Activity

Edit documentation.

Browse Source
This commit is contained in:
Stephen Chung
2020-06-22 00:03:45 +08:00
parent 7cc1a3f5dc
commit d728ac6758
37 changed files with 386 additions and 147 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/src/appendix/index.md Normal file
View File

@@ -0,0 +1,6 @@
Appendix
========
{{#include ../links.md}}
This section contains miscellaneous reference materials.

30
doc/src/appendix/keywords.md Normal file
View File

@@ -0,0 +1,30 @@
Keywords List
=============
{{#include ../links.md}}
| Keyword | Description |
| :--------: | ------------------------------------- |
| `true` | Boolean true literal |
| `false` | Boolean false literal |
| `let` | Variable declaration |
| `const` | Constant declaration |
| `if` | If statement |
| `else` | else block of if statement |
| `while` | While loop |
| `loop` | Infinite loop |
| `for` | For loop |
| `in` | Containment test, part of for loop |
| `continue` | Continue a loop at the next iteration |
| `break` | Loop breaking |
| `return` | Return value |
| `throw` | Throw exception |
| `private` | Mark function private |
| `import` | Import module |
| `export` | Export variable |
| `as` | Alias for variable export |
| `fn` | Function definition |
| `type_of` | Get type name of value |
| `print` | Print value |
| `debug` | Print value in debug format |
| `eval` | Evaluate script |

16
doc/src/appendix/literals.md Normal file
View File

@@ -0,0 +1,16 @@
Literals Syntax
===============
{{#include ../links.md}}
| Type | Literal syntax |
| :--------------------------------: | :---------------------------------------: |
| `INT` | `42`, `-123`, `0` |
| `FLOAT` | `42.0`, `-123.456`, `0.0` |
| [String] | `"... \x?? \u???? \U???????? ..."` |
| Character | `"... \x?? \u???? \U???????? ..."` |
| [`Array`] | `[ ???, ???, ??? ]` |
| [Object map] | `#{ a: ???, b: ???, c: ???, "def": ??? }` |
| Boolean true | `true` |
| Boolean false | `false` |
| `Nothing`/`null`/`nil`/`void`/Unit | `()` |

30
doc/src/appendix/operators.md Normal file
View File

@@ -0,0 +1,30 @@
Operators
=========
{{#include ../links.md}}
| Operator | Description | Binary? |
| :---------------: | ---------------------------- | :-----: |
| `+` | Add | Yes |
| `-` | Subtract, Minus | Yes/No |
| `*` | Multiply | Yes |
| `/` | Divide | Yes |
| `%` | Modulo | Yes |
| `~` | Power | Yes |
| `>>` | Right bit-shift | Yes |
| `<<` | Left bit-shift | Yes |
| `&` | Bit-wise AND, Boolean AND | Yes |
| <code>\|</code> | Bit-wise OR, Boolean OR | Yes |
| `^` | Bit-wise XOR | Yes |
| `==` | Equals to | Yes |
| `~=` | Not equals to | Yes |
| `>` | Greater than | Yes |
| `>=` | Greater than or equals to | Yes |
| `<` | Less than | Yes |
| `<=` | Less than or equals to | Yes |
| `>=` | Greater than or equals to | Yes |
| `&&` | Boolean AND (short-circuits) | Yes |
| <code>\|\|</code> | Boolean OR (short-circuits) | Yes |
| `~` | Boolean NOT | No |
| `[` .. `]` | Indexing | Yes |
| `.` | Property access, Method call | Yes |