Skip to content

Commit 006b56a

Browse files
mrdoobmrdoob
authored
Merge pull request #13722 from donmccurdy/docs-manual-linewidth
Documentation: Set 100char linewidths on Manual section.
2 parents 1a12cc8 + d8bdec2 commit 006b56a

File tree

14 files changed

+109
-107
lines changed

14 files changed

+109
-107
lines changed

‎docs/api/Polyfills.html‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,33 +11,33 @@
1111

1212
<h1>Polyfills</h1>
1313

14-
<div class="desc">Three.js includes polyfills for the following functions and constants.</div>
14+
<p class="desc">Three.js includes polyfills for the following functions and constants.</p>
1515

1616
<h3>[page:Number.EPSILON Number.EPSILON]</h3>
17-
<div>
17+
<p>
1818
The difference between one and the smallest value greater than one that can be represented as a Number.
1919
[link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/EPSILON MDN reference].
20-
</div>
20+
</p>
2121

2222
<h3>[page:Math.sign Math.sign]( [page:Number x] )</h3>
23-
<div>
23+
<p>
2424
If the argument is a positive number, negative number, positive zero or negative zero,
2525
the function will return 1, -1, 0 or -0 respectively. Otherwise, NaN is returned.
2626
[link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/sign MDN reference].
27-
</div>
27+
</p>
2828

2929
<h3>[page:Function.prototype.name Function.prototype.name]( [page:Number x] )</h3>
30-
<div>
30+
<p>
3131
Returns the name of a function, or (before ES6 implementations) an empty string for anonymous functions.
3232
[link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/name MDN reference].
33-
</div>
33+
</p>
3434

3535
<h3>[page:Object.assign Object.assign]( [page:Object target], [page:Object ...sources] )</h3>
36-
<div>
36+
<p>
3737
The Object.assign() method is used to copy the values of all enumerable own properties from one or more source objects to a target object.
3838
It will return the target object.
3939
[link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign MDN reference].
40-
</div>
40+
</p>
4141

4242
<h2>Source</h2>
4343

‎docs/api/renderers/webgl/WebGLProgram.html‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<body>
1111
<h1>[name]</h1>
1212

13-
<div class="desc">Constructor for the GLSL program sent to vertex and fragment shaders, including default uniforms and attributes.</div>
13+
<p class="desc">Constructor for the GLSL program sent to vertex and fragment shaders, including default uniforms and attributes.</p>
1414

1515
<h2>Built-in uniforms and attributes</h2>
1616

@@ -106,39 +106,39 @@ <h3>Fragment shader:</h3>
106106
<h2>Constructor</h2>
107107

108108
<h3>[name]( [param:WebGLRenderer renderer], [param:Object code], [param:Material material], [param:Object parameters] )</h3>
109-
<div>For parameters see [page:WebGLRenderer WebGLRenderer]</div>
109+
<p>For parameters see [page:WebGLRenderer WebGLRenderer]</p>
110110

111111
<h2>Properties</h2>
112112

113113
<h3>[property:String id]</h3>
114-
<div></div>
114+
<p></p>
115115

116116
<h3>[property:String code]</h3>
117-
<div></div>
117+
<p></p>
118118

119119
<h3>[property:Integer usedTimes]</h3>
120-
<div></div>
120+
<p></p>
121121

122122
<h3>[property:Object program]</h3>
123-
<div></div>
123+
<p></p>
124124

125125
<h3>[property:WebGLShader vertexShader]</h3>
126-
<div></div>
126+
<p></p>
127127

128128
<h3>[property:WebGLShader fragmentShader]</h3>
129-
<div></div>
129+
<p></p>
130130

131131
<h2>Methods</h2>
132132

133133
<h3>[method:Object getUniforms]()</h3>
134-
<div>
134+
<p>
135135
Returns a name-value mapping of all active uniform locations.
136-
</div>
136+
</p>
137137

