Skip to content

Docs: Fixed some [param:] tags and added missing ones, updated page.js #14545

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 25, 2018
Merged

Docs: Fixed some [param:] tags and added missing ones, updated page.js #14545

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1c1cf7
Docs: Fixed some [param:] tags and added missing ones. Updated page.j…
moraxy Jul 25, 2018
ac529c2
Docs: Revert page.js changes and instead reformat the HTML
moraxy Jul 25, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/api/animation/PropertyMixer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ <h1>[name]</h1>
<h2>Constructor</h2>


<h3>[name]( binding, typeName, valueSize )</h3>
<h3>[name]( [param:PropertyBinding binding], [param:String typeName], [param:Number valueSize] )</h3>
<p>
-- binding <br />
-- typeName <br />
Expand All @@ -29,12 +29,12 @@ <h3>[name]( binding, typeName, valueSize )</h3>
<h2>Properties</h2>


<h3>[property:Number binding]</h3>
<h3>[property:PropertyBinding binding]</h3>
<p>

</p>

<h3>[property:Number buffer]</h3>
<h3>[property:TypedArray buffer]</h3>
<p>
Buffer with size [page:PropertyMixer valueSize] * 4. <br /><br />
This has the layout: [ incoming | accu0 | accu1 | orig ]<br /><br />
Expand Down Expand Up @@ -67,14 +67,14 @@ <h3>[property:Number useCount]</h3>
<h2>Methods</h2>


<h3>[method:null accumulate]( accuIndex, weight )</h3>
<h3>[method:null accumulate]( [param:Number accuIndex], [param:Number weight] )</h3>
<p>
Accumulate data in [page:PropertyMixer.buffer buffer][accuIndex] 'incoming' region into 'accu[i]'.<br />

If weight is *0* this does nothing.
</p>

<h3>[method:null apply]( accuIndex )</h3>
<h3>[method:null apply]( [param:Number accuIndex] )</h3>
<p>
Apply the state of [page:PropertyMixer.buffer buffer] 'accu[i]' to the binding when accus differ.
</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/cameras/Camera.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ <h3>[method:Camera clone]( )</h3>
Return a new camera with the same properties as this one.
</p>

<h3>[method:Camera copy]( [param:Camera source] )</h3>
<h3>[method:Camera copy]( [param:Camera source], [param:Boolean recursive] )</h3>
<p>
Copy the properties from the source camera into this one.
</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/cameras/StereoCamera.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ <h3>[property:PerspectiveCamera cameraR]</h3>

<h2>Methods</h2>

<h3>[method:null update]( camera )</h3>
<h3>[method:null update]( [param:PerspectiveCamera camera] )</h3>
<p>
Update the stereo cameras based on the camera passed in.
</p>
Expand Down
30 changes: 15 additions & 15 deletions docs/api/core/BufferAttribute.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,28 +131,28 @@ <h3>[method:BufferAttribute copyArray]( array ) </h3>
<h3>[method:null copyAt] ( [param:Integer index1], [param:BufferAttribute bufferAttribute], [param:Integer index2] ) </h3>
<p>Copy a vector from bufferAttribute[index2] to [page:BufferAttribute.array array][index1].</p>

<h3>[method:BufferAttribute copyColorsArray]( colors ) </h3>
<h3>[method:BufferAttribute copyColorsArray]( [param:Array colors] ) </h3>
<p>Copy an array representing RGB color values into [page:BufferAttribute.array array].</p>

<h3>[method:BufferAttribute copyVector2sArray]( vectors ) </h3>
<h3>[method:BufferAttribute copyVector2sArray]( [param:Array vectors] ) </h3>
<p>Copy an array representing [page:Vector2]s into [page:BufferAttribute.array array].</p>

<h3>[method:BufferAttribute copyVector3sArray]( vectors ) </h3>
<h3>[method:BufferAttribute copyVector3sArray]( [param:Array vectors] ) </h3>
<p>Copy an array representing [page:Vector3]s into [page:BufferAttribute.array array].</p>

<h3>[method:BufferAttribute copyVector4sArray]( vectors ) </h3>
<h3>[method:BufferAttribute copyVector4sArray]( [param:Array vectors] ) </h3>
<p>Copy an array representing [page:Vector4]s into [page:BufferAttribute.array array].</p>

