Add a few commentsHEADmain

7 files changed, 24 insertions, 0 deletions

diff --git a/lib/components/color.js b/lib/components/color.js
index a9877bf..9be7ff1 100644
--- a/lib/components/color.js
+++ b/lib/components/color.js
@@ -1,5 +1,10 @@
 import { Component } from '@serpentity/serpentity';
 
+/*
+  * Stores an RGBA color. NOTE: Currently unused as color depends on the
+  * position of the vertex. This is intended to change once we add multiple
+  * curves in a single render.
+  */
 export default class Color extends Component {
   constructor(config) {
 
diff --git a/lib/components/configuration.js b/lib/components/configuration.js
index 78065c3..f5787ab 100644
--- a/lib/components/configuration.js
+++ b/lib/components/configuration.js
@@ -1,5 +1,9 @@
 import { Component } from '@serpentity/serpentity';
 
+/**
+  * Stores global behavior configuration that can be adjusted on the go. For
+  * static configuration see lib/config.js instead.
+  */
 export default class Configuration extends Component {
   constructor(config) {
 
diff --git a/lib/components/radius.js b/lib/components/radius.js
index 2aa29a8..0efd094 100644
--- a/lib/components/radius.js
+++ b/lib/components/radius.js
@@ -1,5 +1,8 @@
 import { Component } from '@serpentity/serpentity';
 
+/**
+  * Stores the radius of a circle or sphere
+  */
 export default class Radius extends Component {
   constructor(config) {
 
diff --git a/lib/components/triple_amplitude.js b/lib/components/triple_amplitude.js
index 376c321..8362c82 100644
--- a/lib/components/triple_amplitude.js
+++ b/lib/components/triple_amplitude.js
@@ -1,5 +1,8 @@
 import { Component } from '@serpentity/serpentity';
 
+/**
+  * Stores three values of amplitude, intended for a 3D parametric curve.
+  */
 export default class TripleAmplitude extends Component {
   constructor(config) {
 
diff --git a/lib/components/triple_frequency.js b/lib/components/triple_frequency.js
index e98410e..a67f1cd 100644
--- a/lib/components/triple_frequency.js
+++ b/lib/components/triple_frequency.js
@@ -1,5 +1,8 @@
 import { Component } from '@serpentity/serpentity';
 
+/**
+  * Stores three values of frequency, intended for a 3D parametric curve.
+  */
 export default class TripleFrequency extends Component {
   constructor(config) {
 
diff --git a/lib/components/triple_phase.js b/lib/components/triple_phase.js
index 66b874b..99416d2 100644
--- a/lib/components/triple_phase.js
+++ b/lib/components/triple_phase.js
@@ -1,5 +1,8 @@
 import { Component } from '@serpentity/serpentity';
 
+/**
+  * Stores three values of phase, intended for a 3D parametric curve.
+  */
 export default class TriplePhase extends Component {
   constructor(config) {
 
diff --git a/lib/components/up.js b/lib/components/up.js
index f28cc20..585b4b5 100644
--- a/lib/components/up.js
+++ b/lib/components/up.js
@@ -1,5 +1,8 @@
 import { Component } from '@serpentity/serpentity';
 
+/**
+  * Stores an up vector. Intended for the camera in the scene.
+  */
 export default class Up extends Component {
   constructor(config) {