138138
<h3>[method:Object getAttributes]()</h3>
139-
<div>
139+
<p>
140140
Returns a name-value mapping of all active vertex attribute locations.
141-
</div>
141+
</p>
142142

143143
<h2>Source</h2>
144144

‎docs/api/renderers/webgl/WebGLShader.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<body>
1111
<h1>[name]</h1>
1212

13-
<div class="desc">A lower level function to compile either a vertex or fragment shader.</div>
13+
<p class="desc">A lower level function to compile either a vertex or fragment shader.</p>
1414

1515
<h2>Example</h2>
1616

@@ -32,15 +32,15 @@ <h2>Function</h2>
3232

3333
<h3>[page:WebGLShader objects]([page:WebGLContext gl], [page:WebGLEnum type], [page:String source])</h3>
3434

35-
<div>
35+
<p>
3636
gl -- The current WebGL context
3737
type -- The WebGL type, either gl.VERTEX_SHADER or gl.FRAGMENT_SHADER
3838
source -- The source code for the shader
39-
</div>
40-
<div>
39+
</p>
40+
<p>
4141
This will compile an individual shader, but won't link it to be a complete [page:WebGLProgram]. Note: this
4242
is a function so the new operator should not be used.
43-
</div>
43+
</p>
4444

4545
<h2>Source</h2>
4646

‎docs/api/renderers/webgl/WebGLState.html‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,47 +10,47 @@
1010
<body>
1111
<h1>[name]</h1>
1212

13-
<div class="desc"></div>
13+
<p class="desc"></p>
1414

1515

1616
<h2>Methods</h2>
1717

1818
<h3>[method:null enable]( [param:integer id], [param:boolean boolean] )</h3>
19-
<div>
19+
<p>
2020
TODO
21-
</div>
21+
</p>
2222

2323
<h3>[method:null disable]( [param:integer id], [param:boolean boolean] )</h3>
24-
<div>
24+
<p>
2525
TODO
26-
</div>
26+
</p>
2727

2828
<h3>[method:null setDepthTest]( [param:boolean depthTest] )</h3>
29-
<div>
29+
<p>
3030
depthTest -- The boolean to decide if depth of a fragment needs to be tested against the depth buffer . <br />
31-
</div>
32-
<div>
31+
</p>
32+
<p>
3333
This sets, based on depthTest, whether or not the depth data needs to be tested against the depth buffer.
34-
</div>
34+
</p>
3535

3636
<h3>[method:null setDepthWrite]( [param:boolean depthWrite] )</h3>
37-
<div>
37+
<p>
3838
depthWrite -- The boolean to decide if depth of a fragment needs to be kept. <br />
39-
</div>
40-
<div>
39+
</p>
40+
<p>
4141
This sets, based on depthWrite, whether or not the depth data needs to be written in the depth buffer.
42-
</div>
42+
</p>
4343

4444
<h3>[method:null setBlending]( [param:number blending], [param:number blendEquation], [param:number blendSrc], [param:number blendDst] )</h3>
45-
<div>
45+
<p>
4646
blending -- A number indicating the blending mode. Possible value are THREE.NoBlending, THREE.NormalBlending, THREE.AdditiveBlending, THREE.SubtractiveBlending, THREE.MultiplyBlending or THREE.CustomBlending <br />
4747
blendEquation -- When blending is THREE.CustomBlending, then you can set the blendEquation. Possible values are THREE.AddEquation, THREE.SubtractEquation or THREE.ReverseSubtractEquation.<br />
4848
blendSrc -- When blending is THREE.CustomBlending, then you can set the blendSrc. Possible values are THREE.ZeroFactor, THREE.OneFactor,THREE.SrcColorFactor, THREE.OneMinusSrcColorFactor, THREE.SrcAlphaFactor, THREE.OneMinusSrcAlphaFactor, THREE.DstAlphaFactor, THREE.OneMinusDstAlphaFactor, THREE.DstColorFactor,THREE.OneMinusDstColorFactor or THREE.SrcAlphaSaturateFactor<br />
4949
blendDst -- When blending is THREE.CustomBlending, then you can set the blendDst. Possible values are THREE.ZeroFactor, THREE.OneFactor,THREE.SrcColorFactor, THREE.OneMinusSrcColorFactor, THREE.SrcAlphaFactor, THREE.OneMinusSrcAlphaFactor, THREE.DstAlphaFactor, THREE.OneMinusDstAlphaFactor, THREE.DstColorFactor,THREE.OneMinusDstColorFactor or THREE.SrcAlphaSaturateFactor
50-
</div>
51-
<div>
50+
</p>
51+
<p>
5252
This method sets the correct blending.
53-
</div>
53+
</p>
5454

