Browse Source

Merge pull request #20989 from Mugen87/dev2

Docs: Clean up ObjectLoader page.
Mr.doob 4 years ago
parent
commit
4ccb9d2237
2 changed files with 14 additions and 124 deletions
  1. 7 64
      docs/api/en/loaders/ObjectLoader.html
  2. 7 60
      docs/api/zh/loaders/ObjectLoader.html

+ 7 - 64
docs/api/en/loaders/ObjectLoader.html

@@ -91,43 +91,42 @@
 		[page:Function onLoad] — Will be called when parsed completes. The argument will be the parsed [page:Object3D object].<br /><br />
 
 		Parse a <em>JSON</em> structure and return a threejs object.
-		This is used internally by [page:.load], but can also be used directly to parse
-		a previously loaded JSON structure.
+		This is used internally by [page:.load]() but can also be used directly to parse a previously loaded JSON structure.
 		</p>
 
 		<h3>[method:Object3D parseGeometries]( [param:Object json] )</h3>
 		<p>
 		[page:Object json] — required. The JSON source to parse.<br /><br />
 
-		This is used [page:.parse] to parse any [page:Geometry geometries] or [page:BufferGeometry buffer geometries]  in the JSON structure.
+		This is used by [page:.parse]() to parse any [page:Geometry geometries] or [page:BufferGeometry buffer geometries]  in the JSON structure.
 		</p>
 
 		<h3>[method:Object3D parseMaterials]( [param:Object json] )</h3>
 		<p>
 		[page:Object json] — required. The JSON source to parse.<br /><br />
 
-		This is used [page:.parse] to parse any materials in the JSON structure using [page:MaterialLoader].
+		This is used by [page:.parse]() to parse any materials in the JSON structure using [page:MaterialLoader].
 		</p>
 
 		<h3>[method:Object3D parseAnimations]( [param:Object json] )</h3>
 		<p>
 		[page:Object json] — required. The JSON source to parse.<br /><br />
 
-		This is used [page:.parse] to parse any animations in the JSON structure, using [page:AnimationClip.parse].
+		This is used by [page:.parse]() to parse any animations in the JSON structure, using [page:AnimationClip.parse]().
 		</p>
 
 		<h3>[method:Object3D parseImages]( [param:Object json] )</h3>
 		<p>
 		[page:Object json] — required. The JSON source to parse.<br /><br />
 
-		This is used [page:.parse] to parse any images in the JSON structure, using [page:ImageLoader].
+		This is used by [page:.parse]() to parse any images in the JSON structure, using [page:ImageLoader].
 		</p>
 
 		<h3>[method:Object3D parseTextures]( [param:Object json] )</h3>
 		<p>
 		[page:Object json] — required. The JSON source to parse.<br /><br />
 
-		This is used [page:.parse] to parse any textures in the JSON structure.
+		This is used by [page:.parse]() to parse any textures in the JSON structure.
 		</p>
 
 		<h3>[method:Object3D parseObject]( [param:Object json], [param:BufferGeometry geometries], [param:Material materials], [param:AnimationClip animations] )</h3>
@@ -137,63 +136,7 @@
 		[page:Material materials] — required. The materials of the JSON.<br />
 		[page:AnimationClip animations] — required. The animations of the JSON.<br /><br />
 
-		This is used [page:.parse] to parse any objects in the JSON structure.
-		Objects can be of the following types:
-
-		<ul>
-			<li>
-				[page:Scene]
-			</li>
-			<li>
-				[page:PerspectiveCamera]
-			</li>
-			<li>
-				[page:OrthographicCamera]
-			</li>
-			<li>
-				[page:AmbientLight]
-			</li>
-			<li>
-				[page:DirectionalLight]
-			</li>
-			<li>
-				[page:PointLight]
-			</li>
-			<li>
-				[page:SpotLight]
-			</li>
-			<li>
-				[page:HemisphereLight]
-			</li>
-			<li>
-				[page:LightProbe]
-			</li>
-			<li>
-				[page:Mesh]
-			</li>
-			<li>
-				[page:LOD]
-			</li>
-			<li>
-				[page:Line]
-			</li>
-			<li>
-				[page:LineSegments]
-			</li>
-			<li>
-				[page:Points]
-			</li>
-			<li>
-				[page:Sprite]
-			</li>
-			<li>
-				[page:Group]
-			</li>
-			<li>
-				[page:Object3D]
-			</li>
-
-		</ul>
+		This is used by [page:.parse]() to parse any 3D objects in the JSON structure.
 		</p>
 
 		<h2>Source</h2>

