jcarr
/
noVNC
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Follow current MDN for syntax examples 

The now avoid brackets for optional arguments, so let's try to have the
same style.
This commit is contained in:
Pierre Ossman 2022-12-27 15:00:39 +01:00
parent 74fe694cc4
commit 934e3de356
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/API.md
View File

@ -184,7 +184,8 @@ connection to a specified VNC server.
##### Syntax ##### Syntax
let rfb = new RFB( target, urlOrChannel [, options] ); new RFB( target, urlOrChannel );
new RFB( target, urlOrChannel, options );
###### Parameters ###### Parameters
@ -364,7 +365,8 @@ Keyboard events will be sent to the remote server after this point.
##### Syntax ##### Syntax
RFB.focus( [options] ); RFB.focus( );
RFB.focus( options );
###### Parameters ###### Parameters
@ -447,7 +449,8 @@ The `RFB.sendKey()` method is used to send a key event to the server.
##### Syntax ##### Syntax
RFB.sendKey( keysym, code [, down] ); RFB.sendKey( keysym, code );
RFB.sendKey( keysym, code, down );
###### Parameters ###### Parameters