Browse Source

Merge pull request #6623 from paulmasson/dev

Improvements to documentation
Ricardo Cabello 10 years ago
parent
commit
76a3c18d26
3 changed files with 4 additions and 4 deletions
  1. 2 2
      docs/api/CONTRIBUTING.md
  2. 1 1
      docs/api/core/Object3D.html
  3. 1 1
      docs/page.js

+ 2 - 2
docs/api/CONTRIBUTING.md

@@ -2,6 +2,6 @@ Contributing to the documentation
 =================================
 =================================
 
 
 - To link to the page for `ClassName`, use `[page:ClassName link title]` (or just `[page:ClassName]`). Use `[page:ClassName.memberName]` to link to a class member (a property or method) called `memberName` on the page for `ClassName`. You can write `[page:.memberName]` to link to a property or method called `memberName` on the same page.
 - To link to the page for `ClassName`, use `[page:ClassName link title]` (or just `[page:ClassName]`). Use `[page:ClassName.memberName]` to link to a class member (a property or method) called `memberName` on the page for `ClassName`. You can write `[page:.memberName]` to link to a property or method called `memberName` on the same page.
-- Use `[example:exampleName title]` (ot just `[example:exampleName]`) to link to the example `threejs.org/examples/#exampleName`.
+- Use `[example:exampleName title]` (not just `[example:exampleName]`) to link to the example `threejs.org/examples/#exampleName`.
 - Document a property by writing `<h3>[property:TypeName propertyName]</h3>`.
 - Document a property by writing `<h3>[property:TypeName propertyName]</h3>`.
-- Document a method using `<h3>[method:ReturnType methodName]</h3>`.
+- Document a method using `<h3>[method:ReturnType methodName]</h3>`.

+ 1 - 1
docs/api/core/Object3D.html

@@ -66,7 +66,7 @@
 
 
 		<h3>[property:Vector3 up]</h3>
 		<h3>[property:Vector3 up]</h3>
 		<div>
 		<div>
-		Up direction.
+		Up direction. Default is THREE.Vector3( 0, 1, 0 ).
 		</div>
 		</div>
 
 
 		<h3>[property:Matrix4 matrix]</h3>
 		<h3>[property:Matrix4 matrix]</h3>

+ 1 - 1
docs/page.js

@@ -35,7 +35,7 @@ var onDocumentLoad = function ( event ) {
 	text = text.replace(/\*([\w|\d|\"|\-|\(][\w|\d|\ |\-|\/|\+|\-|\(|\)|\=|\,|\.\"]*[\w|\d|\"|\)]|\w)\*/gi, "<strong>$1</strong>" ); // *
 	text = text.replace(/\*([\w|\d|\"|\-|\(][\w|\d|\ |\-|\/|\+|\-|\(|\)|\=|\,|\.\"]*[\w|\d|\"|\)]|\w)\*/gi, "<strong>$1</strong>" ); // *
 
 
 	text = text.replace(/\[example:([\w\_]+)\]/gi, "[example:$1 $1]" ); // [example:name] to [example:name title]
 	text = text.replace(/\[example:([\w\_]+)\]/gi, "[example:$1 $1]" ); // [example:name] to [example:name title]
-	text = text.replace(/\[example:([\w\_]+) ([\w\:\/\.\-\_ \s]+)\]/gi, "<a href=\"../../../examples/#$1\"  target=\"_blank\">$2</a>" ); // [example:name title]
+	text = text.replace(/\[example:([\w\_]+) ([\w\:\/\.\-\_ \s]+)\]/gi, "<a href=\"../../../../examples/#$1\"  target=\"_blank\">$2</a>" ); // [example:name title]
 
 
 
 
 	document.body.innerHTML = text;
 	document.body.innerHTML = text;