+ 7 - 60
docs/api/zh/loaders/ObjectLoader.html

@@ -91,41 +91,41 @@
 		[page:Function onLoad] — 当解析完成时被调用,其中参数被解析为[page:Object3D object].<br /><br />
 
 			解析一个<em>JSON</em>结构,并返回一个threejs对象.
-		内部使用[page:.load]进行加载, 但也可以直接用于解析先前加载的JSON结构。
+		内部使用[page:.load]()进行加载, 但也可以直接用于解析先前加载的JSON结构。
 		</p>
 
 		<h3>[method:Object3D parseGeometries]( [param:Object json] )</h3>
 		<p>
 		[page:Object json] — 必选参数,需要被解析的JSON源。<br /><br />
 
-			此函数以JSON结构,用[page:.parse]去解析[page:Geometry geometries]或[page:BufferGeometry buffer geometries]。
+			此函数以JSON结构,用[page:.parse]()去解析[page:Geometry geometries]或[page:BufferGeometry buffer geometries]。
 		</p>
 
 		<h3>[method:Object3D parseMaterials]( [param:Object json] )</h3>
 		<p>
 		[page:Object json] —  必选参数,需要被解析的JSON源。<br /><br />
 
-		此函数通过[page:.parse]来使用[page:MaterialLoader],以解析JSON结构中任意材质。
+		此函数通过[page:.parse()来使用[page:MaterialLoader],以解析JSON结构中任意材质。
 		</p>
 
 		<h3>[method:Object3D parseAnimations]( [param:Object json] )</h3>
 		<p>
 		[page:Object json] —  必选参数,需要被解析的JSON源。<br /><br />
 
-		此函数通过[page:.parse]来使用[page:AnimationClip.parse], 以解析JSON结构中任意动画。
+		此函数通过[page:.parse]()来使用[page:AnimationClip.parse](), 以解析JSON结构中任意动画。
 		</p>
 
 		<h3>[method:Object3D parseImages]( [param:Object json] )</h3>
 		<p>
 		[page:Object json] —  必选参数,需要被解析的JSON源。<br /><br />
 
-			此函数通过[page:.parse]来使用[page:ImageLoader], 以解析JSON结构中任意图片。
+			此函数通过[page:.parse]()来使用[page:ImageLoader], 以解析JSON结构中任意图片。
 		</p>
 
 		<h3>[method:Object3D parseTextures]( [param:Object json] )</h3>
 		<p>
 		[page:Object json] —  必选参数,需要被解析的JSON源。<br /><br />
-			此函数通过[page:.parse]来解析JSON结构中任意纹理。
+			此函数通过[page:.parse]()来解析JSON结构中任意纹理。
 		</p>
 
 		<h3>[method:Object3D parseObject]( [param:Object json], [param:BufferGeometry geometries], [param:Material materials], [param:AnimationClip animations] )</h3>
@@ -135,60 +135,7 @@
 		[page:Material materials] — required. The materials of the JSON.<br />
 		[page:AnimationClip animations] — required. The animations of the JSON.<br /><br />
 
-			此函数通过[page:.parse]来解析JSON结构中任意对象。
-		对象可以为如下类型:
-
-		<ul>
-			<li>
-				[page:Scene]
-			</li>
-			<li>
-				[page:PerspectiveCamera]
-			</li>
-			<li>
-				[page:OrthographicCamera]
-			</li>
-			<li>
-				[page:AmbientLight]
-			</li>
-			<li>
-				[page:DirectionalLight]
-			</li>
-			<li>
-				[page:PointLight]
-			</li>
-			<li>
-				[page:SpotLight]
-			</li>
-			<li>
-				[page:HemisphereLight]
-			</li>
-			<li>
-				[page:Mesh]
-			</li>
-			<li>
-				[page:LOD]
-			</li>
-			<li>
-				[page:Line]
-			</li>
-			<li>
-				[page:LineSegments]
-			</li>
-			<li>
-				[page:Points]
-			</li>
-			<li>
-				[page:Sprite]
-			</li>
-			<li>
-				[page:Group]
-			</li>
-			<li>
-				[page:Object3D]
-			</li>
-
-		</ul>
+		此函数通过[page:.parse]()来解析JSON结构中任意对象。
 		</p>
 
 		<h2>源</h2>