Skip to content

Commit

Permalink
Add member method previews into class docs
Browse files Browse the repository at this point in the history
  • Loading branch information
stalgiag committed Mar 5, 2024
1 parent ff89bb4 commit ffe00f3
Show file tree
Hide file tree
Showing 166 changed files with 3,371 additions and 258 deletions.
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Element/addClass.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ submodule: DOM
file: src/dom/dom.js
description: |
<p>Adds specified class to the element.</p>
line: 2323
line: 2358
isConstructor: false
itemtype: method
example:
Expand Down
6 changes: 3 additions & 3 deletions src/content/reference/en/p5.Element/attribute.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ description: >
horizontal
alignment to <code>center</code>.</p>
line: 2859
line: 2894
isConstructor: false
itemtype: method
example:
Expand Down Expand Up @@ -85,12 +85,12 @@ return:
description: value of the attribute.
type: String
overloads:
- line: 2859
- line: 2894
params: []
return:
description: value of the attribute.
type: String
- line: 2919
- line: 2954
params:
- name: attr
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Element/center.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |
or both, relative to its parent or according to
the body if the p5.Element has no parent. If no argument is passed
the p5.Element is aligned both vertically and horizontally.</p>
line: 2494
line: 2529
isConstructor: false
itemtype: method
example:
Expand Down
6 changes: 3 additions & 3 deletions src/content/reference/en/p5.Element/child.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: |
<p>Attaches the element as a child to the parent specified.
Accepts either a string ID, DOM node, or <a href="#/p5.Element">p5.Element</a>.
If no argument is specified, an array of children DOM nodes is returned.</p>
line: 2441
line: 2476
isConstructor: false
itemtype: method
example:
Expand Down Expand Up @@ -36,12 +36,12 @@ return:
description: an array of child nodes
type: 'Node[]'
overloads:
- line: 2441
- line: 2476
params: []
return:
description: an array of child nodes
type: 'Node[]'
- line: 2469
- line: 2504
params:
- name: child
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Element/draggable.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: >
<p>Turns p5.Element into a draggable item. If an argument is given, it will
drag that p5.Element instead, ie. drag a entire GUI panel (parent container)
with the panel's title bar.</p>
line: 3511
line: 3546
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Element/drop.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ description: >
<a
href="https://developer.mozilla.org/en-US/docs/Web/API/DragEvent">DragEvent</a>.</p>
line: 3355
line: 3390
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Element/hasClass.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ submodule: DOM
file: src/dom/dom.js
description: |
<p>Checks if specified class is already applied to element.</p>
line: 2379
line: 2414
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Element/hide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ submodule: DOM
file: src/dom/dom.js
description: |
<p>Hides the current element.</p>
line: 3110
line: 3145
isConstructor: false
itemtype: method
example:
Expand Down
6 changes: 3 additions & 3 deletions src/content/reference/en/p5.Element/html.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: |
argument, HTML is appended instead of replacing existing HTML.
If no arguments are given, returns
the inner HTML of the element.</p>
line: 2545
line: 2580
isConstructor: false
itemtype: method
example:
Expand All @@ -28,12 +28,12 @@ return:
description: the inner HTML of the element
type: String
overloads:
- line: 2545
- line: 2580
params: []
return:
description: the inner HTML of the element
type: String
- line: 2566
- line: 2601
params:
- name: html
description: |
Expand Down
6 changes: 3 additions & 3 deletions src/content/reference/en/p5.Element/position.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ description: >
If no arguments given, the function returns the x and y position of the element.
found documentation on how to be more specific with object type
<a href="https://stackoverflow.com/questions/14714314/how-do-i-comment-object-literals-in-yuidoc">https://stackoverflow.com/questions/14714314/how-do-i-comment-object-literals-in-yuidoc</a></p>
line: 2584
line: 2619
isConstructor: false
itemtype: method
example:
Expand Down Expand Up @@ -43,14 +43,14 @@ return:
object
type: Object
overloads:
- line: 2584
- line: 2619
params: []
return:
description: >-
object of form { x: 0, y: 0 } containing the position of the element in
an object
type: Object
- line: 2617
- line: 2652
params:
- name: x
description: |
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Element/remove.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ file: src/dom/dom.js
description: |
<p>Removes the element, stops all audio/video streams, and removes all
callback functions.</p>
line: 3299
line: 3334
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Element/removeAttribute.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: >
<code>align</code>
attribute if it's been set.</p>
line: 2948
line: 2983
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Element/removeClass.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ submodule: DOM
file: src/dom/dom.js
description: |
<p>Removes specified class from the element.</p>
line: 2348
line: 2383
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Element/show.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ submodule: DOM
file: src/dom/dom.js
description: |
<p>Shows the current element.</p>
line: 3077
line: 3112
isConstructor: false
itemtype: method
example:
Expand Down
7 changes: 4 additions & 3 deletions src/content/reference/en/p5.Element/size.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ description: >
<p>Note: In the case of elements that need to load data, such as images, wait
to call <code>myElement.size()</code> until after the data loads.</p>
line: 3140
line: 3175
isConstructor: false
itemtype: method
example:
Expand Down Expand Up @@ -126,17 +126,18 @@ return:
description: width and height of the element in an object.
type: Object
overloads:
- line: 3140
- line: 3175
params: []
return:
description: width and height of the element in an object.
type: Object
- line: 3244
- line: 3279
params:
- name: w
description: |
<p>width of the element, either AUTO, or a number.</p>
type: Number|Constant
optional: true
- name: h
description: |
<p>height of the element, either AUTO, or a number.</p>
Expand Down
6 changes: 3 additions & 3 deletions src/content/reference/en/p5.Element/style.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ description: >
<a href="#/p5.Color">p5.Color</a> object, as in
<code>myElement.style('color', myColor)</code>.</p>
line: 2704
line: 2739
isConstructor: false
itemtype: method
example:
Expand Down Expand Up @@ -121,7 +121,7 @@ return:
description: value of the property.
type: String
overloads:
- line: 2704
- line: 2739
params:
- name: property
description: |
Expand All @@ -130,7 +130,7 @@ overloads:
return:
description: value of the property.
type: String
- line: 2802
- line: 2837
params:
- name: property
description: ''
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Element/toggleClass.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ submodule: DOM
file: src/dom/dom.js
description: |
<p>Toggles element class.</p>
line: 2408
line: 2443
isConstructor: false
itemtype: method
example:
Expand Down
6 changes: 3 additions & 3 deletions src/content/reference/en/p5.Element/value.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ description: >
as in <code>myElement.value(123)</code>, it's used to set the element's
value.</p>
line: 2997
line: 3032
isConstructor: false
itemtype: method
example:
Expand Down Expand Up @@ -77,12 +77,12 @@ return:
description: value of the element.
type: String|Number
overloads:
- line: 2997
- line: 3032
params: []
return:
description: value of the element.
type: String|Number
- line: 3061
- line: 3096
params:
- name: value
description: ''
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.File/data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: |
<p>A string containing either the file's image data, text contents, or
a parsed object in the case of JSON and
<a href="#/p5.XML">p5.XML</a> objects.</p>
line: 5173
line: 5215
isConstructor: false
itemtype: property
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.File/file.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: >
target="_blank">File</a>
object. All <code>File</code> properties and methods are accessible.</p>
line: 4986
line: 5028
isConstructor: false
itemtype: property
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.File/name.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ submodule: DOM
file: src/dom/dom.js
description: |
<p>The file name as a string.</p>
line: 5104
line: 5146
isConstructor: false
itemtype: property
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.File/size.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ submodule: DOM
file: src/dom/dom.js
description: |
<p>The number of bytes in the file.</p>
line: 5138
line: 5180
isConstructor: false
itemtype: property
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.File/subtype.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: >
target="_blank">MIME type</a>
may have a subtype such as <code>png</code> or <code>jpeg</code>.</p>
line: 5068
line: 5110
isConstructor: false
itemtype: property
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.File/type.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: >
as a string. For example, <code>'image'</code>, <code>'text'</code>, and so
on.</p>
line: 5032
line: 5074
isConstructor: false
itemtype: property
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Geometry/averageNormals.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ file: src/webgl/p5.Geometry.js
description: |
<p>Averages the vertex normals. Used in curved
surfaces</p>
line: 535
line: 534
isConstructor: false
itemtype: method
class: p5.Geometry
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ submodule: 3D Primitives
file: src/webgl/p5.Geometry.js
description: |
<p>Averages pole normals. Used in spherical primitives</p>
line: 556
line: 555
isConstructor: false
itemtype: method
class: p5.Geometry
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Geometry/clearColors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: >
If <code>clearColors()</code> is not used, the shapes will use their internal
colors by ignoring <code>fill()</code>.</p>
line: 123
line: 122
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Geometry/computeFaces.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ submodule: 3D Primitives
file: src/webgl/p5.Geometry.js
description: |
<p>computes faces for geometry objects based on the vertices.</p>
line: 321
line: 320
isConstructor: false
itemtype: method
class: p5.Geometry
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Geometry/computeNormals.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ description: >
Defaults to 3.</li>
</ul>
line: 364
line: 363
isConstructor: false
itemtype: method
alt: >-
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Geometry/flipU.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ submodule: 3D Primitives
file: src/webgl/p5.Geometry.js
description: |
<p>Flips the U texture coordinates of the model.</p>
line: 177
line: 176
isConstructor: false
itemtype: method
example:
Expand Down
2 changes: 1 addition & 1 deletion src/content/reference/en/p5.Geometry/flipV.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ submodule: 3D Primitives
file: src/webgl/p5.Geometry.js
description: |
<p>Flips the V texture coordinates of the model.</p>
line: 249
line: 248
isConstructor: false
itemtype: method
example:
Expand Down
Loading

0 comments on commit ffe00f3

Please sign in to comment.