Skip to content

Commit 33b6f90

Browse files
author
runrevali
committed
[[ Docs ]] Update docs for std lc builder libraries
1 parent a00e5c8 commit 33b6f90

13 files changed

Lines changed: 40 additions & 25 deletions

File tree

‎libscript/src/arithmetic.mlc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
This library consists of the basic arithmetic operations of standard library of modular LiveCode.
2+
This library consists of the basic arithmetic operations of standard library of LiveCode Builder.
33
*/
44

55
module com.livecode.arithmetic

‎libscript/src/array.mlc‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
This library consists of the operations on arrays included in the standard library of modular LiveCode.
2+
This library consists of the operations on arrays included in the standard library of LiveCode Builder.
33
*/
44

55
module com.livecode.array
@@ -243,7 +243,7 @@ end syntax
243243

244244
/*
245245
Summary: Repeat over the elements of an array.
246-
Iterand: An expression of the form 'tVar in tArray'
246+
Iterand: Any variable of appropriate type.
247247

248248
Example:
249249
variable tArray as array
@@ -263,7 +263,9 @@ Example:
263263
// tSum is 6
264264

265265
Description:
266-
Use repeat for each element to iterate over the elements of an array in no particular order.
266+
Use repeat for each element to iterate over the elements of an array in no particular order. On each iteration, the <Iterand> will contain the next element of the array being iterated over.
267+
268+
>*Note:* If <Iterand> is typed, then an error will be thrown if the array being iterated over contains any elements of a different type.
267269

268270
Tags: Arrays
269271
*/
@@ -276,7 +278,7 @@ end syntax
276278

277279
/*
278280
Summary: Repeat over the keys of an array.
279-
Iterand: An expression of the form 'tVar in tArray'
281+
Iterand: A string container.
280282

281283
Example:
282284
variable tArray as array
@@ -297,7 +299,7 @@ Example:
297299
put tString contains "abc" into tBool -- tBool is true
298300

299301
Description:
300-
Use repeat for each key to iterate over the keys of an array in no particular order.
302+
Use repeat for each key to iterate over the keys of an array in no particular order. On each iteration, the <Iterand> will contain the next key of the array being iterated over.
301303

302304
Tags: Arrays, Control structures
303305
*/

‎libscript/src/binary.mlc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
This library consists of the operations on binary strings provided by the standard library of modular LiveCode.
2+
This library consists of the operations on binary strings provided by the standard library of LiveCode Builder.
33
*/
44

55
module com.livecode.binary

‎libscript/src/bitwise.mlc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
This module specifies the bitwise operations on integers included in the standard library of modular LiveCode.
2+
This module specifies the bitwise operations on integers included in the standard library of LiveCode Builder.
33
*/
44

55
module com.livecode.bitwise

‎libscript/src/byte.mlc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
This library consists of the operations on bytes included in the standard library of modular LiveCode.
2+
This library consists of the operations on bytes included in the standard library of LiveCode Builder.
33
*/
44

55
module com.livecode.byte
@@ -95,7 +95,7 @@ Summary: Finds the first or last occurrence of <Needle> before a spec
9595

9696
Needle: An expression which evaluates to binary data.
9797
Target: An expression which evaluates to binary data.
98-
After: An expression which evaluates to a valid integer index of Target.
98+
Before: An expression which evaluates to a valid integer index of Target.
9999

100100
Returns: Returns the offset of <Needle> before index <Before> in <Target>.
101101

@@ -237,10 +237,10 @@ end syntax
237237

238238
/*
239239
Summary: Repeat over the bytes of some data
240-
Iterand: An expression of the form 'tVar in tData'
240+
Iterand: A binary data container.
241241

242242
Description:
243-
Use repeat for each to perform an operation on each byte of some data.
243+
Use repeat for each to perform an operation on each byte of some data. On each iteration, the <Iterand> will contain the next char of the string being iterated over.
244244

245245
Tags: Binary, Control structures
246246
*/

