From d1c1cf7d81366994befe876f94e93d66933fcfb5 Mon Sep 17 00:00:00 2001 From: moraxy Date: Wed, 25 Jul 2018 08:55:38 +0200 Subject: [PATCH] Docs: Fixed some [param:] tags and added missing ones. Updated page.js regex. The modified regex now supports multiline parameter lists, which some methods required for formatting reasons. Almost no changes to the actual documentation blurbs, except for one in math/Euler. --- docs/api/animation/PropertyMixer.html | 10 +++---- docs/api/cameras/Camera.html | 2 +- docs/api/cameras/StereoCamera.html | 2 +- docs/api/core/BufferAttribute.html | 30 +++++++++---------- docs/api/core/DirectGeometry.html | 4 +-- docs/api/core/InterleavedBuffer.html | 6 ++-- docs/api/core/InterleavedBufferAttribute.html | 22 +++++++------- docs/api/core/Raycaster.html | 2 +- docs/api/helpers/Box3Helper.html | 2 +- docs/api/helpers/PlaneHelper.html | 2 +- docs/api/materials/PointsMaterial.html | 2 +- docs/api/materials/SpriteMaterial.html | 2 +- docs/api/math/Cylindrical.html | 2 +- docs/api/math/Euler.html | 9 ++++-- docs/api/math/Math.html | 10 +++---- docs/api/math/Matrix3.html | 10 +++---- docs/api/math/Matrix4.html | 8 ++--- docs/api/math/Quaternion.html | 14 ++++----- docs/api/objects/Mesh.html | 2 +- docs/api/textures/Texture.html | 6 ++-- docs/page.js | 2 +- 21 files changed, 77 insertions(+), 72 deletions(-) diff --git a/docs/api/animation/PropertyMixer.html b/docs/api/animation/PropertyMixer.html index 1b214e9a43..043df707c4 100644 --- a/docs/api/animation/PropertyMixer.html +++ b/docs/api/animation/PropertyMixer.html @@ -18,7 +18,7 @@

Constructor

-

[name]( binding, typeName, valueSize )

+

[name]( [param:PropertyBinding binding], [param:String typeName], [param:Number valueSize] )

-- binding
-- typeName
@@ -29,12 +29,12 @@

Properties

-

[property:Number binding]

+

[property:PropertyBinding binding]

-

[property:Number buffer]

+

[property:TypedArray buffer]

Buffer with size [page:PropertyMixer valueSize] * 4.

This has the layout: [ incoming | accu0 | accu1 | orig ]

@@ -67,14 +67,14 @@

Methods

-

[method:null accumulate]( accuIndex, weight )

+

[method:null accumulate]( [param:Number accuIndex], [param:Number weight] )

Accumulate data in [page:PropertyMixer.buffer buffer][accuIndex] 'incoming' region into 'accu[i]'.
If weight is *0* this does nothing.

-

[method:null apply]( accuIndex )

+

[method:null apply]( [param:Number accuIndex] )

Apply the state of [page:PropertyMixer.buffer buffer] 'accu[i]' to the binding when accus differ.

diff --git a/docs/api/cameras/Camera.html b/docs/api/cameras/Camera.html index 7068b23ee7..afd2943539 100644 --- a/docs/api/cameras/Camera.html +++ b/docs/api/cameras/Camera.html @@ -64,7 +64,7 @@ Return a new camera with the same properties as this one.

-

[method:Camera copy]( [param:Camera source] )

+

[method:Camera copy]( [param:Camera source], [param:Boolean recursive] )

Copy the properties from the source camera into this one.

diff --git a/docs/api/cameras/StereoCamera.html b/docs/api/cameras/StereoCamera.html index abd1d0446b..dfc238834a 100644 --- a/docs/api/cameras/StereoCamera.html +++ b/docs/api/cameras/StereoCamera.html @@ -55,7 +55,7 @@

Methods

-

[method:null update]( camera )

+

[method:null update]( [param:PerspectiveCamera camera] )

Update the stereo cameras based on the camera passed in.