<h3>[method:Number getX]( index ) </h3>
<h3>[method:Number getX]( [param:Integer index] ) </h3>
<p>Returns the x component of the vector at the given index.</p>

<h3>[method:Number getY]( index ) </h3>
<h3>[method:Number getY]( [param:Integer index] ) </h3>
<p>Returns the y component of the vector at the given index.</p>

<h3>[method:Number getZ]( index ) </h3>
<h3>[method:Number getZ]( [param:Integer index] ) </h3>
<p>Returns the z component of the vector at the given index.</p>

<h3>[method:Number getW]( index ) </h3>
<h3>[method:Number getW]( [param:Integer index] ) </h3>
<p>Returns the w component of the vector at the given index.</p>

<h3>[method:null onUpload]( [param:Function callback] ) </h3>
Expand Down Expand Up @@ -185,25 +185,25 @@ <h3>[method:BufferAttribute setArray] ( [param:TypedArray array] ) </h3>
<h3>[method:BufferAttribute setDynamic] ( [param:Boolean value] ) </h3>
<p>Set [page:BufferAttribute.dynamic dynamic] to value.</p>

<h3>[method:BufferAttribute setX]( index, x ) </h3>
<h3>[method:BufferAttribute setX]( [param:Integer index], [param:Float x] ) </h3>
<p>Sets the x component of the vector at the given index.</p>

<h3>[method:BufferAttribute setY]( index, y ) </h3>
<h3>[method:BufferAttribute setY]( [param:Integer index], [param:Float y] ) </h3>
<p>Sets the y component of the vector at the given index.</p>

<h3>[method:BufferAttribute setZ]( index, z ) </h3>
<h3>[method:BufferAttribute setZ]( [param:Integer index], [param:Float z] ) </h3>
<p>Sets the z component of the vector at the given index.</p>

<h3>[method:BufferAttribute setW]( index, w ) </h3>
<h3>[method:BufferAttribute setW]( [param:Integer index], [param:Float w] ) </h3>
<p>Sets the w component of the vector at the given index.</p>

<h3>[method:BufferAttribute setXY]( index, x, y ) </h3>
<h3>[method:BufferAttribute setXY]( [param:Integer index], [param:Float x], [param:Float y] ) </h3>
<p>Sets the x and y components of the vector at the given index.</p>

<h3>[method:BufferAttribute setXYZ]( index, x, y, z ) </h3>
<h3>[method:BufferAttribute setXYZ]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z] ) </h3>
<p>Sets the x, y and z components of the vector at the given index.</p>

<h3>[method:BufferAttribute setXYZW]( index, x, y, z, w ) </h3>
<h3>[method:BufferAttribute setXYZW]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z], [param:Float w] ) </h3>
<p>Sets the x, y, z and w components of the vector at the given index.</p>


Expand Down
4 changes: 2 additions & 2 deletions docs/api/core/DirectGeometry.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,13 +91,13 @@ <h3>[property:Boolean groupsNeedUpdate]</h3>

<h2>Methods</h2>

<h3>[property:null computeGroups]( [page:Geometry geometry] )</h3>
<h3>[property:null computeGroups]( [param:Geometry geometry] )</h3>
<p>
Compute the parts of the geometry that have different materialIndex.
See [page:BufferGeometry.groups].
</p>

<h3>[property:null fromGeometry]( [page:Geometry geometry] )</h3>
<h3>[property:null fromGeometry]( [param:Geometry geometry] )</h3>
<p>Pass in a [page:Geometry] instance for conversion.</p>


Expand Down
6 changes: 3 additions & 3 deletions docs/api/core/InterleavedBuffer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,15 +91,15 @@ <h3>[method:InterleavedBuffer setDynamic] ( [param:Boolean value] ) </h3>
Set [page:InterleavedBuffer.dynamic dynamic] to value.
</p>

<h3>[method:InterleavedBuffer copy]( source ) </h3>
<h3>[method:InterleavedBuffer copy]( [param:InterleavedBuffer source] ) </h3>
<p>
Copies another [name] to this [name].
</p>

<h3>[method:InterleavedBuffer copyAt]( index1, attribute, index2 ) </h3>
<h3>[method:InterleavedBuffer copyAt]( [param:Integer index1], [param:InterleavedBuffer attribute], [param:Integer index2] ) </h3>
<p>Copies data from attribute[index2] to [page:InterleavedBuffer.array array][index1].</p>

