Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jonobr1 committed Jan 1, 2025
1 parent 8b52613 commit ec81b02
Show file tree
Hide file tree
Showing 27 changed files with 579 additions and 579 deletions.
28 changes: 14 additions & 14 deletions wiki/docs/anchor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ An object that holds 3 [Two.Vector](/docs/vector/)s, the anchor point and its co
| ---- | ----------- |
| x | The x position of the root anchor point. |
| y | The y position of the root anchor point. |
| lx | The x position of the left handle point. |
| ly | The y position of the left handle point. |
| rx | The x position of the right handle point. |
| ry | The y position of the right handle point. |
| ax | The x position of the left handle point. |
| ay | The y position of the left handle point. |
| bx | The x position of the right handle point. |
| by | The y position of the right handle point. |
| command | The command to describe how to render. Applicable commands are [Two.Commands](/docs/two/#commands) |


Expand Down Expand Up @@ -87,8 +87,8 @@ Create a new [Two.Anchor](/docs/anchor/) from an object notation of a [Two.Ancho

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/anchor.js#L69">
anchor.js:69
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/anchor.js#L70">
anchor.js:70
</a>

</div>
Expand Down Expand Up @@ -149,8 +149,8 @@ Copy the properties of one [Two.Anchor](/docs/anchor/) onto another.

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/anchor.js#L81">
anchor.js:81
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/anchor.js#L82">
anchor.js:82
</a>

</div>
Expand Down Expand Up @@ -202,8 +202,8 @@ Create a new [Two.Anchor](/docs/anchor/), set all its values to the current inst

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/anchor.js#L127">
anchor.js:127
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/anchor.js#L128">
anchor.js:128
</a>

</div>
Expand Down Expand Up @@ -257,8 +257,8 @@ Create a JSON compatible plain object of the current instance. Intended for use

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/anchor.js#L137">
anchor.js:137
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/anchor.js#L138">
anchor.js:138
</a>

</div>
Expand Down Expand Up @@ -322,8 +322,8 @@ Create a string form of the current instance. Intended for use with storing valu

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/anchor.js#L162">
anchor.js:162
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/anchor.js#L163">
anchor.js:163
</a>

</div>
Expand Down
12 changes: 6 additions & 6 deletions wiki/docs/children/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ Map of all elements in the list keyed by `id`s.

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/children.js#L12">
children.js:12
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/children.js#L11">
children.js:11
</a>

</div>
Expand Down Expand Up @@ -115,8 +115,8 @@ Adds elements to the `ids` map.

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/children.js#L32">
children.js:32
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/children.js#L34">
children.js:34
</a>

</div>
Expand Down Expand Up @@ -167,8 +167,8 @@ Removes elements to the `ids` map.

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/children.js#L48">
children.js:48
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/children.js#L50">
children.js:50
</a>

</div>
Expand Down
12 changes: 6 additions & 6 deletions wiki/docs/effects/gradient/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -396,8 +396,8 @@ Create a new instance of [Two.Gradient](/docs/effects/gradient/) with the same p

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/gradient.js#L85">
gradient.js:85
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/gradient.js#L91">
gradient.js:91
</a>

</div>
Expand Down Expand Up @@ -448,8 +448,8 @@ Copy the properties of one [Two.Gradient](/docs/effects/gradient/) onto another.

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/gradient.js#L114">
gradient.js:114
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/gradient.js#L120">
gradient.js:120
</a>

</div>
Expand Down Expand Up @@ -501,8 +501,8 @@ Return a JSON compatible plain object that represents the path.

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/gradient.js#L136">
gradient.js:136
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/gradient.js#L139">
gradient.js:139
</a>

</div>
Expand Down
24 changes: 12 additions & 12 deletions wiki/docs/effects/image-sequence/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -381,8 +381,8 @@ Copy the properties of one [Two.ImageSequence](/docs/effects/image-sequence/) on

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/image-sequence.js#L200">
image-sequence.js:200
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/image-sequence.js#L206">
image-sequence.js:206
</a>

</div>
Expand Down Expand Up @@ -435,8 +435,8 @@ Initiate animation playback of a [Two.ImageSequence](/docs/effects/image-sequenc

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/image-sequence.js#L217">
image-sequence.js:217
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/image-sequence.js#L225">
image-sequence.js:225
</a>

</div>
Expand Down Expand Up @@ -480,8 +480,8 @@ Halt animation playback of a [Two.ImageSequence](/docs/effects/image-sequence/).

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/image-sequence.js#L251">
image-sequence.js:251
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/image-sequence.js#L259">
image-sequence.js:259
</a>

</div>
Expand Down Expand Up @@ -525,8 +525,8 @@ Halt animation playback of a [Two.ImageSequence](/docs/effects/image-sequence/)

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/image-sequence.js#L261">
image-sequence.js:261
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/image-sequence.js#L269">
image-sequence.js:269
</a>

</div>
Expand Down Expand Up @@ -585,8 +585,8 @@ Create a new instance of [Two.ImageSequence](/docs/effects/image-sequence/) with

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/image-sequence.js#L273">
image-sequence.js:273
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/image-sequence.js#L281">
image-sequence.js:281
</a>

</div>
Expand Down Expand Up @@ -638,8 +638,8 @@ Return a JSON compatible plain object that represents the path.

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/image-sequence.js#L301">
image-sequence.js:301
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/image-sequence.js#L309">
image-sequence.js:309
</a>

</div>
Expand Down
12 changes: 6 additions & 6 deletions wiki/docs/effects/linear-gradient/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -286,8 +286,8 @@ Copy the properties of one [Two.LinearGradient](/docs/effects/linear-gradient/)

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/linear-gradient.js#L84">
linear-gradient.js:84
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/linear-gradient.js#L90">
linear-gradient.js:90
</a>

</div>
Expand Down Expand Up @@ -346,8 +346,8 @@ Create a new instance of [Two.LinearGradient](/docs/effects/linear-gradient/) wi

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/linear-gradient.js#L109">
linear-gradient.js:109
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/linear-gradient.js#L112">
linear-gradient.js:112
</a>

</div>
Expand Down Expand Up @@ -399,8 +399,8 @@ Return a JSON compatible plain object that represents the path.

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/linear-gradient.js#L144">
linear-gradient.js:144
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/linear-gradient.js#L147">
linear-gradient.js:147
</a>

</div>
Expand Down
12 changes: 6 additions & 6 deletions wiki/docs/effects/radial-gradient/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -344,8 +344,8 @@ Copy the properties of one [Two.RadialGradient](/docs/effects/radial-gradient/)

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/radial-gradient.js#L111">
radial-gradient.js:111
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/radial-gradient.js#L117">
radial-gradient.js:117
</a>

</div>
Expand Down Expand Up @@ -404,8 +404,8 @@ Create a new instance of [Two.RadialGradient](/docs/effects/radial-gradient/) wi

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/radial-gradient.js#L138">
radial-gradient.js:138
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/radial-gradient.js#L143">
radial-gradient.js:143
</a>

</div>
Expand Down Expand Up @@ -457,8 +457,8 @@ Return a JSON compatible plain object that represents the path.

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/radial-gradient.js#L174">
radial-gradient.js:174
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/radial-gradient.js#L179">
radial-gradient.js:179
</a>

</div>
Expand Down
24 changes: 12 additions & 12 deletions wiki/docs/effects/sprite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -430,8 +430,8 @@ Copy the properties of one [Two.Sprite](/docs/effects/sprite/) onto another.

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/sprite.js#L233">
sprite.js:233
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/sprite.js#L239">
sprite.js:239
</a>

</div>
Expand Down Expand Up @@ -484,8 +484,8 @@ Initiate animation playback of a [Two.Sprite](/docs/effects/sprite/).

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/sprite.js#L250">
sprite.js:250
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/sprite.js#L258">
sprite.js:258
</a>

</div>
Expand Down Expand Up @@ -529,8 +529,8 @@ Halt animation playback of a [Two.Sprite](/docs/effects/sprite/).

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/sprite.js#L284">
sprite.js:284
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/sprite.js#L292">
sprite.js:292
</a>

</div>
Expand Down Expand Up @@ -574,8 +574,8 @@ Halt animation playback of a [Two.Sprite](/docs/effects/sprite/) and set the cur

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/sprite.js#L294">
sprite.js:294
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/sprite.js#L302">
sprite.js:302
</a>

</div>
Expand Down Expand Up @@ -634,8 +634,8 @@ Create a new instance of [Two.Sprite](/docs/effects/sprite/) with the same prope

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/sprite.js#L306">
sprite.js:306
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/sprite.js#L314">
sprite.js:314
</a>

</div>
Expand Down Expand Up @@ -687,8 +687,8 @@ Return a JSON compatible plain object that represents the path.

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/sprite.js#L338">
sprite.js:338
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/sprite.js#L346">
sprite.js:346
</a>

</div>
Expand Down
12 changes: 6 additions & 6 deletions wiki/docs/effects/stop/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -390,8 +390,8 @@ Copy the properties of one [Two.Stop](/docs/effects/stop/) onto another.

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/stop.js#L112">
stop.js:112
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/stop.js#L118">
stop.js:118
</a>

</div>
Expand Down Expand Up @@ -450,8 +450,8 @@ Create a new instance of [Two.Stop](/docs/effects/stop/) with the same propertie

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/stop.js#L131">
stop.js:131
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/stop.js#L137">
stop.js:137
</a>

</div>
Expand Down Expand Up @@ -503,8 +503,8 @@ Return a JSON compatible plain object that represents the path.

<div class="meta">

<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/stop.js#L156">
stop.js:156
<a class="lineno" target="_blank" rel="noopener noreferrer" href="https://github.com/jonobr1/two.js/blob/main/src/effects/stop.js#L162">
stop.js:162
</a>

</div>
Expand Down
Loading

0 comments on commit ec81b02

Please sign in to comment.