diff --git a/docs/api/core/BufferAttribute.html b/docs/api/core/BufferAttribute.html index 6ea281c307..6e6cdf3bd6 100644 --- a/docs/api/core/BufferAttribute.html +++ b/docs/api/core/BufferAttribute.html @@ -131,28 +131,28 @@

[method:null copyAt] ( [param:Integer index1], [param:BufferAttribute bufferAttribute], [param:Integer index2] )

Copy a vector from bufferAttribute[index2] to [page:BufferAttribute.array array][index1].

-

[method:BufferAttribute copyColorsArray]( colors )

+

[method:BufferAttribute copyColorsArray]( [param:Array colors] )

Copy an array representing RGB color values into [page:BufferAttribute.array array].

-

[method:BufferAttribute copyVector2sArray]( vectors )

+

[method:BufferAttribute copyVector2sArray]( [param:Array vectors] )

Copy an array representing [page:Vector2]s into [page:BufferAttribute.array array].

-

[method:BufferAttribute copyVector3sArray]( vectors )

+

[method:BufferAttribute copyVector3sArray]( [param:Array vectors] )

Copy an array representing [page:Vector3]s into [page:BufferAttribute.array array].

-

[method:BufferAttribute copyVector4sArray]( vectors )

+

[method:BufferAttribute copyVector4sArray]( [param:Array vectors] )

Copy an array representing [page:Vector4]s into [page:BufferAttribute.array array].

-

[method:Number getX]( index )

+

[method:Number getX]( [param:Integer index] )

Returns the x component of the vector at the given index.

-

[method:Number getY]( index )

+

[method:Number getY]( [param:Integer index] )

Returns the y component of the vector at the given index.

-

[method:Number getZ]( index )

+

[method:Number getZ]( [param:Integer index] )

Returns the z component of the vector at the given index.

-

[method:Number getW]( index )

+

[method:Number getW]( [param:Integer index] )

Returns the w component of the vector at the given index.

[method:null onUpload]( [param:Function callback] )

@@ -185,25 +185,25 @@

[method:BufferAttribute setDynamic] ( [param:Boolean value] )

Set [page:BufferAttribute.dynamic dynamic] to value.

-

[method:BufferAttribute setX]( index, x )

+

[method:BufferAttribute setX]( [param:Integer index], [param:Float x] )

Sets the x component of the vector at the given index.

-

[method:BufferAttribute setY]( index, y )

+

[method:BufferAttribute setY]( [param:Integer index], [param:Float y] )

Sets the y component of the vector at the given index.

-

[method:BufferAttribute setZ]( index, z )

+

[method:BufferAttribute setZ]( [param:Integer index], [param:Float z] )

Sets the z component of the vector at the given index.

-

[method:BufferAttribute setW]( index, w )

+

[method:BufferAttribute setW]( [param:Integer index], [param:Float w] )

Sets the w component of the vector at the given index.

-

[method:BufferAttribute setXY]( index, x, y )

+

[method:BufferAttribute setXY]( [param:Integer index], [param:Float x], [param:Float y] )

Sets the x and y components of the vector at the given index.

-

[method:BufferAttribute setXYZ]( index, x, y, z )

+

[method:BufferAttribute setXYZ]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z] )

Sets the x, y and z components of the vector at the given index.

-

[method:BufferAttribute setXYZW]( index, x, y, z, w )

+

[method:BufferAttribute setXYZW]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z], [param:Float w] )

Sets the x, y, z and w components of the vector at the given index.

diff --git a/docs/api/core/DirectGeometry.html b/docs/api/core/DirectGeometry.html index 925cb1bdca..9cd95a6e42 100644 --- a/docs/api/core/DirectGeometry.html +++ b/docs/api/core/DirectGeometry.html @@ -91,13 +91,13 @@

Methods

-

[property:null computeGroups]( [page:Geometry geometry] )

+

[property:null computeGroups]( [param:Geometry geometry] )

Compute the parts of the geometry that have different materialIndex. See [page:BufferGeometry.groups].

-

[property:null fromGeometry]( [page:Geometry geometry] )

+

[property:null fromGeometry]( [param:Geometry geometry] )

Pass in a [page:Geometry] instance for conversion.

diff --git a/docs/api/core/InterleavedBuffer.html b/docs/api/core/InterleavedBuffer.html index 30a4c18cc3..d20cf06484 100644 --- a/docs/api/core/InterleavedBuffer.html +++ b/docs/api/core/InterleavedBuffer.html @@ -91,15 +91,15 @@ Set [page:InterleavedBuffer.dynamic dynamic] to value.

-

[method:InterleavedBuffer copy]( source )

+

[method:InterleavedBuffer copy]( [param:InterleavedBuffer source] )

Copies another [name] to this [name].

-

[method:InterleavedBuffer copyAt]( index1, attribute, index2 )

+

[method:InterleavedBuffer copyAt]( [param:Integer index1], [param:InterleavedBuffer attribute], [param:Integer index2] )

Copies data from attribute[index2] to [page:InterleavedBuffer.array array][index1].

-

[method:InterleavedBuffer set]( value, offset )

+

[method:InterleavedBuffer set]( [param:TypedArray value], [param:Integer offset] )

value - The source (typed) array.
offset - The offset into the target array at which to begin writing values from the source array. Default is *0*.

diff --git a/docs/api/core/InterleavedBufferAttribute.html b/docs/api/core/InterleavedBufferAttribute.html index 0181aaecf2..1e39bc39a6 100644 --- a/docs/api/core/InterleavedBufferAttribute.html +++ b/docs/api/core/InterleavedBufferAttribute.html @@ -62,37 +62,37 @@

Methods

-

[method:Number getX]( index )

+

[method:Number getX]( [param:Integer index] )

Returns the x component of the item at the given index.

-

[method:Number getY]( index )

+

[method:Number getY]( [param:Integer index] )

Returns the y component of the item at the given index.

-

[method:Number getZ]( index )

+

[method:Number getZ]( [param:Integer index] )

Returns the z component of the item at the given index.

-

[method:Number getW]( index )

+

[method:Number getW]( [param:Integer index] )

Returns the w component of the item at the given index.

-

[method:null setX]( index, x )

+

[method:null setX]( [param:Integer index], [param:Float x] )

Sets the x component of the item at the given index.

-

[method:null setY]( index, y )

+

[method:null setY]( [param:Integer index], [param:Float y] )

Sets the y component of the item at the given index.

-

[method:null setZ]( index, z )

+

[method:null setZ]( [param:Integer index], [param:Float z] )

Sets the z component of the item at the given index.

-

[method:null setW]( index, w )

+

[method:null setW]( [param:Integer index], [param:Float w] )

Sets the w component of the item at the given index.

-

[method:null setXY]( index, x, y )

+

[method:null setXY]( [param:Integer index], [param:Float x], [param:Float y] )

Sets the x and y components of the item at the given index.

-

[method:null setXYZ]( index, x, y, z )

+

[method:null setXYZ]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z] )

Sets the x, y and z components of the item at the given index.

-

[method:null setXYZW]( index, x, y, z, w )

+

[method:null setXYZW]( [param:Integer index], [param:Float x], [param:Float y], [param:Float z], [param:Float w] )

Sets the x, y, z and w components of the item at the given index.

diff --git a/docs/api/core/Raycaster.html b/docs/api/core/Raycaster.html index f474ad6a47..70468f7c61 100644 --- a/docs/api/core/Raycaster.html +++ b/docs/api/core/Raycaster.html @@ -144,7 +144,7 @@ Updates the ray with a new origin and direction.

-

[method:Array intersectObject]( [page:Object3D object], [param:Boolean recursive], [param:Array optionalTarget] )

+

[method:Array intersectObject]( [param:Object3D object], [param:Boolean recursive], [param:Array optionalTarget] )

[page:Object3D object] — The object to check for intersection with the ray.
[page:Boolean recursive] — If true, it also checks all descendants. Otherwise it only checks intersecton with the object. Default is false.
diff --git a/docs/api/helpers/Box3Helper.html b/docs/api/helpers/Box3Helper.html index 3932a238de..d89173c629 100644 --- a/docs/api/helpers/Box3Helper.html +++ b/docs/api/helpers/Box3Helper.html @@ -50,7 +50,7 @@

See the base [page:LineSegments] class for common methods.

