瀏覽代碼

Fix Typedoc Tests

sebastien 7 年之前
父節點
當前提交
367bf18162
共有 3 個文件被更改,包括 14 次插入43 次删除
  1. 0 41
      dist/preview release/typedocValidationBaseline.json
  2. 7 1
      src/Layer/babylon.effectlayer.ts
  3. 7 1
      src/babylon.scene.ts

+ 0 - 41
dist/preview release/typedocValidationBaseline.json

@@ -14674,42 +14674,6 @@
         }
       }
     },
-    "HighlightLayer": {
-      "Property": {
-        "name": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "glowingMeshStencilReference": {
-          "Naming": {
-            "NotPascalCase": true
-          }
-        },
-        "neutralColor": {
-          "Naming": {
-            "NotPascalCase": true
-          }
-        },
-        "normalMeshStencilReference": {
-          "Naming": {
-            "NotPascalCase": true
-          }
-        }
-      },
-      "Method": {
-        "_rebuild": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "shouldRender": {
-          "Comments": {
-            "MissingReturn": true
-          }
-        }
-      }
-    },
     "HighlightsPostProcess": {
       "Class": {
         "Comments": {
@@ -27406,11 +27370,6 @@
             "MissingText": true
           }
         },
-        "highlightLayers": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
         "hoverCursor": {
           "Comments": {
             "MissingText": true

+ 7 - 1
src/Layer/babylon.effectlayer.ts

@@ -100,7 +100,10 @@
          * @param name The name of the layer
          * @param scene The scene to use the layer in
          */
-        constructor(public name: string, scene: Scene) {
+        constructor(
+            /** The Friendly of the effect in the scene */
+            public name: string, 
+            scene: Scene) {
             var engine = scene.getEngine();
             this._engine = engine;
             this._scene = scene || Engine.LastCreatedScene;
@@ -128,12 +131,14 @@
 
         /**
          * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
+         * @returns true if the effect requires stencil during the main canvas render pass.
          */
         public abstract needStencil(): boolean;
 
         /**
          * Create the merge effect. This is the shader use to blit the information back
          * to the main canvas at the end of the scene rendering.
+         * @returns The effect containing the shader used to merge the effect on the  main canvas
          */
         protected abstract _createMergeEffect(): Effect;
         
@@ -457,6 +462,7 @@
 
         /**
          * Returns true if the layer contains information to display, otherwise false.
+         * @returns true if the glow layer should be rendered
          */
         public shouldRender(): boolean {
             return this.isEnabled && this._shouldRender;

+ 7 - 1
src/babylon.scene.ts

@@ -748,8 +748,14 @@
         public spritesEnabled = true;
         public spriteManagers = new Array<SpriteManager>();
 
-        // Layers
+        /**
+         * The list of layers (background and foreground) of the scene.
+         */
         public layers = new Array<Layer>();
+
+        /**
+         * The list of effect layers (highlights/glow) contained in the scene.
+         */
         public effectLayers = new Array<EffectLayer>();
 
         // Skeletons