Browse Source

Documentation: More advanced templating system.

Mr.doob 13 years ago
parent
commit
df251088e3
3 changed files with 13 additions and 12 deletions
  1. 4 4
      docs/api/cameras/Camera.html
  2. 7 7
      docs/api/cameras/PerspectiveCamera.html
  3. 2 1
      docs/index.html

+ 4 - 4
docs/api/cameras/Camera.html

@@ -10,16 +10,16 @@
 
 
 <h2>Properties</h2>
 <h2>Properties</h2>
 
 
-<h3>.matrixWorldInverse [page:Matrix4]</h3>
+<h3>.[page:Matrix4 matrixWorldInverse]</h3>
 
 
-<h3>.projectionMatrix [page:Matrix4]</h3>
+<h3>.[page:Matrix4 projectionMatrix]</h3>
 
 
-<h3>.projectionMatrixInverse [page:Matrix4]</h3>
+<h3>.[page:Matrix4 projectionMatrixInverse]</h3>
 
 
 
 
 <h2>Methods</h2>
 <h2>Methods</h2>
 
 
-<h3>.lookAt( vector [page:Vector3] )</h3>
+<h3>.lookAt( [page:Vector3 vector] )</h3>
 <div>
 <div>
 vector — point to look at<br />
 vector — point to look at<br />
 </div>
 </div>

+ 7 - 7
docs/api/cameras/PerspectiveCamera.html

@@ -12,7 +12,7 @@ scene.add( camera );
 
 
 <h2>Constructor</h2>
 <h2>Constructor</h2>
 
 
-<h3>[name]( fov [page:Number], aspect [page:Number], near [page:Number], far [page:Number] )</h3>
+<h3>[name]( [page:Number fov], [page:Number aspect], [page:Number near], [page:Number far] )</h3>
 <div>
 <div>
 fov — camera frustum vertical field of view.<br />
 fov — camera frustum vertical field of view.<br />
 aspect — camera frustum aspect ratio.<br />
 aspect — camera frustum aspect ratio.<br />
@@ -23,22 +23,22 @@ far — camera frustum far plane.
 
 
 <h2>Properties</h2>
 <h2>Properties</h2>
 
 
-<h3>.fov [page:Number]</h3>
+<h3>.[page:Number fov]</h3>
 <div>Camera frustum vertical field of view.</div>
 <div>Camera frustum vertical field of view.</div>
 
 
-<h3>.aspect [page:Number]</h3>
+<h3>.[page:Number aspect]</h3>
 <div>Camera frustum aspect ratio.</div>
 <div>Camera frustum aspect ratio.</div>
 
 
-<h3>.near [page:Number]</h3>
+<h3>.[page:Number near]</h3>
 <div>Camera frustum near plane.</div>
 <div>Camera frustum near plane.</div>
 
 
-<h3>.far [page:Number]</h3>
+<h3>.[page:Number far]</h3>
 <div>Camera frustum far plane.</div>
 <div>Camera frustum far plane.</div>
 
 
 
 
 <h2>Methods</h2>
 <h2>Methods</h2>
 
 
-<h3>.setLens( focalLength [page:Number], frameSize [page:Number] )</h3>
+<h3>.setLens( [page:Number focalLength], [page:Number frameSize] )</h3>
 <div>
 <div>
 focalLength — focal length<br />
 focalLength — focal length<br />
 frameSize — frame size
 frameSize — frame size
@@ -49,7 +49,7 @@ Uses focal length (in mm) to estimate and set FOV 35mm (fullframe) camera is use
 Formula based on <a href="http://www.bobatkins.com/photography/technical/field_of_view.html" target="_blank">http://www.bobatkins.com/photography/technical/field_of_view.html</a>
 Formula based on <a href="http://www.bobatkins.com/photography/technical/field_of_view.html" target="_blank">http://www.bobatkins.com/photography/technical/field_of_view.html</a>
 </div>
 </div>
 
 
-<h3>.setViewOffset( fullWidth [page:Number], fullHeight [page:Number], x [page:Number], y [page:Number], width [page:Number], height [page:Number] )</h3>
+<h3>.setViewOffset( [page:Number fullWidth], [page:Number fullHeight], [page:Number x], [page:Number y], [page:Number width], [page:Number height] )</h3>
 <div>
 <div>
 fullWidth — full width of multiview setup<br />
 fullWidth — full width of multiview setup<br />
 fullHeight — full height of multiview setup<br />
 fullHeight — full height of multiview setup<br />

+ 2 - 1
docs/index.html

@@ -335,7 +335,8 @@
 						
 						
 						text = text.replace(/\[name\]/gi, name);
 						text = text.replace(/\[name\]/gi, name);
 						text = text.replace(/\[path\]/gi, path);
 						text = text.replace(/\[path\]/gi, path);
-						text = text.replace(/\[page:(\w+)\]/gi, "<a href=\"javascript:goTo('$1')\">$1</a>" );
+						text = text.replace(/\[page:(\w+)\]/gi, "<a href=\"javascript:goTo('$1')\" title=\"$1\">$1</a>" );
+						text = text.replace(/\[page:(\w+) (\w+)\]/gi, "<a href=\"javascript:goTo('$1')\" title=\"$1\">$2</a>" );
 
 
 						viewer.innerHTML = text + '<br>';
 						viewer.innerHTML = text + '<br>';