-

[method:void updateMatrixWorld]( force )

+

[method:void updateMatrixWorld]( [param:Boolean force] )

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] diff --git a/docs/api/helpers/PlaneHelper.html b/docs/api/helpers/PlaneHelper.html index 264840b4a9..2f0c51ee55 100644 --- a/docs/api/helpers/PlaneHelper.html +++ b/docs/api/helpers/PlaneHelper.html @@ -51,7 +51,7 @@

Methods

See the base [page:LineSegments] class for common methods.

-

[method:void updateMatrixWorld]( force )

+

[method:void updateMatrixWorld]( [param:Boolean force] )

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 diff --git a/docs/api/materials/PointsMaterial.html b/docs/api/materials/PointsMaterial.html index cf28f20035..f39ecb0c4d 100644 --- a/docs/api/materials/PointsMaterial.html +++ b/docs/api/materials/PointsMaterial.html @@ -55,7 +55,7 @@ var starField = new THREE.Points( starsGeometry, starsMaterial ); scene.add( starField ); -

[name]( [page:Object parameters] )

+

[name]( [param:Object parameters] )

[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.

diff --git a/docs/api/materials/SpriteMaterial.html b/docs/api/materials/SpriteMaterial.html index f8f5fc0b9f..17273d2c86 100644 --- a/docs/api/materials/SpriteMaterial.html +++ b/docs/api/materials/SpriteMaterial.html @@ -37,7 +37,7 @@ scene.add( sprite ); -

[name]( [page:Object parameters] )

+

[name]( [param:Object parameters] )

[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.

diff --git a/docs/api/math/Cylindrical.html b/docs/api/math/Cylindrical.html index a3e0b50902..5a5e9a29c9 100644 --- a/docs/api/math/Cylindrical.html +++ b/docs/api/math/Cylindrical.html @@ -50,7 +50,7 @@ and [page:.y y] properties to this cylindrical.

-

[method:Cylindrical set]( [param:Float radius], [param:Float phi], [param:Float theta] )

+

[method:Cylindrical set]( [param:Float radius], [param:Float theta], [param:Float y] )

Sets values of this cylindrical's [page:.radius radius], [page:.theta theta] and [page:.y y] properties.

diff --git a/docs/api/math/Euler.html b/docs/api/math/Euler.html index 71b59eecc2..4718b5f0af 100644 --- a/docs/api/math/Euler.html +++ b/docs/api/math/Euler.html @@ -176,8 +176,13 @@ Returns an array of the form [[page:.x x], [page:.y y], [page:.z z], [page:.order order ]].

-

[method:Vector3 toVector3]()

-

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

+

[method:Vector3 toVector3]( [param:Vector3 optionalResult] )

+

+ [page:Vector3 optionalResult] — (optional) If specified, the result will be copied into this Vector, + otherwise a new one will be created.

+ + Returns the Euler's [page:.x x], [page:.y y] and [page:.z z] properties as a [page:Vector3]. +

Source

diff --git a/docs/api/math/Math.html b/docs/api/math/Math.html index af9300abe4..a1adb47ad1 100644 --- a/docs/api/math/Math.html +++ b/docs/api/math/Math.html @@ -55,11 +55,11 @@

[method:Float mapLinear]( - [page:Float x], - [page:Float a1], - [page:Float a2], - [page:Float b1], - [page:Float b2] )

+ [param:Float x], + [param:Float a1], + [param:Float a2], + [param:Float b1], + [param:Float b2] )

[page:Float x] — Value to be mapped.
[page:Float a1] — Minimum value for range A.
diff --git a/docs/api/math/Matrix3.html b/docs/api/math/Matrix3.html index 0fc2f44e67..2ded760a56 100644 --- a/docs/api/math/Matrix3.html +++ b/docs/api/math/Matrix3.html @@ -146,9 +146,9 @@ m.elements = [ 11, 21, 31,

[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] ) + [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] )

