Skip to content

Commit

Permalink
Make extend links
Browse files Browse the repository at this point in the history
  • Loading branch information
sasha240100 committed Jun 26, 2017
1 parent 0beefff commit 60e2590
Show file tree
Hide file tree
Showing 32 changed files with 185 additions and 31 deletions.
2 changes: 1 addition & 1 deletion src/components/cameras/CubeCamera.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {CameraComponent} from '../../core/CameraComponent';
* @description Creates 6 cameras that render to a WebGLRenderTargetCube
* @param {Object} [params] - The parameters object.
* @memberof module:components/cameras
* @extends CameraComponent
* @extends module:core.CameraComponent
* @example <caption>Creates a CubeCamera and set it as app's camera</caption>
* const camera = new CubeCamera({
* camera: {
Expand Down
2 changes: 1 addition & 1 deletion src/components/cameras/OrthographicCamera.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {system} from '../../polyfill';
* @description Camera with orthographic projection.
* @param {Object} [params] - The parameters object.
* @memberof module:components/cameras
* @extends CameraComponent
* @extends module:core.CameraComponent
* @example <caption>Create an OrthographicCamera and set it as app's camera</caption>
* const camera = new OrthographicCamera({
* camera: {
Expand Down
2 changes: 1 addition & 1 deletion src/components/cameras/PerspectiveCamera.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {system} from '../../polyfill';
* @category components/cameras
* @param {Object} [params] - The parameters object.
* @memberof module:components/cameras
* @extends CameraComponent
* @extends module:core.CameraComponent
* @example <caption>Create an PerspectiveCamera and set it as app's camera</caption>
* const camera = new PerspectiveCamera({
* fov: 75,
Expand Down
2 changes: 1 addition & 1 deletion src/components/lights/AmbientLight.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {LightComponent} from '../../core/LightComponent';
* AmbientLight creates basic light around all scene, so it doesn't need properties like pos or target.
* It supports only color and intensity as parameters, which defines the color of the surrounded light and intensity of light.
* @param {Object} [params={light: {color: 0xffffff, intensity: 1}}] - The params.
* @extends LightComponent
* @extends module:core.LightComponent
* @memberof module:components/lights
* @example <caption>Creating an AmbientLight </caption>
* new AmbientLight({
Expand Down
2 changes: 1 addition & 1 deletion src/components/lights/DirectionalLight.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import {LightComponent} from '../../core/LightComponent';
* The best analogy would be a light source that acts like the sun: the sun is so far away that all sunlight hitting objects comes from the same angle.<br/><br/>
* It has the same options as AmbientLight in light paramater, but it also supports pos and target paramaters.
* @param {Object} [params={light: {color: 0xffffff, intensity: 1}}] - The params.
* @extends LightComponent
* @extends module:core.LightComponent
* @memberof module:components/lights
* @example <caption>Creating a DirectionalLight to fall down from vec3(10, 20, 10) to vec3(0, 0, 0)</caption>
* new DirectionalLight({
Expand Down
2 changes: 1 addition & 1 deletion src/components/lights/HemisphereLight.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import {LightComponent} from '../../core/LightComponent';
* @classDesc
* <iframe src="https://threejs.org/examples/webgl_lights_hemisphere.html"></iframe>
* @param {Object} [params={light: {skyColor: 0xffffff, groundColor: 0xffffff, intensity: 1}}] - The params.
* @extends LightComponent
* @extends module:core.LightComponent
* @memberof module:components/lights
* @example <caption>Creating a HemisphereLight</caption>
* new HemisphereLight({
Expand Down
2 changes: 1 addition & 1 deletion src/components/lights/PointLight.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import {LightComponent} from '../../core/LightComponent';
* @param {Object} [params={light: {color: 0xffffff, intensity: 1, distance: 100, decay: 1}}] - The params.
* @classDesc
* <iframe src="https://threejs.org/examples/webgl_lights_pointlights.html"></iframe>
* @extends LightComponent
* @extends module:core.LightComponent
* @memberof module:components/lights
* @example <caption>Creating a PointLight</caption>
* new PointLight({
Expand Down
2 changes: 1 addition & 1 deletion src/components/lights/SpotLight.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {LightComponent} from '../../core/LightComponent';
* @classDesc
* <iframe src="https://threejs.org/examples/webgl_lights_spotlight.html"></iframe>
* @param {Object} [params={light: {color: 0xffffff, intensity: 1, distance: 100, angle: Math.PI / 3, exponent: 0, decay: 1}}] - The params.
* @extends LightComponent
* @extends module:core.LightComponent
* @memberof module:components/lights
* @example <caption>Creating a SpotLight that falls down from vec3(10, 20, 10) to vec3(0, 0, 0)</caption>
* new SpotLight({
Expand Down
2 changes: 1 addition & 1 deletion src/components/meshes/Box.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import {MeshComponent} from '../../core/MeshComponent';
* @classDesc
* <iframe src="https://threejs.org/docs/scenes/geometry-browser.html#BoxGeometry"></iframe>
* @param {Object} [params] - The params.
* @extends MeshComponent
* @extends module:core.MeshComponent
* @memberof module:components/meshes
* @example <caption>Creating a Box, and adding to app</caption>
* new Box({
Expand Down
2 changes: 1 addition & 1 deletion src/components/meshes/Cylinder.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import {MeshComponent} from '../../core/MeshComponent';
* @classDesc
* <iframe src="https://threejs.org/docs/scenes/geometry-browser.html#CylinderGeometry"></iframe>
* @param {Object} [params] - The params.
* @extends MeshComponent
* @extends module:core.MeshComponent
* @memberof module:components/meshes
* @example <caption>Creating a Cylinder, and adding to app</caption>
* new Cylinder({
Expand Down
2 changes: 1 addition & 1 deletion src/components/meshes/Dodecahedron.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import {MeshComponent} from '../../core/MeshComponent';
* @classDesc
* <iframe src="https://threejs.org/docs/scenes/geometry-browser.html#DodecahedronGeometry"></iframe>
* @param {Object} [params] - The params.
* @extends MeshComponent
* @extends module:core.MeshComponent
* @memberof module:components/meshes
* @example <caption>Creating a Dodecahedron, and adding to app</caption>
* new Dodecahedron({
Expand Down
2 changes: 1 addition & 1 deletion src/components/meshes/Extrude.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import {MeshComponent} from '../../core/MeshComponent';
* @classDesc
* <iframe src="https://threejs.org/docs/scenes/geometry-browser.html#ExtrudeGeometry"></iframe>
* @param {Object} [params] - The params.
* @extends MeshComponent
* @extends module:core.MeshComponent
* @memberof module:components/meshes
* @example <caption>Creating a shape, then an Extrude from it</caption>
* const shape = new THREE.Shape([
Expand Down
2 changes: 1 addition & 1 deletion src/components/meshes/Group.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {Component} from '../../core/Component';
* @description Sometimes you need to make groups of objects (it's not conveniently to apply transforms to each object when can make just one to a group).<br/>
* In Three.js you make it using `THREE.Object3D` and it's children. <br/><br/>
* In whs.js we have `Group`
* @extends MeshComponent
* @extends module:core.MeshComponent
* @memberof module:components/meshes
* @example <caption>Approach 2 - Adding objects to an empty group</caption>
* const sphere = new Sphere();
Expand Down
2 changes: 1 addition & 1 deletion src/components/meshes/Icosahedron.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import {MeshComponent} from '../../core/MeshComponent';
* @classDesc
* <iframe src="https://threejs.org/docs/scenes/geometry-browser.html#IcosahedronGeometry"></iframe>
* @param {Object} [params] - The params.
* @extends MeshComponent
* @extends module:core.MeshComponent
* @memberof module:components/meshes
* @example <caption>Creating a Icosahedron, and adding to app</caption>
* new Icosahedron({
Expand Down
2 changes: 1 addition & 1 deletion src/components/meshes/Lathe.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import {MeshComponent} from '../../core/MeshComponent';
* @classDesc
* <iframe src="https://threejs.org/docs/scenes/geometry-browser.html#LatheGeometry"></iframe>
* @param {Object} [params] - The params.
* @extends MeshComponent
* @extends module:core.MeshComponent
* @memberof module:components/meshes
* @example <caption>Creating a Lath, and adding to app</caption>
* const points = [];
Expand Down
2 changes: 1 addition & 1 deletion src/components/meshes/Line.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import {MeshComponent} from '../../core/MeshComponent';
* @category components/meshes
* @description Line component is generated from a curve/line and amount of vectors that should be used (points).
* @param {Object} [params] - The params.
* @extends MeshComponent
* @extends module:core.MeshComponent
* @memberof module:components/meshes
* @example <caption>Creating a Line, and adding to app</caption>
* new Line({
Expand Down
2 changes: 1 addition & 1 deletion src/components/meshes/Octahedron.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import {MeshComponent} from '../../core/MeshComponent';
* @classDesc
* <iframe src="https://threejs.org/docs/scenes/geometry-browser.html#OctahedronGeometry"></iframe>
* @param {Object} [params] - The params.
* @extends MeshComponent
* @extends module:core.MeshComponent
* @memberof module:components/meshes
* @example <caption>Creating an Octahedron, and adding to app</caption>
* new Octahedron({
Expand Down
2 changes: 1 addition & 1 deletion src/components/meshes/Parametric.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import {MeshComponent} from '../../core/MeshComponent';
* @classDesc
* <iframe src="https://threejs.org/docs/scenes/geometry-browser.html#ParametricGeometry"></iframe>
* @param {Object} [params] - The params.
* @extends MeshComponent
* @extends module:core.MeshComponent
* @memberof module:components/meshes
* @example <caption>Example creating an heightfield-like geometry. `u` and `v` are like `x` and `y` in shape, but their values are always from `0` to `1`.
* We use them in `THREE.Vector3` like `x` and `z` and `Math.random() * 5` for `y`.</caption>
Expand Down
2 changes: 1 addition & 1 deletion src/components/meshes/Plane.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import {MeshComponent} from '../../core/MeshComponent';
* @classDesc
* <iframe src="https://threejs.org/docs/scenes/geometry-browser.html#PlaneGeometry"></iframe>
* @param {Object} [params] - The params.
* @extends MeshComponent
* @extends module:core.MeshComponent
* @memberof module:components/meshes
* @example <caption>Creating a Plane, and adding to app</caption>
* new Plane({
Expand Down
2 changes: 1 addition & 1 deletion src/components/meshes/Polyhedron.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ const [verticesOfCube, indicesOfFaces] = [
* `Polyhedron` creates a Polyhedron by its `radius` and `detail`.
* <br/><br/>
* @param {Object} [params] - The params.
* @extends MeshComponent
* @extends module:core.MeshComponent
* @memberof module:components/meshes
* @example <caption>Creating an Polyhedron, and adding to app</caption>
* new Polyhedron({
Expand Down
2 changes: 1 addition & 1 deletion src/components/meshes/Ring.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import {MeshComponent} from '../../core/MeshComponent';
* @classDesc
* <iframe src="https://threejs.org/docs/scenes/geometry-browser.html#RingGeometry"></iframe>
* @param {Object} [params] - The params.
* @extends MeshComponent
* @extends module:core.MeshComponent
* @memberof module:components/meshes
* @example <caption>Creating a Ring, and adding to app</caption>
* new Ring({
Expand Down
2 changes: 1 addition & 1 deletion src/components/meshes/Shape.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import {MeshComponent} from '../../core/MeshComponent';
* @classDesc
* <iframe src="https://threejs.org/docs/scenes/geometry-browser.html#ShapeGeometry"></iframe>
* @param {Object} [params] - The params.
* @extends MeshComponent
* @extends module:core.MeshComponent
* @memberof module:components/meshes
* @example <caption>Creating a plane looking Shape from a THREE.Shape, and adding it to app</caption>
* const rectWidth = 10,
Expand Down
2 changes: 1 addition & 1 deletion src/components/meshes/Sphere.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import {MeshComponent} from '../../core/MeshComponent';
* @classDesc
* <iframe src="https://threejs.org/docs/scenes/geometry-browser.html#SphereGeometry"></iframe>
* @param {Object} [params] - The params.
* @extends MeshComponent
* @extends module:core.MeshComponent
* @memberof module:components/meshes
* @example <caption>Creating a Sphere, and adding it to app</caption>
* new Sphere({
Expand Down
2 changes: 1 addition & 1 deletion src/components/meshes/Tetrahedron.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import {MeshComponent} from '../../core/MeshComponent';
* @classDesc
* <iframe src="https://threejs.org/docs/scenes/geometry-browser.html#TetrahedronGeometry"></iframe>
* @param {Object} [params] - The params.
* @extends MeshComponent
* @extends module:core.MeshComponent
* @memberof module:components/meshes
* @example <caption>Creating a Tetrahedron, and adding it to app</caption>
* new Tetrahedron({
Expand Down
2 changes: 1 addition & 1 deletion src/components/meshes/Text.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import {MeshComponent} from '../../core/MeshComponent';
* <br/><br/>
* Physics text object can be convex or concave. By default it's convex but you can also switch to concave.
* @param {Object} [params] - The params.
* @extends MeshComponent
* @extends module:core.MeshComponent
* @memberof module:components/meshes
* @example <caption>Creating a Text, and adding it to app</caption>
* new Text({
Expand Down
2 changes: 1 addition & 1 deletion src/components/meshes/Torus.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import {MeshComponent} from '../../core/MeshComponent';
* @classDesc
* <iframe src="https://threejs.org/docs/index.html#api/geometries/TorusGeometry"></iframe>
* @param {Object} [params] - The params.
* @extends MeshComponent
* @extends module:core.MeshComponent
* @memberof module:components/meshes
* @example <caption>Creating a Torus, and adding it to app</caption>
* new Torus({
Expand Down
2 changes: 1 addition & 1 deletion src/components/meshes/Torusknot.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import {MeshComponent} from '../../core/MeshComponent';
* @classDesc
* <iframe src="https://threejs.org/docs/scenes/geometry-browser.html#TorusKnotGeometry"></iframe>
* @param {Object} [params] - The params.
* @extends MeshComponent
* @extends module:core.MeshComponent
* @memberof module:components/meshes
* @example <caption>Creating a Torusknot, and adding it to app</caption>
* new Torusknot({
Expand Down
2 changes: 1 addition & 1 deletion src/components/meshes/Tube.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import {MeshComponent} from '../../core/MeshComponent';
* @classDesc
* <iframe src="https://threejs.org/docs/index.html#api/geometries/TubeGeometry"></iframe>
* @param {Object} [params] - The params.
* @extends MeshComponent
* @extends module:core.MeshComponent
* @memberof module:components/meshes
* @example <caption>Creating a Tube from a three.js Curve, and adding it to app</caption>
* const CustomSinCurve = THREE.Curve.create(
Expand Down
1 change: 1 addition & 0 deletions src/core/App.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import {system} from '../polyfill';
import {ModuleSystem} from './ModuleSystem';
import {ModuleManager} from './ModuleManager';

/**
* @class App
* @category core
Expand Down
2 changes: 1 addition & 1 deletion src/core/CameraComponent.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import {CompositionError} from './errors';
* @category core
* @param {Object} [params] - The parameters object.
* @param {Object} [instructions] - The instructions object.
* @extends Component
* @extends module:core.Component
* @memberof module:core
*/
class CameraComponent extends Component {
Expand Down
Loading

0 comments on commit 60e2590

Please sign in to comment.