diff options
| author | Pierre Ossman <ossman@cendio.se> | 2022-12-27 15:00:39 +0100 |
|---|---|---|
| committer | Pierre Ossman <ossman@cendio.se> | 2022-12-27 15:00:39 +0100 |
| commit | 934e3de356988bf8676c1056acc3c0825051765c (patch) | |
| tree | dcf22f11a76cb54e77b153efa225ec8679bb5db4 | |
| parent | 74fe694cc4ae6239cbb4f7b65b7da8cef4778e2a (diff) | |
| download | novnc-934e3de356988bf8676c1056acc3c0825051765c.tar.gz | |
Follow current MDN for syntax examples
The now avoid brackets for optional arguments, so let's try to have the
same style.
| -rw-r--r-- | docs/API.md | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/API.md b/docs/API.md index 3e9e75c..eed9e80 100644 --- a/docs/API.md +++ b/docs/API.md @@ -184,7 +184,8 @@ connection to a specified VNC server. ##### Syntax - let rfb = new RFB( target, urlOrChannel [, options] ); + new RFB( target, urlOrChannel ); + new RFB( target, urlOrChannel, options ); ###### Parameters @@ -364,7 +365,8 @@ Keyboard events will be sent to the remote server after this point. ##### Syntax - RFB.focus( [options] ); + RFB.focus( ); + RFB.focus( options ); ###### Parameters @@ -447,7 +449,8 @@ The `RFB.sendKey()` method is used to send a key event to the server. ##### Syntax - RFB.sendKey( keysym, code [, down] ); + RFB.sendKey( keysym, code ); + RFB.sendKey( keysym, code, down ); ###### Parameters |