Documentation in protoblocks.js #3830

hackorlyf · 2024-03-18T17:17:52Z

No description provided.

…locks into jsDocumentation

…o jsDocumentation

…locks into jsDocumentation

walterbender · 2024-03-26T21:46:54Z

js/protoblocks.js

@@ -527,6 +632,9 @@ class ProtoBlock {
    }
    // E.g., distance . Distance block will calculate geometrical distance between two pointa


Maybe this "e.g." belongs in the comment block below (L636)

Thank you for the rectification walter. I'll correct it and get back to you.

I had made the necessary changes. Let me know if it's up to Mark or not.

walterbender · 2024-04-01T22:23:22Z

js/protoblocks.js

@@ -222,6 +263,10 @@ class ProtoBlock {
    }

    // E.g., forward, right


you should delete this line.

@walterbender Shifted all the respective comments mentioned by you. Thank you for showing me the ropes.

walterbender · 2024-04-01T22:23:55Z

js/protoblocks.js

@@ -252,6 +301,9 @@ class ProtoBlock {
    }

    // E.g., wait for


this line should move into the description below.

walterbender · 2024-04-01T22:24:07Z

js/protoblocks.js

@@ -284,6 +340,9 @@ class ProtoBlock {
    }

    // E.g., setxy. These are expandable.


And this one.

walterbender · 2024-04-01T22:24:37Z

js/protoblocks.js

@@ -325,6 +389,9 @@ class ProtoBlock {
    }

    // E.g., ??? These are expandable.


this one can stay.

walterbender · 2024-04-01T22:24:57Z

js/protoblocks.js

@@ -409,6 +490,10 @@ class ProtoBlock {
    }

    // E.g., sqrt, box


move this one...

walterbender · 2024-04-01T22:25:07Z

js/protoblocks.js

@@ -442,6 +531,10 @@ class ProtoBlock {
    }

    // E.g., plus, minus, multiply, divide, power,distance. These are also expandable.


and this one

walterbender · 2024-04-01T22:25:31Z

js/protoblocks.js

