Skip to content

Commit

Permalink
white space corrections and a few method tags (#8994)
Browse files Browse the repository at this point in the history 
pedant mode on.

camera, core and math  dirs + a stray "]" in WebGLRenderer docs
  • Loading branch information
@aardgoose @mrdoob
aardgoose authored and mrdoob committed May 25, 2016
1 parent 704e721 commit 73c4933
Show file tree
Hide file tree
Showing 14 changed files with 98 additions and 98 deletions.
2 changes: 1 addition & 1 deletion docs/api/cameras/Camera.html
View file
Expand Up @@ -36,7 +36,7 @@ <h3>[property:Matrix4 projectionMatrix]</h3>

<h2>Methods</h2>

<h3>[method:Vector3 getWorldDirection]([page:Vector3 vector])</h3>
<h3>[method:Vector3 getWorldDirection]( [page:Vector3 vector] )</h3>
<div>
vector — (optional)<br />
<br />
Expand Down
4 changes: 2 additions & 2 deletions docs/api/cameras/CubeCamera.html
View file
Expand Up @@ -43,7 +43,7 @@ <h2>Examples</h2>
<h2>Constructor</h2>


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



<h3>[method:null updateCubeMap]([page:WebGLRenderer renderer], [page:Scene scene])</h3>
<h3>[method:null updateCubeMap]( [page:WebGLRenderer renderer], [page:Scene scene] )</h3>
<div>
renderer -- The current WebGL renderer <br />
scene -- The current scene
Expand Down
2 changes: 1 addition & 1 deletion docs/api/core/BufferAttribute.html
View file
Expand Up @@ -15,7 +15,7 @@ <h1>[name]</h1>
</div>

<h2>Constructor</h2>
<h3>[name]([page:TypedArray array], [page:Integer itemSize], [page:Boolean normalized])</h3>
<h3>[name]( [page:TypedArray array], [page:Integer itemSize], [page:Boolean normalized] )</h3>
<div>
Instantiates this attribute with data from the associated buffer.
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.
Expand Down
22 changes: 11 additions & 11 deletions docs/api/core/Object3D.html
View file
Expand Up @@ -143,7 +143,7 @@ <h2>Methods</h2>

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

<h3>[method:null applyMatrix]( [page:Matrix4 matrix])</h3>
<h3>[method:null applyMatrix]( [page:Matrix4 matrix] )</h3>
<div>
matrix - matrix
</div>
Expand Down Expand Up @@ -256,63 +256,63 @@ <h3>[method:Object3D clone]()</h3>
</div>


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

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

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

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

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

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

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

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

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

<h3>[method:Array raycast]([page:Raycaster raycaster], [page:Array intersects])</h3>
<h3>[method:Array raycast]( [page:Raycaster raycaster], [page:Array intersects] )</h3>
<div>
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.
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/api/math/Color.html
View file
Expand Up @@ -89,7 +89,7 @@ <h3>[method:Color copy]( [page:Color color] ) [page:Color this]</h3>
Copies given color.
</div>

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

<h3>.getHSL() [page:Object hsl]</h3>
<h3>[method:Object getHSL]() [page:Object hsl]</h3>
<div>
Returns an object with properties h, s, and l.
</div>
Expand Down Expand Up @@ -228,7 +228,7 @@ <h3>[method:Color clone]() [page:Color this]</h3>
Clones this color.
</div>

<h3>[method:Array toArray]([page:Array array], [page:Integer offset]) [page:Color this]</h3>
<h3>[method:Array toArray]( [page:Array array], [page:Integer offset] ) [page:Color this]</h3>
<div>
array -- An optional array to store the color to. <br />
offset -- An optional offset into the array.
Expand Down
4 changes: 2 additions & 2 deletions docs/api/math/Euler.html
View file
Expand Up @@ -92,7 +92,7 @@ <h3>[method:Euler reorder]( [page:String newOrder] ) [page:Euler this]</h3>
WARNING: this discards revolution information.
</div>

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

<h3>[method:Euler fromArray]([page:Array array]) [page:Euler this]</h3>
<h3>[method:Euler fromArray]( [page:Array array] ) [page:Euler this]</h3>
<div>
array -- [page:Array] of length 3 or 4. array[3] is an optional order argument.
</div>
Expand Down
10 changes: 5 additions & 5 deletions docs/api/math/Frustum.html
View file
Expand Up @@ -52,7 +52,7 @@ <h3>[method:Frustum clone]()</h3>
Return a copy of this Frustum
</div>

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

<h3>[method:Frustum copy]([page:Frustum frustum]) [page:Frustum this]</h3>
<h3>[method:Frustum copy]( [page:Frustum frustum] ) [page:Frustum this]</h3>
<div>
frustum -- The frustum to copy
</div>
<div>
Copies the values of the passed frustum.
</div>

<h3>[method:Boolean containsPoint]([page:Vector3 point])</h3>
<h3>[method:Boolean containsPoint]( [page:Vector3 point] )</h3>
<div>
point -- [page:Vector3] to test
</div>
<div>
Checks to see if the frustum contains the point.
</div>

<h3>[method:Boolean intersectsBox]([page:Box3 box])</h3>
<h3>[method:Boolean intersectsBox]( [page:Box3 box] )</h3>
<div>
box -- [page:Box3]
</div>
<div>
Check to see if the box intersects with the frustum.
</div>

<h3>[method:Boolean intersectsSphere]([page:Sphere sphere])</h3>
<h3>[method:Boolean intersectsSphere]( [page:Sphere sphere] )</h3>
<div>
sphere -- [page:Sphere]
</div>
Expand Down
20 changes: 10 additions & 10 deletions docs/api/math/Line3.html
View file
Expand Up @@ -16,7 +16,7 @@ <h1>[name]</h1>
<h2>Constructor</h2>


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



<h3>[method:Line3 set]([page:Vector3 start], [page:Vector3 end])</h3>
<h3>[method:Line3 set]( [page:Vector3 start], [page:Vector3 end] )</h3>
<div>
start -- [page:Vector3] <br />
end -- [page:Vector3]
Expand All @@ -47,7 +47,7 @@ <h3>[method:Line3 set]([page:Vector3 start], [page:Vector3 end])</h3>
Sets the start and end values by copying the provided vectors.
</div>

<h3>[method:Line3 copy]([page:Line3 line])</h3>
<h3>[method:Line3 copy]( [page:Line3 line] )</h3>
<div>
line -- [page:Line3]
</div>
Expand All @@ -60,7 +60,7 @@ <h3>[method:Line3 clone]()</h3>
Return a new copy of this [page:Line3].
</div>

<h3>[method:Boolean equals]([page:Line3 line])</h3>
<h3>[method:Boolean equals]( [page:Line3 line] )</h3>
<div>
line -- [page:Line3]
</div>
Expand All @@ -78,15 +78,15 @@ <h3>[method:Float distanceSq]()</h3>
Returns the line segment's length squared.
</div>

<h3>[method:Line3 applyMatrix4]([page:Matrix4 matrix]) [page:Line3 this]</h3>
<h3>[method:Line3 applyMatrix4]( [page:Matrix4 matrix] ) [page:Line3 this]</h3>
<div>
matrix -- [page:Matrix4]
</div>
<div>
Apply a matrix transform to the line segment.
</div>

<h3>[method:Vector at]([page:Float t], [page:Vector3 optionalTarget])</h3>
<h3>[method:Vector at]( [page:Float t], [page:Vector3 optionalTarget] )</h3>
<div>
t -- [page:Float] Use values 0-1 to return a result on the line segment. <br />
optionalTarget -- [page:Vector] Optional target to set the result.
Expand All @@ -95,23 +95,23 @@ <h3>[method:Vector at]([page:Float t], [page:Vector3 optionalTarget])</h3>
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.
</div>

<h3>[method:Vector3 center]([page:Vector3 optionalTarget])</h3>
<h3>[method:Vector3 center]( [page:Vector3 optionalTarget] )</h3>
<div>
optionalTarget -- [page:Vector3] Optional target to set the result.
</div>
<div>
Return the center of the line segment.
</div>

<h3>[method:Vector3 delta]([page:Vector3 optionalTarget])</h3>
<h3>[method:Vector3 delta]( [page:Vector3 optionalTarget] )</h3>
<div>
optionalTarget -- [page:Vector3] Optional target to set the result.
</div>
<div>
Returns the delta vector of the line segment, or the end vector minus the start vector.
</div>

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

<h3>[method:Float closestPointToPointParameter]([page:Vector3 point], [page:Boolean clampToLine])</h3>
<h3>[method:Float closestPointToPointParameter]( [page:Vector3 point], [page:Boolean clampToLine] )</h3>
<div>
point -- [page:Vector3] <br />
clampToLine -- [page:Boolean]
Expand Down
8 changes: 4 additions & 4 deletions docs/api/math/Math.html
View file
Expand Up @@ -59,23 +59,23 @@ <h3>[method:Float randFloatSpread]( [page:Float range] )</h3>
Random float from *- range / 2* to *range / 2* interval.
</div>

<h3>[method:Float degToRad]([page:Float degrees])</h3>
<h3>[method:Float degToRad]( [page:Float degrees] )</h3>
<div>
degrees -- [page:Float]
</div>
<div>
Converts degrees to radians.
</div>

<h3>[method:Float radToDeg]([page:Float radians])</h3>
<h3>[method:Float radToDeg]( [page:Float radians] )</h3>
<div>
radians -- [page:Float]
</div>
<div>
Converts radians to degrees
</div>

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

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

0 comments on commit 73c4933

Please sign in to comment.