Skip to content

Commit 73c4933

Browse files
aardgoosemrdoob
aardgoose
authored and
mrdoob
committed
white space corrections and a few method tags (mrdoob#8994)
pedant mode on. camera, core and math dirs + a stray "]" in WebGLRenderer docs
1 parent 704e721 commit 73c4933

14 files changed

+98
-98
lines changed

‎docs/api/cameras/Camera.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ <h3>[property:Matrix4 projectionMatrix]</h3>
3636

3737
<h2>Methods</h2>
3838

39-
<h3>[method:Vector3 getWorldDirection]([page:Vector3 vector])</h3>
39+
<h3>[method:Vector3 getWorldDirection]( [page:Vector3 vector] )</h3>
4040
<div>
4141
vector — (optional)<br />
4242
<br />

‎docs/api/cameras/CubeCamera.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ <h2>Examples</h2>
4343
<h2>Constructor</h2>
4444

4545

46-
<h3>[name]([page:number near], [page:number far], [page:number cubeResolution])</h3>
46+
<h3>[name]( [page:number near], [page:number far], [page:number cubeResolution] )</h3>
4747
<div>
4848
near -- The near clipping distance. <br />
4949
far -- The far clipping distance <br />
@@ -68,7 +68,7 @@ <h2>Methods</h2>
6868

6969

7070

71-
<h3>[method:null updateCubeMap]([page:WebGLRenderer renderer], [page:Scene scene])</h3>
71+
<h3>[method:null updateCubeMap]( [page:WebGLRenderer renderer], [page:Scene scene] )</h3>
7272
<div>
7373
renderer -- The current WebGL renderer <br />
7474
scene -- The current scene

‎docs/api/core/BufferAttribute.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ <h1>[name]</h1>
1515
</div>
1616

1717
<h2>Constructor</h2>
18-
<h3>[name]([page:TypedArray array], [page:Integer itemSize], [page:Boolean normalized])</h3>
18+
<h3>[name]( [page:TypedArray array], [page:Integer itemSize], [page:Boolean normalized] )</h3>
1919
<div>
2020
Instantiates this attribute with data from the associated buffer.
2121
itemSize gives the number of values of the array that should be associated with a particular vertex. normalized indicates how the underlying data in the buffer maps to the values in the GLSL shader code.

‎docs/api/core/Object3D.html

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ <h2>Methods</h2>
143143

144144
<h3>[page:EventDispatcher EventDispatcher] methods are available on this class.</h3>
145145

146-
<h3>[method:null applyMatrix]( [page:Matrix4 matrix])</h3>
146+
<h3>[method:null applyMatrix]( [page:Matrix4 matrix] )</h3>
147147
<div>
148148
matrix - matrix
149149
</div>
@@ -256,63 +256,63 @@ <h3>[method:Object3D clone]()</h3>
256256
</div>
257257

258258

259-
<h3>[method:Object3D getObjectByName]([page:String name])</h3>
259+
<h3>[method:Object3D getObjectByName]( [page:String name] )</h3>
260260
<div>
261261
name -- String to match to the children's Object3d.name property. <br />
262262
</div>
263263
<div>
264264
Searches through the object's children and returns the first with a matching name.
265265
</div>
266266

267-
<h3>[method:Object3D getObjectById]([page:Integer id])</h3>
267+
<h3>[method:Object3D getObjectById]( [page:Integer id] )</h3>
268268
<div>
269269
id -- Unique number of the object instance<br />
270270
</div>
271271
<div>
272272
Searches through the object's children and returns the first with a matching id.
273273
</div>
274274

275-
<h3>[method:Vector3 getWorldPosition]([page:Vector3 optionalTarget])</h3>
275+
<h3>[method:Vector3 getWorldPosition]( [page:Vector3 optionalTarget] )</h3>
276276
<div>
277277
optionalTarget — Optional target to set the result. Otherwise, a new `Vector3` is instantiated. (optional)<br />
278278
</div>
279279
<div>
280280
Returns a vector representing the position of the object in world space.
281281
</div>
282282

283-
<h3>[method:Quaternion getWorldQuaternion]([page:Quaternion optionalTarget])</h3>
283+
<h3>[method:Quaternion getWorldQuaternion]( [page:Quaternion optionalTarget] )</h3>
284284
<div>
285285
optionalTarget — Optional target to set the result. Otherwise, a new `Quaternion` is instantiated. (optional)<br />
286286
</div>
287287
<div>
288288
Returns a quaternion representing the rotation of the object in world space.
289289
</div>
290290

291-
<h3>[method:Euler getWorldRotation]([page:Euler optionalTarget])</h3>
291+
<h3>[method:Euler getWorldRotation]( [page:Euler optionalTarget] )</h3>
292292
<div>
293293
optionalTarget — Optional target to set the result. Otherwise, a new `Euler` is instantiated. (optional)<br />
294294
</div>
295295
<div>
296296
Returns the euler angles representing the rotation of the object in world space.
297297
</div>
298298

299-
<h3>[method:Vector3 getWorldScale]([page:Vector3 optionalTarget])</h3>
299+
<h3>[method:Vector3 getWorldScale]( [page:Vector3 optionalTarget] )</h3>
300300
<div>
301301
optionalTarget — Optional target to set the result. Otherwise, a new `Vector3` is instantiated. (optional)<br />
302302
</div>
303303
<div>
304304
Returns a vector of the scaling factors applied to the object for each axis in world space.
305305
</div>
306306

307-
<h3>[method:Vector3 getWorldDirection]([page:Vector3 optionalTarget])</h3>
307+
<h3>[method:Vector3 getWorldDirection]( [page:Vector3 optionalTarget] )</h3>
308308
<div>
309309
optionalTarget — Optional target to set the result. Otherwise, a new `Vector3` is instantiated. (optional)<br />
310310
</div>
311311
<div>
312312
Returns a vector representing the direction of object's positive z-axis in world space.
313313
</div>
314314

315-
<h3>[method:Object3D translateOnAxis]([page:Vector3 axis], [page:Float distance])</h3>
315+
<h3>[method:Object3D translateOnAxis]( [page:Vector3 axis], [page:Float distance] )</h3>
316316
<div>
317317
axis -- A normalized vector in object space.<br />
318318
distance -- The distance to translate.
@@ -321,7 +321,7 @@ <h3>[method:Object3D translateOnAxis]([page:Vector3 axis], [page:Float distance]
321321
Translate an object by distance along an axis in object space. The axis is assumed to be normalized.
322322
</div>
323323

324-
<h3>[method:Object3D rotateOnAxis]([page:Vector3 axis], [page:Float angle])</h3>
324+
<h3>[method:Object3D rotateOnAxis]( [page:Vector3 axis], [page:Float angle] )</h3>
325325
<div>
326326
axis -- A normalized vector in object space. <br />
327327
angle -- The angle in radians.
@@ -330,7 +330,7 @@ <h3>[method:Object3D rotateOnAxis]([page:Vector3 axis], [page:Float angle])</h3>
330330
Rotate an object along an axis in object space. The axis is assumed to be normalized.
331331
</div>
332332

333-
<h3>[method:Array raycast]([page:Raycaster raycaster], [page:Array intersects])</h3>
333+
<h3>[method:Array raycast]( [page:Raycaster raycaster], [page:Array intersects] )</h3>
334334
<div>
335335
Abstract method to get intersections between a casted ray and this object. Subclasses such as [page:Mesh], [page:Line], and [page:Points] implement this method in order to participate in raycasting.
336336
</div>

‎docs/api/math/Color.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ <h3>[method:Color copy]( [page:Color color] ) [page:Color this]</h3>
8989
Copies given color.
9090
</div>
9191

92-
<h3>[method:Color fromArray]([page:Array array], [page:Integer offset]) [page:Color this]</h3>
92+
<h3>[method:Color fromArray]( [page:Array array], [page:Integer offset] ) [page:Color this]</h3>
9393
<div>
9494
array -- [page:Array] [r, g, b] <br />
9595
offset -- [page:Integer] An optional offset into the array.
@@ -175,7 +175,7 @@ <h3>[method:Color setHSL]( [page:Float h], [page:Float s], [page:Float l] ) [pag
175175
Sets color from hsl
176176
</div>
177177

178-
<h3>.getHSL() [page:Object hsl]</h3>
178+
<h3>[method:Object getHSL]() [page:Object hsl]</h3>
179179
<div>
180180
Returns an object with properties h, s, and l.
181181
</div>
@@ -228,7 +228,7 @@ <h3>[method:Color clone]() [page:Color this]</h3>
228228
Clones this color.
229229
</div>
230230

231-
<h3>[method:Array toArray]([page:Array array], [page:Integer offset]) [page:Color this]</h3>
231+
<h3>[method:Array toArray]( [page:Array array], [page:Integer offset] ) [page:Color this]</h3>
232232
<div>
233233
array -- An optional array to store the color to. <br />
234234
offset -- An optional offset into the array.

‎docs/api/math/Euler.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ <h3>[method:Euler reorder]( [page:String newOrder] ) [page:Euler this]</h3>
9292
WARNING: this discards revolution information.
9393
</div>
9494

95-
<h3>[method:Euler setFromVector3]([page:Vector3 vector], [page:String order]) [page:Euler this]</h3>
95+
<h3>[method:Euler setFromVector3]( [page:Vector3 vector], [page:String order] ) [page:Euler this]</h3>
9696
<div>
9797
vector -- [page:Vector3].
9898
order -- [page:string] Order of axes, defaults to 'XYZ' (must be upper case)
@@ -106,7 +106,7 @@ <h3>[method:Vector3 toVector3]()</h3>
106106
Returns the Euler's XYZ properties as a Vector3.
107107
</div>
108108

109-
<h3>[method:Euler fromArray]([page:Array array]) [page:Euler this]</h3>
109+
<h3>[method:Euler fromArray]( [page:Array array] ) [page:Euler this]</h3>
110110
<div>
111111
array -- [page:Array] of length 3 or 4. array[3] is an optional order argument.
112112
</div>

‎docs/api/math/Frustum.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ <h3>[method:Frustum clone]()</h3>
5252
Return a copy of this Frustum
5353
</div>
5454

55-
<h3>[method:Boolean set]([page:Plane p0], [page:Plane p1], [page:Plane p2], [page:Plane p3], [page:Plane p4], [page:Plane p5])</h3>
55+
<h3>[method:Boolean set]( [page:Plane p0], [page:Plane p1], [page:Plane p2], [page:Plane p3], [page:Plane p4], [page:Plane p5] )</h3>
5656
<div>
5757
p0 -- [page:Plane] <br />
5858
p1 -- [page:Plane] <br />
@@ -65,31 +65,31 @@ <h3>[method:Boolean set]([page:Plane p0], [page:Plane p1], [page:Plane p2], [pag
6565
Sets the current frustum from the passed planes. No plane order is implicitely implied.
6666
</div>
6767

68-
<h3>[method:Frustum copy]([page:Frustum frustum]) [page:Frustum this]</h3>
68+
<h3>[method:Frustum copy]( [page:Frustum frustum] ) [page:Frustum this]</h3>
6969
<div>
7070
frustum -- The frustum to copy
7171
</div>
7272
<div>
7373
Copies the values of the passed frustum.
7474
</div>
7575

76-
<h3>[method:Boolean containsPoint]([page:Vector3 point])</h3>
76+
<h3>[method:Boolean containsPoint]( [page:Vector3 point] )</h3>
7777
<div>
7878
point -- [page:Vector3] to test
7979
</div>
8080
<div>
8181
Checks to see if the frustum contains the point.
8282
</div>
8383

84-
<h3>[method:Boolean intersectsBox]([page:Box3 box])</h3>
84+
<h3>[method:Boolean intersectsBox]( [page:Box3 box] )</h3>
8585
<div>
8686
box -- [page:Box3]
8787
</div>
8888
<div>
8989
Check to see if the box intersects with the frustum.
9090
</div>
9191

92-
<h3>[method:Boolean intersectsSphere]([page:Sphere sphere])</h3>
92+
<h3>[method:Boolean intersectsSphere]( [page:Sphere sphere] )</h3>
9393
<div>
9494
sphere -- [page:Sphere]
9595
</div>

‎docs/api/math/Line3.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ <h1>[name]</h1>
1616
<h2>Constructor</h2>
1717

1818

19-
<h3>[name]([page:Vector3 start], [page:Vector3 end])</h3>
19+
<h3>[name]( [page:Vector3 start], [page:Vector3 end] )</h3>
2020
<div>
2121
start -- [page:Vector3] Start of the line segment<br />
2222
end -- [page:Vector3] End of the line segment
@@ -38,7 +38,7 @@ <h2>Methods</h2>
3838

3939

4040

41-
<h3>[method:Line3 set]([page:Vector3 start], [page:Vector3 end])</h3>
41+
<h3>[method:Line3 set]( [page:Vector3 start], [page:Vector3 end] )</h3>
4242
<div>
4343
start -- [page:Vector3] <br />
4444
end -- [page:Vector3]
@@ -47,7 +47,7 @@ <h3>[method:Line3 set]([page:Vector3 start], [page:Vector3 end])</h3>
4747
Sets the start and end values by copying the provided vectors.
4848
</div>
4949

50-
<h3>[method:Line3 copy]([page:Line3 line])</h3>
50+
<h3>[method:Line3 copy]( [page:Line3 line] )</h3>
5151
<div>
5252
line -- [page:Line3]
5353
</div>
@@ -60,7 +60,7 @@ <h3>[method:Line3 clone]()</h3>
6060
Return a new copy of this [page:Line3].
6161
</div>
6262

63-
<h3>[method:Boolean equals]([page:Line3 line])</h3>
63+
<h3>[method:Boolean equals]( [page:Line3 line] )</h3>
6464
<div>
6565
line -- [page:Line3]
6666
</div>
@@ -78,15 +78,15 @@ <h3>[method:Float distanceSq]()</h3>
7878
Returns the line segment's length squared.
7979
</div>
8080

81-
<h3>[method:Line3 applyMatrix4]([page:Matrix4 matrix]) [page:Line3 this]</h3>
81+
<h3>[method:Line3 applyMatrix4]( [page:Matrix4 matrix] ) [page:Line3 this]</h3>
8282
<div>
8383
matrix -- [page:Matrix4]
8484
</div>
8585
<div>
8686
Apply a matrix transform to the line segment.
8787
</div>
8888

89-
<h3>[method:Vector at]([page:Float t], [page:Vector3 optionalTarget])</h3>
89+
<h3>[method:Vector at]( [page:Float t], [page:Vector3 optionalTarget] )</h3>
9090
<div>
9191
t -- [page:Float] Use values 0-1 to return a result on the line segment. <br />
9292
optionalTarget -- [page:Vector] Optional target to set the result.
@@ -95,23 +95,23 @@ <h3>[method:Vector at]([page:Float t], [page:Vector3 optionalTarget])</h3>
9595
Return a vector at a certain position along the line. When t = 0, it returns the start vector, and when t=1 it returns the end vector.
9696
</div>
9797

98-
<h3>[method:Vector3 center]([page:Vector3 optionalTarget])</h3>
98+
<h3>[method:Vector3 center]( [page:Vector3 optionalTarget] )</h3>
9999
<div>
100100
optionalTarget -- [page:Vector3] Optional target to set the result.
101101
</div>
102102
<div>
103103
Return the center of the line segment.
104104
</div>
105105

106-
<h3>[method:Vector3 delta]([page:Vector3 optionalTarget])</h3>
106+
<h3>[method:Vector3 delta]( [page:Vector3 optionalTarget] )</h3>
107107
<div>
108108
optionalTarget -- [page:Vector3] Optional target to set the result.
109109
</div>
110110
<div>
111111
Returns the delta vector of the line segment, or the end vector minus the start vector.
112112
</div>
113113

114-
<h3>[method:Vector3 closestPointToPoint]([page:Vector3 point], [page:Boolean clampToLine], [page:Vector3 optionalTarget])</h3>
114+
<h3>[method:Vector3 closestPointToPoint]( [page:Vector3 point], [page:Boolean clampToLine], [page:Vector3 optionalTarget] )</h3>
115115
<div>
116116
point -- [page:Vector3] <br />
117117
clampToLine -- [page:Boolean] <br />
@@ -121,7 +121,7 @@ <h3>[method:Vector3 closestPointToPoint]([page:Vector3 point], [page:Boolean cla
121121
Returns the closets point on the line. If clamp to line is true, then the returned value will be clamped to the line segment.
122122
</div>
123123

124-
<h3>[method:Float closestPointToPointParameter]([page:Vector3 point], [page:Boolean clampToLine])</h3>
124+
<h3>[method:Float closestPointToPointParameter]( [page:Vector3 point], [page:Boolean clampToLine] )</h3>
125125
<div>
126126
point -- [page:Vector3] <br />
127127
clampToLine -- [page:Boolean]

‎docs/api/math/Math.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,23 +59,23 @@ <h3>[method:Float randFloatSpread]( [page:Float range] )</h3>
5959
Random float from *- range / 2* to *range / 2* interval.
6060
</div>
6161

62-
<h3>[method:Float degToRad]([page:Float degrees])</h3>
62+
<h3>[method:Float degToRad]( [page:Float degrees] )</h3>
6363
<div>
6464
degrees -- [page:Float]
6565
</div>
6666
<div>
6767
Converts degrees to radians.
6868
</div>
6969

70-
<h3>[method:Float radToDeg]([page:Float radians])</h3>
70+
<h3>[method:Float radToDeg]( [page:Float radians] )</h3>
7171
<div>
7272
radians -- [page:Float]
7373
</div>
7474
<div>
7575
Converts radians to degrees
7676
</div>
7777

78-
<h3>[method:Float smoothstep]([page:Float x], [page:Float min], [page:Float max])</h3>
78+
<h3>[method:Float smoothstep]( [page:Float x], [page:Float min], [page:Float max] )</h3>
7979
<div>
8080
x -- The value to evaluate based on its position between min and max. <br />
8181
min -- Any x value below min will be 0 <br />
@@ -87,7 +87,7 @@ <h3>[method:Float smoothstep]([page:Float x], [page:Float min], [page:Float max]
8787
[link:http://en.wikipedia.org/wiki/Smoothstep Wikipedia]
8888
</div>
8989

90-
<h3>[method:Float smootherstep]([page:Float x], [page:Float min], [page:Float max])</h3>
90+
<h3>[method:Float smootherstep]( [page:Float x], [page:Float min], [page:Float max] )</h3>
9191
<div>
9292
x -- The value to evaluate based on its position between min and max. <br />
9393
min -- Any x value below min will be 0 <br />

0 commit comments

Comments
 (0)