<h3>[method:InterleavedBuffer set]( value, offset ) </h3>
<h3>[method:InterleavedBuffer set]( [param:TypedArray value], [param:Integer offset] ) </h3>
<p>
value - The source (typed) array.<br/>
offset - The offset into the target array at which to begin writing values from the source array. Default is *0*.<br/><br />
Expand Down
22 changes: 11 additions & 11 deletions docs/api/core/InterleavedBufferAttribute.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,37 +62,37 @@ <h3>[property:Boolean isInterleavedBufferAttribute]</h3>

<h2>Methods</h2>

<h3>[method:Number getX]( index ) </h3>
<h3>[method:Number getX]( [param:Integer index] ) </h3>
<p>Returns the x component of the item at the given index.</p>

<h3>[method:Number getY]( index ) </h3>
<h3>[method:Number getY]( [param:Integer index] ) </h3>
<p>Returns the y component of the item at the given index.</p>

<h3>[method:Number getZ]( index ) </h3>
<h3>[method:Number getZ]( [param:Integer index] ) </h3>
<p>Returns the z component of the item at the given index.</p>

<h3>[method:Number getW]( index ) </h3>
<h3>[method:Number getW]( [param:Integer index] ) </h3>
<p>Returns the w component of the item at the given index.</p>

<h3>[method:null setX]( index, x ) </h3>
<h3>[method:null setX]( [param:Integer index], [param:Float x] ) </h3>
<p>Sets the x component of the item at the given index.</p>

<h3>[method:null setY]( index, y ) </h3>
<h3>[method:null setY]( [param:Integer index], [param:Float y] ) </h3>
<p>Sets the y component of the item at the given index.</p>

<h3>[method:null setZ]( index, z ) </h3>
<h3>[method:null setZ]( [param:Integer index], [param:Float z] ) </h3>
<p>Sets the z component of the item at the given index.</p>

<h3>[method:null setW]( index, w ) </h3>
<h3>[method:null setW]( [param:Integer index], [param:Float w] ) </h3>
<p>Sets the w component of the item at the given index.</p>

<h3>[method:null setXY]( index, x, y ) </h3>
<h3>[method:null setXY]( [param:Integer index], [param:Float x], [param:Float y] ) </h3>
<p>Sets the x and y components of the item at the given index.</p>

<h3>[method:null setXYZ]( index, x, y, z ) </h3>
<h3>[method:null setXYZ]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z] ) </h3>
<p>Sets the x, y and z components of the item at the given index.</p>

<h3>[method:null setXYZW]( index, x, y, z, w ) </h3>
<h3>[method:null setXYZW]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z], [param:Float w] ) </h3>
<p>Sets the x, y, z and w components of the item at the given index.</p>


Expand Down
2 changes: 1 addition & 1 deletion docs/api/core/Raycaster.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ <h3>[method:null setFromCamera]( [param:Vector2 coords], [param:Camera camera] )
Updates the ray with a new origin and direction.
</p>

<h3>[method:Array intersectObject]( [page:Object3D object], [param:Boolean recursive], [param:Array optionalTarget] )</h3>
<h3>[method:Array intersectObject]( [param:Object3D object], [param:Boolean recursive], [param:Array optionalTarget] )</h3>
<p>
[page:Object3D object] — The object to check for intersection with the ray.<br />
[page:Boolean recursive] — If true, it also checks all descendants. Otherwise it only checks intersecton with the object. Default is false.<br />
Expand Down
2 changes: 1 addition & 1 deletion docs/api/helpers/Box3Helper.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ <h2>Methods</h2>
<p>See the base [page:LineSegments] class for common methods.</p>


<h3>[method:void updateMatrixWorld]( force )</h3>
<h3>[method:void updateMatrixWorld]( [param:Boolean force] )</h3>
<p>
This overrides the method in the base [page:Object3D] class so that it
also updates the wireframe box to the extent of the [page:Box3Helper.box .box]
Expand Down
2 changes: 1 addition & 1 deletion docs/api/helpers/PlaneHelper.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ <h3>[property:Float size]</h3>
<h2>Methods</h2>
<p>See the base [page:LineSegments] class for common methods.</p>

<h3>[method:void updateMatrixWorld]( force )</h3>
<h3>[method:void updateMatrixWorld]( [param:Boolean force] )</h3>
<p>
This overrides the method in the base [page:Object3D] class so that it also
updates the helper object according to the [page:PlaneHelper.plane .plane] and
Expand Down
2 changes: 1 addition & 1 deletion docs/api/materials/PointsMaterial.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ <h2>Examples</h2>
scene.add( starField );
</code>

