Browse Source

working on loaders docs, with new cross doc syntax

Vincent Lark 10 years ago
parent
commit
562b89f1ec

+ 9 - 9
docs/api/loaders/BabylonLoader.html

@@ -15,9 +15,9 @@
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
 
 
-		<h3>[name]([page:LoadingManager manager])</h3>
+		<h3>[name]( [page:LoadingManager manager] )</h3>
 		<div>
 		<div>
-		manager — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
+		[page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
 		</div>
 		</div>
 		<div>
 		<div>
 		Creates a new [name].
 		Creates a new [name].
@@ -30,21 +30,21 @@
 
 
 		<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 		<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 		<div>
 		<div>
-		url — required<br />
-		onLoad — Will be called when load completes. The argument will be the loaded [page:Object3D].<br />
-		onProgress — Will be called while load progresses. The argument will be the XmlHttpRequest instance, that contain .[page:Integer total] and .[page:Integer loaded] bytes.<br />
-		onError — Will be called when load errors.<br />
+		[page:String url] — required<br />
+		[page:function onLoad] — Will be called when load completes. The argument will be the loaded [page:Object3D].<br />
+		[page:function onProgress] — Will be called while load progresses. The argument will be the XmlHttpRequest instance, that contain .[page:Integer total] and .[page:Integer loaded] bytes.<br />
+		[page:function onError] — Will be called when load errors.<br />
 		</div>
 		</div>
 		<div>
 		<div>
 		Begin loading from url and call onLoad with the parsed response content.
 		Begin loading from url and call onLoad with the parsed response content.
 		</div>
 		</div>
 
 
-		<h3>[method:Object3D parse]([page:Object json])</h3>
+		<h3>[method:Object3D parse]( [page:Object json] )</h3>
 		<div>
 		<div>
-		text — The <em>JSON</em> structure to parse.
+		[page:Object json] — The <em>JSON</em> structure to parse.
 		</div>
 		</div>
 		<div>
 		<div>
-		Parse a <em>JSON</em> structure and returns an [page:Object3D object] or a [page:Scene scene].<br />
+		Parse a <em>JSON</em> structure and return an [page:Object3D object] or a [page:Scene scene].<br />
 		Found objects are converted to [page:Mesh] with a [page:BufferGeometry] and a default [page:MeshPhongMaterial].<br />
 		Found objects are converted to [page:Mesh] with a [page:BufferGeometry] and a default [page:MeshPhongMaterial].<br />
 		Lights are parsed accordingly.
 		Lights are parsed accordingly.
 		</div>
 		</div>

+ 10 - 10
docs/api/loaders/BufferGeometryLoader.html

@@ -14,9 +14,9 @@
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
 
 
-		<h3>[name]([page:LoadingManager manager])</h3>
+		<h3>[name]( [page:LoadingManager manager] )</h3>
 		<div>
 		<div>
-		manager -- The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
+		[page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
 		</div>
 		</div>
 		<div>
 		<div>
 		Creates a new [name].
 		Creates a new [name].
@@ -30,21 +30,21 @@
 
 
 		<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 		<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 		<div>
 		<div>
-		url — required<br />
-		onLoad — Will be called when load completes. The argument will be the loaded [page:BufferGeometry].<br />
-		onProgress — Will be called while load progresses. The argument will be the XmlHttpRequest instance, that contain .[page:Integer total] and .[page:Integer loaded] bytes.<br />
-		onError — Will be called when load errors.<br />
+		[page:String url] — required<br />
+		[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:BufferGeometry].<br />
+		[page:Function onProgress] — Will be called while load progresses. The argument will be the XmlHttpRequest instance, that contain .[page:Integer total] and .[page:Integer loaded] bytes.<br />
+		[page:Function onError] — Will be called when load errors.<br />
 		</div>
 		</div>
 		<div>
 		<div>
 		Begin loading from url and call onLoad with the parsed response content.
 		Begin loading from url and call onLoad with the parsed response content.
 		</div>
 		</div>
 
 
-		<h3>[method:BufferGeometry parse]([page:Object json])</h3>
+		<h3>[method:BufferGeometry parse]( [page:Object json] )</h3>
 		<div>
 		<div>
-		text — The <em>JSON</em> structure to parse.
+		[page:Object json] — The <em>JSON</em> structure to parse.
 		</div>
 		</div>
 		<div>
 		<div>
-		Parse a <em>JSON</em> structure and returns an [page:BufferGeometry].
+		Parse a <em>JSON</em> structure and return an [page:BufferGeometry].
 		</div>
 		</div>
 
 
 
 
@@ -52,7 +52,7 @@
 
 
 		<code>
 		<code>
 		// instantiate a loader
 		// instantiate a loader
-		var loader = new THREE.BabylonLoader();
+		var loader = new THREE.BufferGeometryLoader();
 
 
 		// load a resource
 		// load a resource
 		loader.load(
 		loader.load(

+ 4 - 4
docs/api/loaders/Cache.html

@@ -32,8 +32,8 @@
 
 
 		<h3>[method:null add]( [page:String key], value )</h3>
 		<h3>[method:null add]( [page:String key], value )</h3>
 		<div>
 		<div>
-		key — required. A string key <br />
-		value — <br />
+		[page:String key] — required. A string key <br />
+		[page:Object] value — <br />
 		</div>
 		</div>
 		<div>
 		<div>
 		Adds a cache entry with that key to hold the value. If this key already holds a value, it is overwritten.
 		Adds a cache entry with that key to hold the value. If this key already holds a value, it is overwritten.
@@ -41,7 +41,7 @@
 
 
 		<h3>[method:null get]( [page:String key] )</h3>
 		<h3>[method:null get]( [page:String key] )</h3>
 		<div>
 		<div>
-		key — required. A string key <br />
+		[page:String key] — required. A string key <br />
 		</div>
 		</div>
 		<div>
 		<div>
 		Get the value of key. If the key does not exist the null value is returned.
 		Get the value of key. If the key does not exist the null value is returned.
@@ -49,7 +49,7 @@
 
 
 		<h3>[method:null remove]( [page:String key] )</h3>
 		<h3>[method:null remove]( [page:String key] )</h3>
 		<div>
 		<div>
-		key — required. A string key <br />
+		[page:String key] — required. A string key <br />
 		</div>
 		</div>
 		<div>
 		<div>
 		Remove the cached value associated with the key.
 		Remove the cached value associated with the key.

+ 9 - 9
docs/api/loaders/ImageLoader.html

@@ -14,9 +14,9 @@
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
 
 
-		<h3>[name]([page:LoadingManager manager])</h3>
+		<h3>[name]( [page:LoadingManager manager] )</h3>
 		<div>
 		<div>
-		manager -- The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
+		[page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
 		</div>
 		</div>
 		<div>
 		<div>
 		Creates a new [name].
 		Creates a new [name].
@@ -24,7 +24,7 @@
 
 
 		<h2>Properties</h2>
 		<h2>Properties</h2>
 
 
-		<h3>[property:string crossOrigin]</h3>
+		<h3>[property:String crossOrigin]</h3>
 		<div>
 		<div>
 		The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
 		The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
 		</div>
 		</div>
@@ -33,18 +33,18 @@
 
 
 		<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 		<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 		<div>
 		<div>
-		onLoad -- Will be called when load completes. The argument will be the loaded Imageloader.<br />
-		onProgress -- Will be called while load progresses. The argument will be the progress event.<br />
-		onError -- Will be called when load errors.<br />
-		url — required
+		[page:String url] — required<br />
+		[page:Function onLoad] — Will be called when load completes. The argument will be the loaded Imageloader.<br />
+		[page:Function onProgress] — Will be called while load progresses. The argument will be the progress event.<br />
+		[page:Function onError] — Will be called when load errors.<br />
 		</div>
 		</div>
 		<div>
 		<div>
 		Begin loading from url and return the [page:Image image] object that will contain the data.
 		Begin loading from url and return the [page:Image image] object that will contain the data.
 		</div>
 		</div>
 
 
-		<h3>[method:null setCrossOrigin]([page:String value])</h3>
+		<h3>[method:null setCrossOrigin]( [page:String value] )</h3>
 		<div>
 		<div>
-		value -- The crossOrigin string.
+		[page:String value] — The crossOrigin string.
 		</div>
 		</div>
 		<div>
 		<div>
 		The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
 		The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.

+ 2 - 2
docs/api/loaders/JSONLoader.html

@@ -16,7 +16,7 @@
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
 
 
 
 
-		<h3>[name]([page:Boolean showStatus])</h3>
+		<h3>[name]( [page:Boolean showStatus] )</h3>
 		<div>
 		<div>
 		showStatus -- todo
 		showStatus -- todo
 		</div>
 		</div>
@@ -42,7 +42,7 @@
 		</div>
 		</div>
 
 
 
 
-		<h3>[method:Object3D parse]([page:todo json], [page:todo texturePath])</h3>
+		<h3>[method:Object3D parse]( [page:todo json], [page:todo texturePath] )</h3>
 		<div>
 		<div>
 		json -- todo <br />
 		json -- todo <br />
 		texturePath -- todo
 		texturePath -- todo

+ 21 - 21
docs/api/loaders/Loader.html

@@ -15,9 +15,9 @@
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
 
 
 
 
-		<h3>[name]([page:Boolean showStatus])</h3>
+		<h3>[name]( [page:Boolean showStatus] )</h3>
 		<div>
 		<div>
-		showStatus -- Show the status of loading div.
+		[page:Boolean showStatus] — Show the status of loading div.
 		</div>
 		</div>
 		<div>
 		<div>
 		Creates a new [name]. This should be called as base class.
 		Creates a new [name]. This should be called as base class.
@@ -28,10 +28,10 @@
 
 
 		<h3>[property:Boolean showStatus]</h3>
 		<h3>[property:Boolean showStatus]</h3>
 		<div>If true, show loading status in the statusDomElement.</div>
 		<div>If true, show loading status in the statusDomElement.</div>
-		
+
 		<h3>[property:DOMElement statusDomElement]</h3>
 		<h3>[property:DOMElement statusDomElement]</h3>
 		<div>This is the recipient of status messages.</div>
 		<div>This is the recipient of status messages.</div>
-		
+
 		<h3>[property:Function onLoadStart]</h3>
 		<h3>[property:Function onLoadStart]</h3>
 		<div>Will be called when load starts.</div>
 		<div>Will be called when load starts.</div>
 		<div>The default is a function with empty body.</div>
 		<div>The default is a function with empty body.</div>
@@ -39,63 +39,63 @@
 		<h3>[property:Function onLoadProgress]</h3>
 		<h3>[property:Function onLoadProgress]</h3>
 		<div>Will be called while load progresses.</div>
 		<div>Will be called while load progresses.</div>
 		<div>The default is a function with empty body.</div>
 		<div>The default is a function with empty body.</div>
-		
+
 		<h3>[property:Function onLoadComplete]</h3>
 		<h3>[property:Function onLoadComplete]</h3>
 		<div>Will be called when load completes.</div>
 		<div>Will be called when load completes.</div>
 		<div>The default is a function with empty body.</div>
 		<div>The default is a function with empty body.</div>
-		
+
 		<h3>[property:string crossOrigin]</h3>
 		<h3>[property:string crossOrigin]</h3>
 		<div>
 		<div>
 		The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
 		The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
-		</div> 
+		</div>
 
 
 		<h2>Methods</h2>
 		<h2>Methods</h2>
 
 
-		<h3>[method:Boolean needsTangents]([page:Array materials])</h3>
+		<h3>[method:Boolean needsTangents]( [page:Array materials] )</h3>
 		<div>
 		<div>
-		materials -- an array of [page:Material]
+		[page:Array materials] — an array of [page:Material]
 		</div>
 		</div>
 		<div>
 		<div>
 		Checks if the loaded object needs tangents based on its materials.
 		Checks if the loaded object needs tangents based on its materials.
 		</div>
 		</div>
 
 
-		<h3>[method:todo updateProgress]([page:object progress])</h3>
+		<h3>[method:todo updateProgress]( [page:object progress] )</h3>
 		<div>
 		<div>
-		progress -- an object containing loaded(contains the amount of bytes loaded) and optionally total (containing the total amount of bytes).
+		[page:Object progress] — an object containing loaded(contains the amount of bytes loaded) and optionally total (containing the total amount of bytes).
 		</div>
 		</div>
 		<div>
 		<div>
 		Updates the DOM object with the progress made.
 		Updates the DOM object with the progress made.
 		</div>
 		</div>
 
 
-		<h3>[method:Material createMaterial]([page:object m], [page:string texturePath])</h3>
+		<h3>[method:Material createMaterial]( [page:object m], [page:string texturePath] )</h3>
 		<div>
 		<div>
-		m -- The parameters to create the material. <br />
-		texturePath -- The base path of the textures.
+		[page:Object m] — The parameters to create the material. <br />
+		[page:String texturePath] — The base path of the textures.
 		</div>
 		</div>
 		<div>
 		<div>
 		Creates the Material based on the parameters m.
 		Creates the Material based on the parameters m.
 		</div>
 		</div>
 
 
-		<h3>[method:Array initMaterials]([page:Array materials], [page:string texturePath])</h3>
+		<h3>[method:Array initMaterials]( [page:Array materials], [page:string texturePath] )</h3>
 		<div>
 		<div>
-		materials -- an array of parameters to create materials. <br />
-		texturePath --  The base path of the textures.
+		[page:Array materials] — an array of parameters to create materials. <br />
+		[page:String texturePath] —  The base path of the textures.
 		</div>
 		</div>
 		<div>
 		<div>
 		Creates an array of [page:Material] based on the array of parameters m. The index of the parameters decide the correct index of the materials.
 		Creates an array of [page:Material] based on the array of parameters m. The index of the parameters decide the correct index of the materials.
 		</div>
 		</div>
 
 
-		<h3>[method:todo extractUrlBase]([page:string url])</h3>
+		<h3>[method:todo extractUrlBase]( [page:string url] )</h3>
 		<div>
 		<div>
-		url --  The url to extract the base url from.
+		[page:String url] —  The url to extract the base url from.
 		</div>
 		</div>
 		<div>
 		<div>
-		Extract the base from the URL. 
+		Extract the base from the URL.
 		</div>
 		</div>
 
 
 		<h3>[method:DOMElement addStatusElement]()</h3>
 		<h3>[method:DOMElement addStatusElement]()</h3>
 		<div>
 		<div>
-		Add a DOM element to indicate the progress and returns the DOMElement
+		Add a DOM element to indicate the progress and return the DOMElement
 		</div>
 		</div>
 
 
 
 

+ 9 - 9
docs/api/loaders/LoadingManager.html

@@ -29,11 +29,11 @@
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
 
 
-		<h3>[name]([page:function onLoad], [page:function onProgress], [page:function onError])</h3>
+		<h3>[name]( [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 		<div>
 		<div>
-		[page:function onLoad] -- The function that needs to be called when all loaders are done.<br />
-		[page:function onProgress] -- The function that needs to be called when an item is complete.<br />
-		[page:function onError] -- The function that needs to be called when an item is errors.
+		[page:Function onLoad] — The function that needs to be called when all loaders are done.<br />
+		[page:Function onProgress] — The function that needs to be called when an item is complete.<br />
+		[page:Function onError] — The function that needs to be called when an item is errors.
 		</div>
 		</div>
 		<div>
 		<div>
 		Creates a [name].
 		Creates a [name].
@@ -42,18 +42,18 @@
 
 
 		<h2>Properties</h2>
 		<h2>Properties</h2>
 
 
-		<h3>[property:function onLoad]</h3>
+		<h3>[property:Function onLoad]</h3>
 		<div>
 		<div>
 		The function that needs to be called when all loaders are done.
 		The function that needs to be called when all loaders are done.
 		</div>
 		</div>
 
 
-		<h3>[property:function onProgress]</h3>
+		<h3>[property:Function onProgress]</h3>
 		<div>
 		<div>
 		The function that needs to be called when an item is complete. The arguments are url(The url of the item just loaded),<br />
 		The function that needs to be called when an item is complete. The arguments are url(The url of the item just loaded),<br />
 		loaded(the amount of items already loaded), total( The total amount of items to be loaded.)
 		loaded(the amount of items already loaded), total( The total amount of items to be loaded.)
 		</div>
 		</div>
 
 
-		<h3>[property:function onError]</h3>
+		<h3>[property:Function onError]</h3>
 		<div>
 		<div>
 		The function that needs to be called when an item errors.
 		The function that needs to be called when an item errors.
 		</div>
 		</div>
@@ -63,7 +63,7 @@
 
 
 		<h3>[method:null itemStart]( [page:String url] )</h3>
 		<h3>[method:null itemStart]( [page:String url] )</h3>
 		<div>
 		<div>
-		url — the url to load
+		[page:String url] — the url to load
 		</div>
 		</div>
 		<div>
 		<div>
 		This should be called by any loader used by the manager when the loader starts loading an url. These shouldn't be called outside a loader.
 		This should be called by any loader used by the manager when the loader starts loading an url. These shouldn't be called outside a loader.
@@ -71,7 +71,7 @@
 
 
 		<h3>[method:null itemEnd]( [page:String url] )</h3>
 		<h3>[method:null itemEnd]( [page:String url] )</h3>
 		<div>
 		<div>
-		url — the url to load
+		[page:String url] — the loaded url
 		</div>
 		</div>
 		<div>
 		<div>
 		This should be called by any loader used by the manager when the loader ended loading an url.  These shouldn't be called outside a loader.
 		This should be called by any loader used by the manager when the loader ended loading an url.  These shouldn't be called outside a loader.

+ 12 - 12
docs/api/loaders/MTLLoader.html

@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!D]OCTYPE html>
 <html lang="en">
 <html lang="en">
 	<head>
 	<head>
 		<meta charset="utf-8" />
 		<meta charset="utf-8" />
@@ -15,11 +15,11 @@
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
 
 
-		<h3>[name]([page:String baseUrl], [page:Object options], [page:String crossOrigin])</h3>
+		<h3>[name]( [page:String baseUrl], [page:Object options], [page:String crossOrigin] )</h3>
 		<div>
 		<div>
-		baseUrl — The base url from which to find subsequent resources.<br />
-		options — Options passed to the created material (side, wrap, normalizeRGB, ignoreZeroRGBs, invertTransparency).<br />
-		crossOrigin — The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.<br />
+		[page:String baseUrl] — The base url from which to find subsequent resources.<br />
+		[page:Object options] — Options passed to the created material (side, wrap, normalizeRGB, ignoreZeroRGBs, invertTransparency).<br />
+		[page:String crossOrigin] — The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.<br />
 		</div>
 		</div>
 		<div>
 		<div>
 		Creates a new [name].
 		Creates a new [name].
@@ -32,21 +32,21 @@
 
 
 		<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 		<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 		<div>
 		<div>
-		url — required<br />
-		onLoad — Will be called when load completes. The argument will be the loaded [page:MTLLoaderMaterialCreator MTLLoader.MaterialCreator] instance.<br />
-		onProgress — Will be called while load progresses. The argument will be the XmlHttpRequest instance, that contain .[page:Integer total] and .[page:Integer loaded] bytes.<br />
-		onError — Will be called when load errors.<br />
+		[page:String url] — required<br />
+		[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:MTLLoaderMaterialCreator MTLLoader.MaterialCreator] instance.<br />
+		[page:Function onProgress] — Will be called while load progresses. The argument will be the XmlHttpRequest instance, that contain .[page:Integer total] and .[page:Integer loaded] bytes.<br />
+		[page:Function onError] — Will be called when load errors.<br />
 		</div>
 		</div>
 		<div>
 		<div>
 		Begin loading from url and return the loaded material.
 		Begin loading from url and return the loaded material.
 		</div>
 		</div>
 
 
-		<h3>[method:MTLLoaderMaterialCreator parse]([page:String text])</h3>
+		<h3>[method:MTLLoaderMaterialCreator parse]( [page:String text] )</h3>
 		<div>
 		<div>
-		text — The textual <em>mtl</em> structure to parse.
+		[page:String text] — The textual <em>mtl</em> structure to parse.
 		</div>
 		</div>
 		<div>
 		<div>
-		Parse a <em>mtl</em> text structure and returns a [page:MTLLoaderMaterialCreator] instance.<br />
+		Parse a <em>mtl</em> text structure and return a [page:MTLLoaderMaterialCreator] instance.<br />
 		</div>
 		</div>
 
 
 		<h2>Source</h2>
 		<h2>Source</h2>

+ 15 - 15
docs/api/loaders/MaterialLoader.html

@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!DOCT]YPE html>
 <html lang="en">
 <html lang="en">
 	<head>
 	<head>
 		<meta charset="utf-8" />
 		<meta charset="utf-8" />
@@ -14,9 +14,9 @@
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
 
 
-		<h3>[name]([page:LoadingManager manager])</h3>
+		<h3>[name]( [page:LoadingManager manager] )</h3>
 		<div>
 		<div>
-		manager -- The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
+		[page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
 		</div>
 		</div>
 		<div>
 		<div>
 		Creates a new [name].
 		Creates a new [name].
@@ -27,29 +27,29 @@
 
 
 		<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 		<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 		<div>
 		<div>
-		onLoad -- Will be called when load completes. The argument will be the loaded [page:Material].<br />
-		onProgress -- Will be called while load progresses. The argument will be the progress event.<br />
-		onError -- Will be called when load errors.<br />
-		url — required
+		[page:String url] — required<br />
+		[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:Material].<br />
+		[page:Function onProgress] — Will be called while load progresses. The argument will be the progress event.<br />
+		[page:Function onError] — Will be called when load errors.<br />
 		</div>
 		</div>
 		<div>
 		<div>
 		Begin loading from url and return the [page:Material] object that will contain the data.
 		Begin loading from url and return the [page:Material] object that will contain the data.
 		</div>
 		</div>
 
 
-		<h3>[method:null setCrossOrigin]([page:String value])</h3>
+		<h3>[method:null setCrossOrigin]( [page:String value] )</h3>
 		<div>
 		<div>
-		value -- The crossOrigin string.
+		[page:String value] — The crossOrigin string.
 		</div>
 		</div>
 		<div>
 		<div>
 		The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
 		The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
 		</div>
 		</div>
 
 
-		<h3>[method:Material parse]([page:Object json])</h3>
+		<h3>[method:Material parse]( [page:Object json] )</h3>
 		<div>
 		<div>
-		json -- The json object containing the parameters of the Material.
+		[page:Object json] — The json object containing the parameters of the Material.
 		</div>
 		</div>
 		<div>
 		<div>
-		Creates a new [page:Material] of the type [page:String json.type] with parameters defined in the json object.
+		Parse a <em>JSON</em> structure and create a new [page:Material] of the type [page:String json.type] with parameters defined in the json object.
 		</div>
 		</div>
 
 
 
 
@@ -63,10 +63,10 @@
 		// load a resource
 		// load a resource
 		loader.load(
 		loader.load(
 			// resource URL
 			// resource URL
-			'models/babylon/skull.babylon',
+			'path/to/material.json',
 			// Function when resource is loaded
 			// Function when resource is loaded
-			function ( object ) {
-				scene.add( object );
+			function ( material ) {
+				object.material = material;
 			},
 			},
 			// Function called when download progresses
 			// Function called when download progresses
 			function ( xhr ) {
 			function ( xhr ) {

+ 11 - 11
docs/api/loaders/OBJLoader.html

@@ -15,9 +15,9 @@
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
 
 
-		<h3>[name]([page:LoadingManager manager])</h3>
+		<h3>[name]( [page:LoadingManager manager] )</h3>
 		<div>
 		<div>
-		manager — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
+		[page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
 		</div>
 		</div>
 		<div>
 		<div>
 		Creates a new [name].
 		Creates a new [name].
@@ -28,29 +28,29 @@
 
 
 		<h2>Methods</h2>
 		<h2>Methods</h2>
 
 
-		<h3>.load( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
+		<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 		<div>
 		<div>
-		url — required<br />
-		onLoad — Will be called when load completes. The argument will be the loaded [page:Object3D].<br />
-		onProgress — Will be called while load progresses. The argument will be the XmlHttpRequest instance, that contain .[page:Integer total] and .[page:Integer loaded] bytes.<br />
-		onError — Will be called when load errors.<br />
+		[page:String url] — required<br />
+		[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:Object3D].<br />
+		[page:Function onProgress] — Will be called while load progresses. The argument will be the XmlHttpRequest instance, that contain .[page:Integer total] and .[page:Integer loaded] bytes.<br />
+		[page:Function onError] — Will be called when load errors.<br />
 		</div>
 		</div>
 		<div>
 		<div>
 		Begin loading from url and call onLoad with the parsed response content.
 		Begin loading from url and call onLoad with the parsed response content.
 		</div>
 		</div>
 
 
-		<h3>.parse([page:String text])</h3>
+		<h3>[method:Object3D parse]( [page:String text] )</h3>
 		<div>
 		<div>
-		text — The textual <em>obj</em> structure to parse.
+		[page:String text] — The textual <em>obj</em> structure to parse.
 		</div>
 		</div>
 		<div>
 		<div>
-		Parse an <em>obj</em> text structure and returns a [page:Object3D].<br />
+		Parse an <em>obj</em> text structure and return an [page:Object3D].<br />
 		Found objects are converted to [page:Mesh] with a [page:BufferGeometry] and a default [page:MeshLambertMaterial].
 		Found objects are converted to [page:Mesh] with a [page:BufferGeometry] and a default [page:MeshLambertMaterial].
 		</div>
 		</div>
 
 
 		<h2>Example</h2>
 		<h2>Example</h2>
 
 
-		<a target="_parent" href="http://threejs.org/examples/#webgl_loader_obj">webgl_loader_obj</a>
+		[example:webgl_loader_obj]
 
 
 
 
 		<h2>Source</h2>
 		<h2>Source</h2>

+ 12 - 12
docs/api/loaders/ObjectLoader.html

@@ -9,14 +9,14 @@
 	<body>
 	<body>
 		<h1>[name]</h1>
 		<h1>[name]</h1>
 
 
-		<div class="desc">A loader for loading a JSON resource. Unlike the [page:JSONLoader JSONLoader], this one make use of the <em>.type</em> attributes of objects to map them to their original classes.</div>
+		<div class="desc">A loader for loading a JSON resource. Unlike the [page:JSONLoader], this one make use of the <em>.type</em> attributes of objects to map them to their original classes.</div>
 
 
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
 
 
-		<h3>[name]([page:LoadingManager manager])</h3>
+		<h3>[name]( [page:LoadingManager manager] )</h3>
 		<div>
 		<div>
-		manager — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
+		[page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
 		</div>
 		</div>
 		<div>
 		<div>
 		Creates a new [name].
 		Creates a new [name].
@@ -30,27 +30,27 @@
 
 
 		<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 		<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 		<div>
 		<div>
-		url — required<br />
-		onLoad — Will be called when load completes. The argument will be the loaded [page:Object3D object].<br />
-		onProgress — Will be called while load progresses. The argument will be the XmlHttpRequest instance, that contain .[page:Integer total] and .[page:Integer loaded] bytes.<br />
-		onError — Will be called when load errors.<br />
+		[page:String url] — required<br />
+		[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:Object3D object].<br />
+		[page:Function onProgress] — Will be called while load progresses. The argument will be the XmlHttpRequest instance, that contain .[page:int total] and .[page:int loaded] bytes.<br />
+		[page:Function onError] — Will be called when load errors.<br />
 		</div>
 		</div>
 		<div>
 		<div>
 		Begin loading from url and call onLoad with the parsed response content.
 		Begin loading from url and call onLoad with the parsed response content.
 		</div>
 		</div>
 
 
 
 
-		<h3>[method:Object3D parse]( [page:String json] )</h3>
+		<h3>[method:Object3D parse]( [page:Object json] )</h3>
 		<div>
 		<div>
-		json — required. The JSON source to parse<br />
+		[page:Object json] — required. The JSON source to parse<br />
 		</div>
 		</div>
 		<div>
 		<div>
-		Parses a JSON content and return a threejs object.
+		Parse a <em>JSON</em> content and return a threejs object.
 		</div>
 		</div>
 
 
-		<h3>[method:null setCrossOrigin]([page:String value]</h3>
+		<h3>[method:null setCrossOrigin]( [page:String value] )</h3>
 		<div>
 		<div>
-		value — The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
+		[page:String value] — The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
 		</div>
 		</div>
 
 
 
 

+ 7 - 7
docs/api/loaders/TextureLoader.html

@@ -14,9 +14,9 @@
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
 
 
-		<h3>[name]([page:LoadingManager manager])</h3>
+		<h3>[name]( [page:LoadingManager manager] )</h3>
 		<div>
 		<div>
-		manager — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
+		[page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
 		</div>
 		</div>
 		<div>
 		<div>
 		Creates a new [name].
 		Creates a new [name].
@@ -36,10 +36,10 @@
 
 
 		<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 		<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 		<div>
 		<div>
-		url — required<br />
-		onLoad — Will be called when load completes. The argument will be the loaded text response.<br />
-		onProgress — Will be called while load progresses. The argument will be the XmlHttpRequest instance, that contain .[page:Integer total] and .[page:Integer loaded] bytes.<br />
-		onError — Will be called when load errors.<br />
+		[page:String url] — required<br />
+		[page:Function onLoad] — Will be called when load completes. The argument will be the loaded text response.<br />
+		[page:Function onProgress] — Will be called while load progresses. The argument will be the XmlHttpRequest instance, that contain .[page:Integer total] and .[page:Integer loaded] bytes.<br />
+		[page:Function onError] — Will be called when load errors.<br />
 		</div>
 		</div>
 		<div>
 		<div>
 		Begin loading from url and pass the loaded [page:Texture texture] to onLoad.
 		Begin loading from url and pass the loaded [page:Texture texture] to onLoad.
@@ -56,7 +56,7 @@
 		// load a resource
 		// load a resource
 		loader.load(
 		loader.load(
 			// resource URL
 			// resource URL
-			'textures/land_ocean_ice_cloud_2048.jpg,
+			'textures/land_ocean_ice_cloud_2048.jpg',
 			// Function when resource is loaded
 			// Function when resource is loaded
 			function ( texture ) {
 			function ( texture ) {
 				// do something with the texture
 				// do something with the texture

+ 16 - 16
docs/api/loaders/XHRLoader.html

@@ -10,14 +10,14 @@
 
 
 		<h1>[name]</h1>
 		<h1>[name]</h1>
 
 
-		<div class="desc">A low level class for loading resources with XmlHttpRequest.</div>
+		<div class="desc">A low level class for loading resources with XmlHttpRequest, used internaly by most loaders.</div>
 
 
 
 
 		<h2>Constructor</h2>
 		<h2>Constructor</h2>
 
 
-		<h3>[name]([page:LoadingManager manager])</h3>
+		<h3>[name]( [page:LoadingManager manager] )</h3>
 		<div>
 		<div>
-		manager — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
+		[page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
 		</div>
 		</div>
 		<div>
 		<div>
 		Creates a new [name].
 		Creates a new [name].
@@ -26,17 +26,17 @@
 
 
 		<h2>Properties</h2>
 		<h2>Properties</h2>
 
 
-		<h3>.[page:Cache cache]</h3>
+		<h3>[property:Cache cache]</h3>
 		<div>
 		<div>
 		A [page:Cache cache] instance that hold the response from each request made through this loader, so each file is requested once.
 		A [page:Cache cache] instance that hold the response from each request made through this loader, so each file is requested once.
 		</div>
 		</div>
 
 
-		<h3>.[page:string crossOrigin]</h3>
+		<h3>[property:String crossOrigin]</h3>
 		<div>
 		<div>
 		The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
 		The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
 		</div>
 		</div>
 
 
-		<h3>.[page:string responseType]</h3>
+		<h3>[property:String responseType]</h3>
 		<div>
 		<div>
 		Can be set to change the response type.
 		Can be set to change the response type.
 		</div>
 		</div>
@@ -44,31 +44,31 @@
 
 
 		<h2>Methods</h2>
 		<h2>Methods</h2>
 
 
-		<h3>.load( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
+		<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 		<div>
 		<div>
-		url — required<br />
-		onLoad — Will be called when load completes. The argument will be the loaded text response.<br />
-		onProgress — Will be called while load progresses. The argument will be the XmlHttpRequest instance, that contain .[page:Integer total] and .[page:Integer loaded] bytes.<br />
-		onError — Will be called when load errors.<br />
+		[page:String url] — required<br />
+		[page:Function onLoad] — Will be called when load completes. The argument will be the loaded text response.<br />
+		[page:Function onProgress] — Will be called while load progresses. The argument will be the XmlHttpRequest instance, that contain .[page:Integer total] and .[page:Integer loaded] bytes.<br />
+		[page:Function onError] — Will be called when load errors.<br />
 		</div>
 		</div>
 		<div>
 		<div>
 		Begin loading from url and return the [page:String text] response that will contain the data.
 		Begin loading from url and return the [page:String text] response that will contain the data.
 		</div>
 		</div>
 
 
-		<h3>.setCrossOrigin([page:String value]</h3>
+		<h3>[method:null setCrossOrigin]( [page:String value] )</h3>
 		<div>
 		<div>
-		value — The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
+		[page:String value] — The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
 		</div>
 		</div>
 
 
-		<h3>.setResponseType([page:String value]</h3>
+		<h3>[method:null setResponseType]( [page:String value] )</h3>
 		<div>
 		<div>
-		value — the empty string (default), "arraybuffer", "blob", "document", "json", or "text".
+		[page:String value] — the empty string (default), "arraybuffer", "blob", "document", "json", or "text".
 		</div>
 		</div>
 
 
 
 
 		<h2>Example</h2>
 		<h2>Example</h2>
 
 
-		<a target="_parent" href="http://threejs.org/examples/#webgl_morphtargets_human">webgl_morphtargets_human</a>
+		[example:webgl_morphtargets_human]
 
 
 
 
 		<h2>Source</h2>
 		<h2>Source</h2>