@@ -572,6 +686,9 @@ class ProtoBlock {

    // E.g., number, string. Value blocks get DOM textareas associated


this should move

walterbender · 2024-04-01T22:25:58Z

js/protoblocks.js

@@ -633,6 +759,11 @@ class ProtoBlock {

    // E.g., start. A "child" flow is docked in an expandable clamp.


these should move

walterbender · 2024-04-01T22:26:11Z

js/protoblocks.js

@@ -672,6 +808,9 @@ class ProtoBlock {
    }

    // E.g., emptyclamp. Unlike start, there is a flow above and below.


move this one

walterbender · 2024-04-01T22:26:23Z

js/protoblocks.js

@@ -711,6 +855,9 @@ class ProtoBlock {
    }

    // E.g., repeat. Unlike action, there is a flow above and below.


move this one...

walterbender · 2024-04-01T22:26:36Z

js/protoblocks.js

@@ -753,6 +905,9 @@ class ProtoBlock {

    // E.g., tuplet, which takes two args plus an interior flow.


move this one

walterbender · 2024-04-01T22:26:55Z

js/protoblocks.js

@@ -753,6 +905,9 @@ class ProtoBlock {

    // E.g., tuplet, which takes two args plus an interior flow.
    // There is a flow above and below.


and this one

walterbender · 2024-04-01T22:27:07Z

js/protoblocks.js

@@ -835,6 +1003,9 @@ class ProtoBlock {
    }

    // E.g., do with args: innies instead of interior slots.


and this one

walterbender · 2024-04-01T22:27:21Z

js/protoblocks.js

@@ -877,6 +1053,9 @@ class ProtoBlock {
    }

    // E.g., calculate with args: innies instead of interior slots.


walterbender · 2024-04-01T22:27:29Z

js/protoblocks.js

@@ -919,6 +1103,9 @@ class ProtoBlock {
    }

    // E.g., named do with args: innies instead of interior slots.


and this one

walterbender · 2024-04-01T22:27:38Z

js/protoblocks.js

@@ -956,6 +1148,9 @@ class ProtoBlock {
    }

    // E.g., named calculate with args: innies instead of interior slots.


and this one

walterbender · 2024-04-01T22:27:48Z

js/protoblocks.js

@@ -995,6 +1195,9 @@ class ProtoBlock {

    // E.g., if.  A "child" flow is docked in an expandable clamp. The


and this one

walterbender · 2024-04-01T22:27:58Z

js/protoblocks.js

@@ -1037,6 +1245,10 @@ class ProtoBlock {
    // E.g., if then else.  Two "child" flows are docked in expandable


and this one

walterbender · 2024-04-01T22:28:15Z

js/protoblocks.js

@@ -1086,6 +1304,10 @@ class ProtoBlock {
    }

    // E.g., forever. Unlike start, there is flow above and below.


and this one

walterbender · 2024-04-01T22:28:25Z

js/protoblocks.js

@@ -1124,6 +1351,10 @@ class ProtoBlock {
    }

    // E.g., count clamp: math block with interior slots


and this one

walterbender · 2024-04-01T22:28:35Z

js/protoblocks.js

@@ -1162,6 +1398,10 @@ class ProtoBlock {

    // E.g., action. A "child" flow is docked in an expandable clamp.


and this one

walterbender · 2024-04-01T22:28:49Z

js/protoblocks.js

@@ -1203,6 +1448,9 @@ class ProtoBlock {
    }

    // E.g., mouse button.


walterbender · 2024-04-01T22:29:04Z

js/protoblocks.js

@@ -1230,6 +1482,9 @@ class ProtoBlock {
    }

    // E.g., named sensor blocks


this one...

walterbender · 2024-04-01T22:29:17Z

js/protoblocks.js

@@ -1260,6 +1519,9 @@ class ProtoBlock {
    }

    // E.g., not


walterbender · 2024-04-01T22:29:26Z

js/protoblocks.js

@@ -1289,6 +1555,9 @@ class ProtoBlock {
    }

    // E.g., and, or


walterbender · 2024-04-01T22:29:36Z

js/protoblocks.js

@@ -1319,6 +1592,9 @@ class ProtoBlock {
    }

    // E.g., greater, less, equal


walterbender · 2024-04-01T22:29:44Z

js/protoblocks.js

@@ -1357,6 +1638,9 @@ class ProtoBlock {
    }

    // E.g., color, shade, pensize, ...


so sorry for the inconvenience caused. I'll look into it.

hackorlyf and others added 30 commits February 7, 2024 23:01

Added JSDoc style documentation

8af62fb

Added JSDoc style documentation

adedcc5

Removed the definition which belonged only to EnvelopBlock

057de04

Merge branch 'master' into jsDocumentation

ee25470

Added appropriate JSDoc

4e7b8c6

Merge branch 'jsDocumentation' of https://github.com/hackorlyf/musicb…

2435f7f

…locks into jsDocumentation

Added further JS Documentation

2e0946b

Completed JS style documentation for WidgetBlocks.js

3d95832

Started adding comments for activity.js and temperament.js

2d87ed1

Added further activity.js

646c234

JS Docs added for activity.js

f5c20ba

added JS documentation for activity.js

222f9aa

Rectified and added some documentations

1efcc67

Merge branch 'master' of https://github.com/hackorlyf/musicblocks int…

4537916

…o jsDocumentation

Completed Documentation for artwork.js

effc5b8

Completed JS style Documentation for 2 files.

bbd27d8

Started Documentation for block.js

e13bc1a

Added and updated Documentation in block.js

6a32081

JS Documentation

ee80f36

JS style documentation

23d3b20

Further js documentation in block.js

f8c7425

Added lint error triggered comment

4b63720

Documentation for block.js

ff9759b

Merge branch 'master' into jsDocumentation

46223eb

Rectified and Added documentation

f11e860

Merge branch 'jsDocumentation' of https://github.com/hackorlyf/musicb…

42afc7d

…locks into jsDocumentation

Completed and rectified documentation in block.js

a45fef3

Completed documentation for activity.js and added comments

48fc00d

Completed Documentation in sugarizer.js

dc76492

Completed JS style documentation for env.js

58bd7b5

walterbender reviewed Mar 26, 2024

View reviewed changes

Eg shifted below L636

826f140