<h3>[name]( [page:Object parameters] )</h3>
<h3>[name]( [param:Object parameters] )</h3>
<p>
[page:Object parameters] - (optional) an object with one or more properties defining the material's appearance.
Any property of the material (including any property inherited from [page:Material]) can be passed in here.<br /><br />
Expand Down
2 changes: 1 addition & 1 deletion docs/api/materials/SpriteMaterial.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ <h2>Examples</h2>
</code>


<h3>[name]( [page:Object parameters] )</h3>
<h3>[name]( [param:Object parameters] )</h3>
<p>
[page:Object parameters] - (optional) an object with one or more properties defining the material's appearance.
Any property of the material (including any property inherited from [page:Material]) can be passed in here.<br /><br />
Expand Down
2 changes: 1 addition & 1 deletion docs/api/math/Cylindrical.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ <h3>[method:Cylindrical copy]( [param:Cylindrical other] )</h3>
and [page:.y y] properties to this cylindrical.
</p>

<h3>[method:Cylindrical set]( [param:Float radius], [param:Float phi], [param:Float theta] )</h3>
<h3>[method:Cylindrical set]( [param:Float radius], [param:Float theta], [param:Float y] )</h3>
<p>Sets values of this cylindrical's [page:.radius radius], [page:.theta theta]
and [page:.y y] properties.</p>

Expand Down
9 changes: 7 additions & 2 deletions docs/api/math/Euler.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,13 @@ <h3>[method:Array toArray]( [param:Array array], [param:Integer offset] )</h3>
Returns an array of the form [[page:.x x], [page:.y y], [page:.z z], [page:.order order ]].
</p>

<h3>[method:Vector3 toVector3]()</h3>
<p>Returns the Euler's [page:.x x], [page:.y y] and [page:.z z] properties as a [page:Vector3].</p>
<h3>[method:Vector3 toVector3]( [param:Vector3 optionalResult] )</h3>
<p>
[page:Vector3 optionalResult] — (optional) If specified, the result will be copied into this Vector,
otherwise a new one will be created. <br /><br />

Returns the Euler's [page:.x x], [page:.y y] and [page:.z z] properties as a [page:Vector3].
</p>


<h2>Source</h2>
Expand Down
7 changes: 1 addition & 6 deletions docs/api/math/Math.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,7 @@ <h3>[method:Float lerp]( [param:Float x], [param:Float y], [param:Float t] )</h3
and [page:Float t] = 1 will return [page:Float y].
</p>

<h3>[method:Float mapLinear](
[page:Float x],
[page:Float a1],
[page:Float a2],
[page:Float b1],
[page:Float b2] )</h3>
<h3>[method:Float mapLinear]( [param:Float x], [param:Float a1], [param:Float a2], [param:Float b1], [param:Float b2] )</h3>
<p>
[page:Float x] — Value to be mapped.<br />
[page:Float a1] — Minimum value for range A.<br />
Expand Down
13 changes: 2 additions & 11 deletions docs/api/math/Matrix3.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,12 +144,7 @@ <h3>[method:this multiplyMatrices]( [param:Matrix3 a], [param:Matrix3 b] )</h3>
<h3>[method:this multiplyScalar]( [param:Float s] )</h3>
<p>Multiplies every component of the matrix by the scalar value *s*.</p>

<h3>
[method:this set](
[page:Float n11], [page:Float n12], [page:Float n13],
[page:Float n21], [page:Float n22], [page:Float n23],
[page:Float n31], [page:Float n32], [page:Float n33] )
</h3>
<h3>[method:this set]( [param:Float n11], [param:Float n12], [param:Float n13], [param:Float n21], [param:Float n22], [param:Float n23], [param:Float n31], [param:Float n32], [param:Float n33] )</h3>
<p>
[page:Float n11] - value to put in row 1, col 1.<br />
[page:Float n12] - value to put in row 1, col 2.<br />
Expand All @@ -169,11 +164,7 @@ <h3>[method:this premultiply]( [param:Matrix3 m] )</h3>
<h3>[method:this setFromMatrix4]( [param:Matrix4 m] )</h3>
<p>Set this matrx to the upper 3x3 matrix of the Matrix4 [page:Matrix4 m].</p>