[page:Float n11] - value to put in row 1, col 1.
@@ -171,8 +171,8 @@ m.elements = [ 11, 21, 31,

[method:this setUvTransform]( - [page:Float tx], [page:Float ty], [page:Float sx], [page:Float sy], - [page:Float rotation], [page:Float cx], [page:Float cy] ) + [param:Float tx], [param:Float ty], [param:Float sx], [param:Float sy], + [param:Float rotation], [param:Float cx], [param:Float cy] )

[page:Float tx] - offset x
diff --git a/docs/api/math/Matrix4.html b/docs/api/math/Matrix4.html index 2201556aa0..0c5828502b 100644 --- a/docs/api/math/Matrix4.html +++ b/docs/api/math/Matrix4.html @@ -369,10 +369,10 @@ x, y, 1, 0,

Multiplies the columns of this matrix by vector [page:Vector3 v].

[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] )

+ [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] )

Set the [page:.elements elements] of this matrix to the supplied row-major values [page:Float n11], [page:Float n12], ... [page:Float n44]. diff --git a/docs/api/math/Quaternion.html b/docs/api/math/Quaternion.html index a9c4b114e0..1ef5ffa1df 100644 --- a/docs/api/math/Quaternion.html +++ b/docs/api/math/Quaternion.html @@ -263,13 +263,13 @@ q.slerp( qb, t )

[method:null slerpFlat]( - [page:Array dst], - [page:Integer dstOffset], - [page:Array src0], - [page:Integer srcOffset0], - [page:Array src1], - [page:Integer srcOffset1], - [page:Float t] + [param:Array dst], + [param:Integer dstOffset], + [param:Array src0], + [param:Integer srcOffset0], + [param:Array src1], + [param:Integer srcOffset1], + [param:Float t] )

diff --git a/docs/api/objects/Mesh.html b/docs/api/objects/Mesh.html index 5ba89e4061..c5204f5b18 100644 --- a/docs/api/objects/Mesh.html +++ b/docs/api/objects/Mesh.html @@ -86,7 +86,7 @@

Methods

See the base [page:Object3D] class for common methods.

-

[method:null setDrawMode]()

+

[method:null setDrawMode]( [param:Integer value] )

Set the value of [page:.drawMode drawMode].

[method:Mesh clone]()

diff --git a/docs/api/textures/Texture.html b/docs/api/textures/Texture.html index b1336baa16..b64bea075e 100644 --- a/docs/api/textures/Texture.html +++ b/docs/api/textures/Texture.html @@ -234,12 +234,12 @@ [page:Texture.rotation .rotation], and [page:Texture.center .center].

-

[method:Texture clone]( [param:Texture texture] )

+

[method:Texture clone]()

Make copy of the texture. Note this is not a "deep copy", the image is shared.

-

[method:Texture toJSON]( meta )

+

[method:Texture toJSON]( [param:Object meta] )

meta -- optional object containing metadata.
Convert the material to three.js JSON format. @@ -250,7 +250,7 @@ Call [page:EventDispatcher EventDispatcher].dispatchEvent with a 'dispose' event type.

-

[method:null transformUv]( uv )

+

[method:null transformUv]( [param:Vector2 uv] )

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. diff --git a/docs/page.js b/docs/page.js index dc8c89fc2e..b3abda15fd 100644 --- a/docs/page.js +++ b/docs/page.js @@ -60,7 +60,7 @@ function onDocumentLoad( event ) { // text = text.replace( /\[member:.([\w]+) ([\w\.\s]+)\]/gi, "$2" ); text = text.replace( /\[(member|property|method|param):([\w]+)\]/gi, "[$1:$2 $2]" ); // [member:name] to [member:name title] - text = text.replace( /\[(?:member|property|method):([\w]+) ([\w\.\s]+)\]\s*(\(.*\))?/gi, "# .$2 $3 : $1" ); + text = text.replace( /\[(?:member|property|method):([\w]+) ([\w\.\s]+)\]\s*(\([^]*?\))?/gi, "# .$2 $3 : $1" ); text = text.replace( /\[param:([\w\.]+) ([\w\.\s]+)\]/gi, "$2 : $1" ); // [param:name title] text = text.replace( /\[link:([\w|\:|\/|\.|\-|\_]+)\]/gi, "[link:$1 $1]" ); // [link:url] to [link:url title] -- GitLab