Skip to content

Commit d1c1cf7

Browse files
moraxymoraxy
committed
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.
1 parent d2b5ec8 commit d1c1cf7

21 files changed

+77
-72
lines changed

‎docs/api/animation/PropertyMixer.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ <h1>[name]</h1>
1818
<h2>Constructor</h2>
1919

2020

21-
<h3>[name]( binding, typeName, valueSize )</h3>
21+
<h3>[name]( [param:PropertyBinding binding], [param:String typeName], [param:Number valueSize] )</h3>
2222
<p>
2323
-- binding <br />
2424
-- typeName <br />
@@ -29,12 +29,12 @@ <h3>[name]( binding, typeName, valueSize )</h3>
2929
<h2>Properties</h2>
3030

3131

32-
<h3>[property:Number binding]</h3>
32+
<h3>[property:PropertyBinding binding]</h3>
3333
<p>
3434

3535
</p>
3636

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

6969

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

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

77-
<h3>[method:null apply]( accuIndex )</h3>
77+
<h3>[method:null apply]( [param:Number accuIndex] )</h3>
7878
<p>
7979
Apply the state of [page:PropertyMixer.buffer buffer] 'accu[i]' to the binding when accus differ.
8080
</p>

‎docs/api/cameras/Camera.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ <h3>[method:Camera clone]( )</h3>
6464
Return a new camera with the same properties as this one.
6565
</p>
6666

67-
<h3>[method:Camera copy]( [param:Camera source] )</h3>
67+
<h3>[method:Camera copy]( [param:Camera source], [param:Boolean recursive] )</h3>
6868
<p>
6969
Copy the properties from the source camera into this one.
7070
</p>

‎docs/api/cameras/StereoCamera.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ <h3>[property:PerspectiveCamera cameraR]</h3>
5555

5656
<h2>Methods</h2>
5757

58-
<h3>[method:null update]( camera )</h3>
58+
<h3>[method:null update]( [param:PerspectiveCamera camera] )</h3>
5959
<p>
6060
Update the stereo cameras based on the camera passed in.
6161
</p>

‎docs/api/core/BufferAttribute.html‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -131,28 +131,28 @@ <h3>[method:BufferAttribute copyArray]( array ) </h3>
131131
<h3>[method:null copyAt] ( [param:Integer index1], [param:BufferAttribute bufferAttribute], [param:Integer index2] ) </h3>
132132
<p>Copy a vector from bufferAttribute[index2] to [page:BufferAttribute.array array][index1].</p>
133133

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

209209

‎docs/api/core/DirectGeometry.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,13 +91,13 @@ <h3>[property:Boolean groupsNeedUpdate]</h3>
9191

9292
<h2>Methods</h2>
9393

94-
<h3>[property:null computeGroups]( [page:Geometry geometry] )</h3>
94+
<h3>[property:null computeGroups]( [param:Geometry geometry] )</h3>
9595
<p>
9696
Compute the parts of the geometry that have different materialIndex.
9797
See [page:BufferGeometry.groups].
9898
</p>
9999

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

103103

‎docs/api/core/InterleavedBuffer.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,15 +91,15 @@ <h3>[method:InterleavedBuffer setDynamic] ( [param:Boolean value] ) </h3>
9191
Set [page:InterleavedBuffer.dynamic dynamic] to value.
9292
</p>
9393

94-
<h3>[method:InterleavedBuffer copy]( source ) </h3>
94+
<h3>[method:InterleavedBuffer copy]( [param:InterleavedBuffer source] ) </h3>
9595
<p>
9696
Copies another [name] to this [name].
9797
</p>
9898

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

102-
<h3>[method:InterleavedBuffer set]( value, offset ) </h3>
102+
<h3>[method:InterleavedBuffer set]( [param:TypedArray value], [param:Integer offset] ) </h3>
103103
<p>
104104
value - The source (typed) array.<br/>
105105
offset - The offset into the target array at which to begin writing values from the source array. Default is *0*.<br/><br />

‎docs/api/core/InterleavedBufferAttribute.html‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -62,37 +62,37 @@ <h3>[property:Boolean isInterleavedBufferAttribute]</h3>
6262

6363
<h2>Methods</h2>
6464

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

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

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

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

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

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

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

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

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

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

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

9898

‎docs/api/core/Raycaster.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ <h3>[method:null setFromCamera]( [param:Vector2 coords], [param:Camera camera] )
144144
Updates the ray with a new origin and direction.
145145
</p>
146146

147-
<h3>[method:Array intersectObject]( [page:Object3D object], [param:Boolean recursive], [param:Array optionalTarget] )</h3>
147+
<h3>[method:Array intersectObject]( [param:Object3D object], [param:Boolean recursive], [param:Array optionalTarget] )</h3>
148148
<p>
149149
[page:Object3D object] — The object to check for intersection with the ray.<br />
150150
[page:Boolean recursive] — If true, it also checks all descendants. Otherwise it only checks intersecton with the object. Default is false.<br />

‎docs/api/helpers/Box3Helper.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ <h2>Methods</h2>
5050
<p>See the base [page:LineSegments] class for common methods.</p>
5151

5252

53-
<h3>[method:void updateMatrixWorld]( force )</h3>
53+
<h3>[method:void updateMatrixWorld]( [param:Boolean force] )</h3>
5454
<p>
5555
This overrides the method in the base [page:Object3D] class so that it
5656
also updates the wireframe box to the extent of the [page:Box3Helper.box .box]

‎docs/api/helpers/PlaneHelper.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ <h3>[property:Float size]</h3>
5151
<h2>Methods</h2>
5252
<p>See the base [page:LineSegments] class for common methods.</p>
5353

54-
<h3>[method:void updateMatrixWorld]( force )</h3>
54+
<h3>[method:void updateMatrixWorld]( [param:Boolean force] )</h3>
5555
<p>
5656
This overrides the method in the base [page:Object3D] class so that it also
5757
updates the helper object according to the [page:PlaneHelper.plane .plane] and

0 commit comments

Comments
 (0)