<h3>
[method:this setUvTransform](
[page:Float tx], [page:Float ty], [page:Float sx], [page:Float sy],
[page:Float rotation], [page:Float cx], [page:Float cy] )
</h3>
<h3>[method:this setUvTransform]( [param:Float tx], [param:Float ty], [param:Float sx], [param:Float sy], [param:Float rotation], [param:Float cx], [param:Float cy] )</h3>
<p>
[page:Float tx] - offset x<br />
[page:Float ty] - offset y<br />
Expand Down
6 changes: 1 addition & 5 deletions docs/api/math/Matrix4.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,11 +368,7 @@ <h3>[method:this premultiply]( [param:Matrix4 m] )</h3>
<h3>[method:this scale]( [param:Vector3 v] )</h3>
<p>Multiplies the columns of this matrix by vector [page:Vector3 v].</p>

<h3>[method:this set](
[page:Float n11], [page:Float n12], [page:Float n13], [page:Float n14],
[page:Float n21], [page:Float n22], [page:Float n23], [page:Float n24],
[page:Float n31], [page:Float n32], [page:Float n33], [page:Float n34],
[page:Float n41], [page:Float n42], [page:Float n43], [page:Float n44] )</h3>
<h3>[method:this set]( [param:Float n11], [param:Float n12], [param:Float n13], [param:Float n14], [param:Float n21], [param:Float n22], [param:Float n23], [param:Float n24], [param:Float n31], [param:Float n32], [param:Float n33], [param:Float n34], [param:Float n41], [param:Float n42], [param:Float n43], [param:Float n44] )</h3>
<p>
Set the [page:.elements elements] of this matrix to the supplied row-major values [page:Float n11],
[page:Float n12], ... [page:Float n44].
Expand Down
12 changes: 1 addition & 11 deletions docs/api/math/Quaternion.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,17 +261,7 @@ <h3>[method:Quaternion slerp]( [param:Quaternion qStart], [param:Quaternion qEnd
</p>


<h3>
[method:null slerpFlat](
[page:Array dst],
[page:Integer dstOffset],
[page:Array src0],
[page:Integer srcOffset0],
[page:Array src1],
[page:Integer srcOffset1],
[page:Float t]
)
</h3>
<h3>[method:null slerpFlat]( [param:Array dst], [param:Integer dstOffset], [param:Array src0], [param:Integer srcOffset0], [param:Array src1], [param:Integer srcOffset1], [param:Float t] )</h3>
<p>
[page:Array dst] - The output array.<br />
[page:Integer dstOffset] - An offset into the output array.<br />
Expand Down
2 changes: 1 addition & 1 deletion docs/api/objects/Mesh.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ <h3>[property:Object morphTargetDictionary]</h3>
<h2>Methods</h2>
<p>See the base [page:Object3D] class for common methods.</p>

<h3>[method:null setDrawMode]()</h3>
<h3>[method:null setDrawMode]( [param:Integer value] )</h3>
<p>Set the value of [page:.drawMode drawMode].</p>

<h3>[method:Mesh clone]()</h3>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/textures/Texture.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,12 +234,12 @@ <h3>[method:null updateMatrix]()</h3>
[page:Texture.rotation .rotation], and [page:Texture.center .center].
</p>

<h3>[method:Texture clone]( [param:Texture texture] )</h3>
<h3>[method:Texture clone]()</h3>
<p>
Make copy of the texture. Note this is not a "deep copy", the image is shared.
</p>

<h3>[method:Texture toJSON]( meta )</h3>
<h3>[method:Texture toJSON]( [param:Object meta] )</h3>
<p>
meta -- optional object containing metadata.<br />
Convert the material to three.js JSON format.
Expand All @@ -250,7 +250,7 @@ <h3>[method:null dispose]()</h3>
Call [page:EventDispatcher EventDispatcher].dispatchEvent with a 'dispose' event type.
</p>

<h3>[method:null transformUv]( uv )</h3>
<h3>[method:null transformUv]( [param:Vector2 uv] )</h3>
<p>
Transform the uv based on the value of this texture's [page:Texture.offset .offset], [page:Texture.repeat .repeat],
[page:Texture.wrapS .wrapS], [page:Texture.wrapT .wrapT] and [page:Texture.flipY .flipY] properties.
Expand Down