5555

5656
<h2>Source</h2>

‎docs/api/renderers/webgl/plugins/SpritePlugin.html‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,27 +10,27 @@
1010
<body>
1111
<h1>[name]</h1>
1212

13-
<div class="desc">The Webglrenderer plugin class that allows Sprites to be rendered in the WebglRenderer. This plugin is automatically loaded in the Webglrenderer.</div>
13+
<p class="desc">The Webglrenderer plugin class that allows Sprites to be rendered in the WebglRenderer. This plugin is automatically loaded in the Webglrenderer.</p>
1414

1515

1616
<h2>Constructor</h2>
1717

1818
<h3>[name]()</h3>
19-
<div>
19+
<p>
2020
Creates a new [name].
21-
</div>
21+
</p>
2222

2323

2424
<h2>Methods</h2>
2525

2626
<h3>[method:null render]( [param:Scene scene], [param:Camera camera] )</h3>
27-
<div>
27+
<p>
2828
scene -- The scene to render. <br />
2929
camera -- The camera to render.
30-
</div>
31-
<div>
30+
</p>
31+
<p>
3232
Renders the sprites defined in the scene. This gets automatically called as post-render function to draw the lensflares.
33-
</div>
33+
</p>
3434

3535
<h2>Source</h2>
3636

‎docs/manual/buildTools/Testing-with-NPM.html‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@
1010
<body>
1111
<h1>[name]</h1>
1212

