Doxygen code comment cleanups and fixes. No code changes. (0.41.5)
This commit is contained in:
parent
4309ec2a52
commit
892fa3cfbf
88 changed files with 224 additions and 265 deletions
|
|
@ -24,9 +24,9 @@
|
|||
* - Exits with an error if the array is empty.
|
||||
*
|
||||
* Example:
|
||||
* // Bytecode: OP_APOP
|
||||
* // Stack before: [[10, 20, 30]]
|
||||
* // Stack after: [30]
|
||||
* - Bytecode: OP_APOP
|
||||
* - Stack before: [[10, 20, 30]]
|
||||
* - Stack after: [30]
|
||||
*/
|
||||
|
||||
case OP_APOP: {
|
||||
|
|
|
|||
|
|
@ -24,9 +24,9 @@
|
|||
* - Exits with a runtime error if the operand is not an array.
|
||||
|
||||
* Example:
|
||||
* // Bytecode: OP_CLEAR
|
||||
* // Stack before: [[10, 20, 30]]
|
||||
* // Stack after: [0]
|
||||
* - Bytecode: OP_CLEAR
|
||||
* - Stack before: [[10, 20, 30]]
|
||||
* - Stack after: [0]
|
||||
*/
|
||||
|
||||
case OP_CLEAR: {
|
||||
|
|
|
|||
|
|
@ -23,9 +23,9 @@
|
|||
* - Exits with an error if the array is of the wrong type.
|
||||
*
|
||||
* Example:
|
||||
* // Bytecode: OP_CONTAINS
|
||||
* // Stack before: [20, [10, 20, 30]]
|
||||
* // Stack after: [1]
|
||||
* - Bytecode: OP_CONTAINS
|
||||
* - Stack before: [20, [10, 20, 30]]
|
||||
* - Stack after: [1]
|
||||
*/
|
||||
|
||||
case OP_CONTAINS: {
|
||||
|
|
|
|||
|
|
@ -23,9 +23,9 @@
|
|||
* - Exits with an error if the array is of the wrong type.
|
||||
*
|
||||
* Example:
|
||||
* // Bytecode: OP_ENUMERATE
|
||||
* // Stack before: [[10, 20, 30]]
|
||||
* // Stack after: [[[0, 10], [1, 20], [2, 30]]]
|
||||
* - Bytecode: OP_ENUMERATE
|
||||
* - Stack before: [[10, 20, 30]]
|
||||
* - Stack after: [[[0, 10], [1, 20], [2, 30]]]
|
||||
*/
|
||||
|
||||
case OP_ENUMERATE: {
|
||||
|
|
|
|||
|
|
@ -25,9 +25,9 @@
|
|||
* is of the wrong type, or if the index is out of bounds.
|
||||
*
|
||||
* Example:
|
||||
* // Bytecode: OP_INDEX_GET
|
||||
* // Stack before: [1, [10, 20, 30]]
|
||||
* // Stack after: [20]
|
||||
* - Bytecode: OP_INDEX_GET
|
||||
* - Stack before: [1, [10, 20, 30]]
|
||||
* - Stack after: [20]
|
||||
*/
|
||||
|
||||
case OP_INDEX_GET: {
|
||||
|
|
|
|||
|
|
@ -23,9 +23,9 @@
|
|||
* - Exits with an error if the array is of the wrong type.
|
||||
*
|
||||
* Example:
|
||||
* // Bytecode: OP_INDEX_OF
|
||||
* // Stack before: [20, [10, 20, 30]]
|
||||
* // Stack after: [1]
|
||||
* - Bytecode: OP_INDEX_OF
|
||||
* - Stack before: [20, [10, 20, 30]]
|
||||
* - Stack after: [1]
|
||||
*/
|
||||
|
||||
case OP_INDEX_OF: {
|
||||
|
|
|
|||
|
|
@ -24,9 +24,9 @@
|
|||
* is of the wrong type, or if the index is out of bounds.
|
||||
*
|
||||
* Example:
|
||||
* // Bytecode: OP_INDEX_SET
|
||||
* // Stack before: [42, 1, [10, 20, 30]]
|
||||
* // Stack after: [[10, 42, 30]]
|
||||
* - Bytecode: OP_INDEX_SET
|
||||
* - Stack before: [42, 1, [10, 20, 30]]
|
||||
* - Stack after: [[10, 42, 30]]
|
||||
*/
|
||||
|
||||
case OP_INDEX_SET: {
|
||||
|
|
|
|||
|
|
@ -25,9 +25,9 @@
|
|||
* - Exits with an error if memory allocation fails during the insertion.
|
||||
*
|
||||
* Example:
|
||||
* // Bytecode: OP_INSERT
|
||||
* // Stack before: [42, 1, [10, 20, 30]]
|
||||
* // Stack after: [4]
|
||||
* - Bytecode: OP_INSERT
|
||||
* - Stack before: [42, 1, [10, 20, 30]]
|
||||
* - Stack after: [4]
|
||||
*/
|
||||
|
||||
case OP_INSERT: {
|
||||
|
|
|
|||
|
|
@ -24,9 +24,9 @@
|
|||
* - Exits with an error if the array or separator is of the wrong type.
|
||||
*
|
||||
* Example:
|
||||
* // Bytecode: OP_JOIN
|
||||
* // Stack before: [", ", ["a", "b", "c"]]
|
||||
* // Stack after: ["a, b, c"]
|
||||
* - Bytecode: OP_JOIN
|
||||
* - Stack before: [", ", ["a", "b", "c"]]
|
||||
* - Stack after: ["a, b, c"]
|
||||
*/
|
||||
|
||||
case OP_JOIN: {
|
||||
|
|
|
|||
|
|
@ -24,9 +24,9 @@
|
|||
* - Exits with an error if `n` is invalid or if memory allocation fails.
|
||||
*
|
||||
* Example:
|
||||
* // Bytecode: OP_MAKE_ARRAY 3
|
||||
* // Stack before: [1, 2, 3]
|
||||
* // Stack after: [[1, 2, 3]]
|
||||
* - Bytecode: OP_MAKE_ARRAY 3
|
||||
* - Stack before: [1, 2, 3]
|
||||
* - Stack after: [[1, 2, 3]]
|
||||
*/
|
||||
|
||||
case OP_MAKE_ARRAY: {
|
||||
|
|
|
|||
|
|
@ -25,9 +25,9 @@
|
|||
* - Exits with a runtime error if memory allocation fails.
|
||||
*
|
||||
* Example:
|
||||
* // Bytecode: OP_PUSH
|
||||
* // Stack before: [42, [10, 20, 30]]
|
||||
* // Stack after: [4]
|
||||
* - Bytecode: OP_PUSH
|
||||
* - Stack before: [42, [10, 20, 30]]
|
||||
* - Stack after: [4]
|
||||
*/
|
||||
|
||||
case OP_PUSH: {
|
||||
|
|
|
|||
|
|
@ -25,9 +25,9 @@
|
|||
* - Exits with a runtime error if the index is out of bounds.
|
||||
*
|
||||
* Example:
|
||||
* // Bytecode: OP_REMOVE
|
||||
* // Stack before: [1, [10, 20, 30]]
|
||||
* // Stack after: [20]
|
||||
* - Bytecode: OP_REMOVE
|
||||
* - Stack before: [1, [10, 20, 30]]
|
||||
* - Stack after: [20]
|
||||
*/
|
||||
|
||||
case OP_REMOVE: {
|
||||
|
|
|
|||
|
|
@ -25,9 +25,9 @@
|
|||
* - Exits with a runtime error if the index is out of bounds.
|
||||
*
|
||||
* Example:
|
||||
* // Bytecode: OP_SET
|
||||
* // Stack before: [42, 1, [10, 20, 30]]
|
||||
* // Stack after: [42]
|
||||
* - Bytecode: OP_SET
|
||||
* - Stack before: [42, 1, [10, 20, 30]]
|
||||
* - Stack after: [42]
|
||||
*/
|
||||
|
||||
case OP_SET: {
|
||||
|
|
|
|||
|
|
@ -24,9 +24,9 @@
|
|||
* - Handles negative indices and out-of-bounds cases gracefully
|
||||
*
|
||||
* Example:
|
||||
* // Bytecode: OP_SLICE
|
||||
* // Stack before: [3, 1, [10,20,30,40]]
|
||||
* // Stack after: [[20,30]]
|
||||
* - Bytecode: OP_SLICE
|
||||
* - Stack before: [3, 1, [10,20,30,40]]
|
||||
* - Stack after: [[20,30]]
|
||||
*/
|
||||
|
||||
case OP_SLICE: {
|
||||
|
|
|
|||
|
|
@ -24,9 +24,9 @@
|
|||
* - Exits with error if arguments aren't arrays
|
||||
*
|
||||
* Example:
|
||||
* // Bytecode: OP_ZIP
|
||||
* // Stack before: [[1,2], ['a','b']]
|
||||
* // Stack after: [[[1,'a'], [2,'b']]]
|
||||
* - Bytecode: OP_ZIP
|
||||
* - Stack before: [[1,2], ['a','b']]
|
||||
* - Stack after: [[[1,'a'], [2,'b']]]
|
||||
*/
|
||||
|
||||
case OP_ZIP: {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue