Add a few comments

[rbdr/lissajous] / lib / factories / global.js

diff --git a/lib/factories/global.js b/lib/factories/global.js
index bf0360df980e7e604f3b3936f723290f63c6edfc..4f36a8e3bc96619926ecab859360a7c7ddf547fb 100644 (file)
--- a/lib/factories/global.js
+++ b/lib/factories/global.js
@@ -6,6 +6,15 @@ import Radius from '../components/radius';
 import Up from '../components/up';
 import Configuration from '../components/configuration';
 
 import Up from '../components/up';
 import Configuration from '../components/configuration';
 

+/**
+  * This file is a factory for global objects. It doesn't enforce it, but
+  * there should be only one of these entities in the engine at a given
+  * time.
+  */
+
+/**
+  * Creates a data entity that holds the configuration.
+  */

 export function configuration() {
 
   const entity = new Entity();
 export function configuration() {
 
   const entity = new Entity();


@@ -14,6 +23,9 @@ export function configuration() {
   return entity;
 }
 
   return entity;
 }
 

+/**
+  * Creates a camera, used to modify the 3D view.
+  */

 export function camera() {
 
   const entity = new Entity();
 export function camera() {
 
   const entity = new Entity();