Skip to content

Commit 4548593

Browse files
committed
[Docs] Fix missing parameter descriptions
1 parent a69914e commit 4548593

4 files changed

Lines changed: 37 additions & 39 deletions

File tree

docs/dictionary/command/export-snapshot.lcdoc

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,10 @@ The desired file format to save.
6161
- GIF: Graphics Interchange Format
6262
- PNG: Portable Network Graphics
6363

64-
6564
maskFile:
6665
Specifies the name and location of a file to export as an image mask.
6766
You can use a maskFile only when exporting in PBM format (paint).
6867

69-
suffix:
70-
The usual possible suffixes for the export snapshot command.
71-
7268
Description:
7369
Use the <export snapshot> <command> to export a screenshot to a <file>
7470
or <container>.

docs/dictionary/command/play-video.lcdoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Name: play video
22

33
Type: command
44

5-
Syntax: play video {<video-file> | <video-url>}
5+
Syntax: play video {<videoFile> | <videoUrl>}
66

77
Summary:
88
Plays a full screen video.
@@ -61,9 +61,13 @@ command. This will use the <startTime> and <endTime> properties of the
6161
properties are interpreted as the number of milliseconds from the
6262
beginning of the video.
6363

64+
Parameters:
65+
videoFile (string): The path to a video file to play.
66+
67+
videoUrl (string): The url of a video file to play.
68+
6469
References: play stop (command), play (command), templatePlayer (keyword),
6570
movieTouched (message), looping (property), endTime (property),
6671
playSelection (property), showController (property), startTime (property)
6772

6873
Tags: multimedia
69-

docs/dictionary/function/binaryDecode.lcdoc

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,18 +29,9 @@ binaryDecode(myFormat,placeHolder,importantStuff)
2929
Parameters:
3030
formatsList:
3131
The <formatsList> consists of one or more dataTypes, each followed
32-
optionally by an amount. A dataType is one of the following single
33-
letters: x: skip next amount bytes of data
32+
optionally by an amount. A dataType is one of the following single letters:
3433

35-
data (string):
36-
A string of encoded binary data.
37-
38-
variablesList:
39-
A comma-separated list of local or global variable names. The number of
40-
variable names must be the same as the number of dataTypes specified in
41-
the <formatsList>, and the variables must already exist.
42-
43-
amount:
34+
- x: skip next amount bytes of data
4435
- a: convert next amount bytes of data to characters
4536
- A: convert next amount bytes of data (skipping spaces) to characters
4637
- b: convert next amount bits of data to 1s and 0s
@@ -74,6 +65,14 @@ For example, the dataType "a3" requires only one variable, which will
7465
hold a 3-characterstring, but the dataType "h3" requires three
7566
variables, each of which will hold a single hex digit.
7667

68+
data (string):
69+
A string of encoded binary data.
70+
71+
variablesList:
72+
A comma-separated list of local or global variable names. The number of
73+
variable names must be the same as the number of dataTypes specified in
74+
the <formatsList>, and the variables must already exist.
75+
7776
Returns:
7877
The <binaryDecode> <function> <return|returns> the number of dataTypes
7978
that were successfully converted and placed in <variable|variables> (not

docs/dictionary/function/binaryEncode.lcdoc

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -28,28 +28,10 @@ charToNum(binaryEncode("B*","01111111")) -- returns 127
2828
Parameters:
2929
formatsList:
3030
The <formatsList> consists of one or more dataTypes, each followed
31-
optionally by an amount. A dataType is one of the following single
32-
letters: x: output amount null characters
31+
optionally by an amount.
3332

34-
dataStringList (string):
35-
A comma-separated list of dataStrings. Each dataString is a string, or
36-
an expression that evaluates to a string.
37-
38-
amount (enum):
39-
40-
- If the dataType is a, A, b, B, h, or H, the amount specifies the
41-
number of characters or groups of the dataString to use; extra
42-
characters are ignored. The * character Encodes the rest of the data
43-
in the current dataString. If no amount is specified, the dataType is
44-
used for one character.
45-
- If the dataType is c, C, s, S, i, I, n, N, m, M, f, or d, the amount
46-
specifies the number of dataStrings to encode. The * character
47-
Encodes the rest of the dataStrings. If no amount is specified, the
48-
dataType is used for one dataString.
49-
- If the dataType is x, the amount specifies how many nulls to place in
50-
the returned value.
33+
A dataType is one of the following letters:
5134

52-
One of the following items:
5335
- c: encode amount numbers as signed 1-byte integers
5436
- C: encode amount numbers as unsigned 1-byte integers
5537
- s: encode amount numbers as signed 2-byte integers in host byte order
@@ -62,9 +44,26 @@ One of the following items:
6244
- M: encode amount numbers as unsigned 4-byte integers in network byte order
6345
- f: encode amount numbers as single-precision floating-point numbers
6446
- d: encode amount numbers as double-precision floating-point numbers
65-
66-
The amount corresponding to each dataType is an integer or the * character:
47+
- x: encode amount null characters
6748

49+
The amount is an integer or * and specifies the encoding in the
50+
following way:
51+
52+
- If the dataType is a, A, b, B, h, or H, the amount specifies the
53+
number of characters or groups of the dataString to use; extra
54+
characters are ignored. The * character Encodes the rest of the data
55+
in the current dataString. If no amount is specified, the dataType is
56+
used for one character.
57+
- If the dataType is c, C, s, S, i, I, n, N, m, M, f, or d, the amount
58+
specifies the number of dataStrings to encode. The * character
59+
Encodes the rest of the dataStrings. If no amount is specified, the
60+
dataType is used for one dataString.
61+
- If the dataType is x, the amount specifies how many nulls to place in
62+
the returned value.
63+
64+
dataStringList (string):
65+
A comma-separated list of dataStrings. Each dataString is a string, or
66+
an expression that evaluates to a string.
6867

6968
Returns:
7069
The <binaryEncode> <function> <return|returns> the binary string

0 commit comments

Comments
 (0)