‎libscript/src/char.mlc‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
This library consists of the operations on chars included in the standard library of modular LiveCode.
2+
This library consists of the operations on chars included in the standard library of LiveCode Builder.
33
*/
44

55
module com.livecode.char
@@ -121,7 +121,7 @@ end syntax
121121
/*
122122
Summary: Determines whether <Needle> is in <Source>.
123123
Needle: An expression which evaluates to a char.
124-
Target: An expression which evaluates to a string.
124+
Source: An expression which evaluates to a string.
125125

126126
Returns: True if <Needle> is among the chars of <Target>, and false otherwise.
127127

@@ -205,7 +205,7 @@ Summary: Finds the first or last occurrence of <Needle> before a spec
205205

206206
Needle: An expression which evaluates to a string.
207207
Target: An expression which evaluates to a string.
208-
After: An expression which evaluates to a valid integer index of Target.
208+
Before: An expression which evaluates to a valid integer index of Target.
209209

210210
Returns: Returns the offset of <Needle> before <Before> in <Target>.
211211

@@ -235,7 +235,7 @@ end syntax
235235
/*
236236
Summary: Determines whether <Source> contains <Needle>.
237237
Needle: An expression which evaluates to a string.
238-
Target: An expression which evaluates to a string.
238+
Source: An expression which evaluates to a string.
239239

240240
Returns: Returns true if <Source> contains <Needle>.
241241

@@ -341,7 +341,7 @@ end syntax
341341

342342
/*
343343
Summary: Repeat over the chars of a string
344-
Iterand: An expression of the form 'tChar in tString'
344+
Iterand: A string container.
345345

346346
Example:
347347
variable tString as string
@@ -357,7 +357,7 @@ Example:
357357
// tReversed is "desserts"
358358

359359
Description:
360-
Use repeat for each to perform an operation on each char of a string.
360+
Use repeat for each to perform an operation on each char of a string. On each iteration, the <Iterand> will contain the next char of the string being iterated over.
361361

362362
Tags: Strings, Control structures
363363
*/

‎libscript/src/list.mlc‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
This library consists of the operations on lists included in the standard library of modular LiveCode.
2+
This library consists of the operations on lists included in the standard library of LiveCode Builder.
33
*/
44

55
module com.livecode.list
@@ -673,7 +673,7 @@ end syntax
673673

674674
/*
675675
Summary: Repeat over the elements of a list
676-
Iterand: An expression of the form 'tVar in tList'
676+
Iterand: Any variable of appropriate type.
677677

678678
Example:
679679
variable tList as list
@@ -690,7 +690,8 @@ Example:
690690
// tRelist is the same as tList
691691

692692
Description:
693-
Use repeat for each to perform an operation on each element of a list.
693+
Use repeat for each to perform an operation on each element of a list. On each iteration, the Iterand will contain the next element of the list being iterated over.
694+
>*Note:* If <Iterand> is typed, then an error will be thrown if the list being iterated over contains any elements of a different type.
694695

695696
Tags: Lists, Control structures
696697
*/

‎libscript/src/logic.mlc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
/*
2+
This library consists of the logical operations included in the standard library of LiveCode Builder.
3+
*/
4+
15
module com.livecode.logic
26

37
//foreign handler MCLogicEvalAnd(in Left as bool, in Right as bool, out Value as bool) as undefined binds to "<builtin>"

‎libscript/src/math-foundation.mlc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
/*
2+
This library consists of the foundational mathematical operations included in the standard library of LiveCode Builder.
3+
*/
4+
15
module com.livecode.mathfoundation
26

37
public foreign handler MCMathFoundationExecRoundRealToNearest(inout Target as double) as undefined binds to "<builtin>"

‎libscript/src/math.mlc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
/*
2+
This library consists of the mathematical operations included in the standard library of LiveCode Builder.
3+
*/
14

25
module com.livecode.math
36

0 commit comments

Comments
 (0)