Merge pull request #5199 from kcoley/documentColorCorrectionAndColorCurves

documented colorCurves, colorCorrectionPostProcess

dist/preview release/typedocValidationBaseline.json

@@ -375,41 +375,6 @@
         }
       }
     },
-    "ColorCorrectionPostProcess": {
-      "Class": {
-        "Comments": {
-          "MissingText": true
-        }
-      }
-    },
-    "ColorCurves": {
-      "Method": {
-        "getClassName": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "Bind": {
-          "Parameter": {
-            "positiveUniform": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "neutralUniform": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "negativeUniform": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        }
-      }
-    },
     "CubeTexture": {
       "Class": {
         "Comments": {

src/Materials/babylon.colorCurves.ts

@@ -314,6 +314,10 @@
             this._dirty = true;
         }
 
+        /**
+         * Returns the class name
+         * @returns The class name
+         */
         public getClassName(): string {
             return "ColorCurves";
         }
@@ -322,6 +326,9 @@
          * Binds the color curves to the shader.
          * @param colorCurves The color curve to bind
          * @param effect The effect to bind to
+         * @param positiveUniform The positive uniform shader parameter
+         * @param neutralUniform The neutral uniform shader parameter
+         * @param negativeUniform The negative uniform shader parameter
          */
         public static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform = "vCameraColorCurvePositive", neutralUniform = "vCameraColorCurveNeutral", negativeUniform = "vCameraColorCurveNegative"): void {
             if (colorCurves._dirty) {

src/PostProcess/babylon.colorCorrectionPostProcess.ts

@@ -1,18 +1,21 @@
-//
-//  This post-process allows the modification of rendered colors by using
-//  a 'look-up table' (LUT). This effect is also called Color Grading.
-// 
-//  The object needs to be provided an url to a texture containing the color
-//  look-up table: the texture must be 256 pixels wide and 16 pixels high.
-//  Use an image editing software to tweak the LUT to match your needs.
-// 
-//  For an example of a color LUT, see here:
-//      http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
-//  For explanations on color grading, see here:
-//      http://udn.epicgames.com/Three/ColorGrading.html
-//
+
 
 module BABYLON {
+    /**
+     * 
+     * This post-process allows the modification of rendered colors by using
+     * a 'look-up table' (LUT). This effect is also called Color Grading.
+     *
+     * The object needs to be provided an url to a texture containing the color
+     * look-up table: the texture must be 256 pixels wide and 16 pixels high.
+     * Use an image editing software to tweak the LUT to match your needs.
+     * 
+     * For an example of a color LUT, see here:
+     * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
+     * For explanations on color grading, see here:
+     * @see http://udn.epicgames.com/Three/ColorGrading.html
+     *
+     */
     export class ColorCorrectionPostProcess extends PostProcess {
 
         private _colorTableTexture: Texture;