Document GeometryLoader

mlgmlg103 · Aug 6, 2012 · 619a27e · 619a27e
1 parent 210072c
commit 619a27e
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/docs/api/loaders/GeometryLoader.html b/docs/api/loaders/GeometryLoader.html
@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+<html lang="en">
+	<head>
+		<meta charset="utf-8">
+		<script src="../../list.js"></script>
+		<script src="../../page.js"></script>
+		<link type="text/css" rel="stylesheet" href="../../page.css" />
+	</head>
+	<body>
+		<h1>[name]</h1>
+
+		<div class="desc">A loader for loading a geometry out of a JSON file.</div>
+		<div class="desc">Unlike other loaders, this one emits events instead of using predefined callbacks. So if you're interested in getting notified when <em>things</em> happen, you need to add listeners to the object.</div>
+		<div class="desc">Possible events:<br />
+			<ul>
+				<li>type: error, message: error message</li>
+				<li>type: load, content: loaded geometry</li>
+			</ul>
+		</div>
+
+		<h2>Constructor</h2>
+
+		<h3>[name]()</h3>
+
+		<h2>Methods</h2>
+
+		<h3>.load( [page:String url] )</h3>
+		<div>
+		url — required
+		</div>
+
+		<div class="desc">Begin loading from <em>url</em></div>
+
+
+		<h2>Source</h2>
+
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
+	</body>
+</html>
diff --git a/docs/list.js b/docs/list.js
@@ -40,6 +40,7 @@ var list = {
 	"Loaders": [
 		[ "Loader", "loaders/Loader" ],
 		[ "BinaryLoader", "loaders/BinaryLoader" ],
+		[ "GeometryLoader", "loaders/GeometryLoader" ],
 		[ "JSONLoader", "loaders/JSONLoader" ],
 		[ "SceneLoader", "loaders/SceneLoader" ],
 	],