13-
<div class="desc">
13+
<p class="desc">
1414
This article shows how to get three.js into a [link:https://nodejs.org/en/ node.js] environment so that you
1515
can execute automated tests. Tests can be run on the command line, or by automated
1616
CI tools like [link:https://travis-ci.org/ Travis].
17-
</div>
17+
</p>
1818

1919
<h2>The short version</h2>
2020

21-
<div>
21+
<p>
2222
If you're comfortable with node and npm,
2323
<code>
2424
$ npm install three --save-dev
@@ -28,13 +28,13 @@ <h2>The short version</h2>
2828
var THREE = require('three');
2929
</code>
3030
to your test.
31-
</div>
31+
</p>
3232

3333
<h2>Create a testable project from scratch</h2>
34-
<div>
34+
<p>
3535
If you're not familiar with these tools, here's a quick guide (for linux, the installation process
3636
will be slightly different using windows, but the NPM commands are identical).
37-
</div>
37+
</p>
3838

3939
<h3>Basic setup</h3>
4040
<div>
@@ -200,8 +200,10 @@ <h2>Add your own code</h2>
200200
</li>
201201
</ol>
202202

203-
Items 2 and 3 will vary depending on how you manage your code. In the example of Physics.js
204-
given above, the export part is right at the end. We assign an object to module.exports:
203+
<p>
204+
Items 2 and 3 will vary depending on how you manage your code. In the example of Physics.js
205+
given above, the export part is right at the end. We assign an object to module.exports:
206+
</p>
205207
<code>
206208
//=============================================================================
207209
// make available in nodejs

‎docs/manual/introduction/Animation-system.html‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ <h1>[name]</h1>
1212

1313
<h2>Overview</h2>
1414

15-
<div class="desc">
15+
<p class="desc">
1616
Within the three.js animation system you can animate various properties of your models:
1717
the bones of a [page:SkinnedMesh skinned and rigged model],
1818
[page:Geometry.morphTargets morph targets], different material properties (colors,
@@ -28,11 +28,11 @@ <h2>Overview</h2>
2828
Unity/Unreal Engine 4. This page gives a short overview of the main components of the
2929
system and how they work together.
3030

31-
</div>
31+
</p>
3232

3333
<h3>Animation Clips</h3>
3434

35-
<div class="desc">
35+
<p class="desc">
3636

3737
If you have successfully imported an animated 3D object (it doesn't matter if it has
3838
bones or morph targets or both) - for example exporting it from Blender with the
@@ -45,11 +45,11 @@ <h3>Animation Clips</h3>
4545
mesh is a character, for example, there may be one AnimationClip for a walkcycle, a second
4646
for a jump, a third for sidestepping and so on.
4747

48-
</div>
48+
</p>
4949

5050
<h3>Keyframe Tracks</h3>
5151

52-
<div class="desc">
52+
<p class="desc">
5353

5454
Inside of such an *AnimationClip* the data for each animated property are stored in a
5555
separate [page:KeyframeTrack]. Assumed a character object has a [page:Skeleton skeleton],
@@ -63,22 +63,22 @@ <h3>Keyframe Tracks</h3>
6363
information as to how the [page:Mesh.morphTargetInfluences influence] of a certain morph
6464
target changes during the performance of the clip.
6565

66-
</div>
66+
</p>
6767

6868
<h3>Animation Mixer</h3>
6969

70-
<div class="desc">
70+
<p class="desc">
7171

7272
The stored data form only the basis for the animations - actual playback is controlled by
7373
the [page:AnimationMixer]. You can imagine this not only as a player for animations, but
7474
as a simulation of a hardware like a real mixer console, which can control several animations
7575
simultaneously, blending and merging them.
7676

77-
</div>
77+
</p>
7878

7979
<h3>Animation Actions</h3>
8080

81-
<div class="desc">
81+
<p class="desc">
8282

8383
The *AnimationMixer* itself has only very few (general) properties and methods, because it
8484
can be controlled by the [page:AnimationAction AnimationActions]. By configuring an
@@ -87,24 +87,24 @@ <h3>Animation Actions</h3>
8787
shall be performed with a fade or a time scaling, and some additional things, such crossfading
8888
or synchronizing.
8989

90-
</div>
90+
</p>
9191

9292
<h3>Animation Object Groups</h3>
9393

94-
<div class="desc">
94+
<p class="desc">
9595

9696
If you want a group of objects to receive a shared animation state, you can use an
9797
[page:AnimationObjectGroup].
9898

99-
</div>
99+
</p>
100100

101101
<h3>Supported Formats and Loaders</h3>
102102

103-
<div class="desc">
103+
<p class="desc">
104104
Note that not all model formats include animation (OBJ notably does not), and that only some
105105
three.js loaders support [page:AnimationClip AnimationClip] sequences. Several that <i>do</i>
106106
support this animation type:
107-
</div>
107+
</p>
108108

109109
<ul>
110110
<li>[page:JSONLoader THREE.JSONLoader]</li>
@@ -117,10 +117,10 @@ <h3>Supported Formats and Loaders</h3>
117117
<li>THREE.SEA3DLoader</li>
118118
</ul>
119119

120-
<div class="desc">
120+
<p class="desc">
121121
Note that 3ds max and Maya currently can't export multiple animations (meaning animations which are not
122122
on the same timeline) directly to a single file.
123-
</div>
123+
</p>
124124

125125
<h2>Example</h2>
126126

0 commit comments

Comments
 (0)