adding missing comments; removing more lines from validation baseline

dist/preview release/typedocValidationBaseline.json

@@ -444,24 +444,6 @@
         }
       }
     },
-    "DistanceJoint": {
-      "Method": {
-        "updateDistance": {
-          "Parameter": {
-            "maxDistance": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "minDistance": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        }
-      }
-    },
     "FilterPostProcess": {
       "Class": {
         "Comments": {
@@ -968,29 +950,6 @@
         }
       }
     },
-    "MotorEnabledJoint": {
-      "Class": {
-        "Comments": {
-          "MissingText": true
-        }
-      },
-      "Method": {
-        "setLimit": {
-          "Parameter": {
-            "upperLimit": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "lowerLimit": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        }
-      }
-    },
     "MultiRenderTarget": {
       "Class": {
         "Comments": {
@@ -4775,66 +4734,6 @@
         }
       }
     },
-    "IMotorEnabledJoint": {
-      "Interface": {
-        "Comments": {
-          "MissingText": true
-        }
-      },
-      "Property": {
-        "physicsJoint": {
-          "Comments": {
-            "MissingText": true
-          }
-        }
-      },
-      "Method": {
-        "setLimit": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "upperLimit": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "lowerLimit": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "motorIndex": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "setMotor": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "force": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "maxForce": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "motorIndex": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        }
-      }
-    },
     "IMultiRenderTargetOptions": {
       "Interface": {
         "Comments": {
@@ -4903,169 +4802,6 @@
         }
       }
     },
-    "IPhysicsEnabledObject": {
-      "Interface": {
-        "Comments": {
-          "MissingText": true
-        }
-      },
-      "Property": {
-        "parent": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "position": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "rotation": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "rotationQuaternion": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "scaling": {
-          "Comments": {
-            "MissingText": true
-          }
-        }
-      },
-      "Method": {
-        "computeWorldMatrix": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "force": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "getAbsolutePivotPoint": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "getAbsolutePosition": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "getBoundingInfo": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "getChildMeshes": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "directDescendantsOnly": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "getClassName": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "getIndices": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "getScene": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "getVerticesData": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "kind": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "getWorldMatrix": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "rotate": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "axis": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "amount": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "space": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "setAbsolutePosition": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "absolutePosition": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        },
-        "translate": {
-          "Comments": {
-            "MissingText": true
-          },
-          "Parameter": {
-            "axis": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "distance": {
-              "Comments": {
-                "MissingText": true
-              }
-            },
-            "space": {
-              "Comments": {
-                "MissingText": true
-              }
-            }
-          }
-        }
-      }
-    },
     "ISceneLoaderPlugin": {
       "Interface": {
         "Comments": {
@@ -5113,159 +4849,6 @@
         }
       }
     },
-    "PhysicsForceAndContactPoint": {
-      "Property": {
-        "contactPoint": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "force": {
-          "Comments": {
-            "MissingText": true
-          }
-        }
-      }
-    },
-    "PhysicsGravitationalFieldEventData": {
-      "Interface": {
-        "Comments": {
-          "MissingText": true
-        }
-      },
-      "Property": {
-        "sphere": {
-          "Comments": {
-            "MissingText": true
-          }
-        }
-      }
-    },
-    "PhysicsImpostorParameters": {
-      "Interface": {
-        "Comments": {
-          "MissingText": true
-        }
-      },
-      "Property": {
-        "disableBidirectionalTransformation": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "friction": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "ignoreParent": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "mass": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "nativeOptions": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "restitution": {
-          "Comments": {
-            "MissingText": true
-          }
-        }
-      }
-    },
-    "PhysicsJointData": {
-      "Interface": {
-        "Comments": {
-          "MissingText": true
-        }
-      },
-      "Property": {
-        "collision": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "connectedAxis": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "connectedPivot": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "mainAxis": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "mainPivot": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "nativeParams": {
-          "Comments": {
-            "MissingText": true
-          }
-        }
-      }
-    },
-    "PhysicsRadialExplosionEventData": {
-      "Interface": {
-        "Comments": {
-          "MissingText": true
-        }
-      },
-      "Property": {
-        "rays": {
-          "Comments": {
-            "MissingText": true
-          }
-        },
-        "sphere": {
-          "Comments": {
-            "MissingText": true
-          }
-        }
-      }
-    },
-    "PhysicsUpdraftEventData": {
-      "Interface": {
-        "Comments": {
-          "MissingText": true
-        }
-      },
-      "Property": {
-        "cylinder": {
-          "Comments": {
-            "MissingText": true
-          }
-        }
-      }
-    },
-    "PhysicsVortexEventData": {
-      "Interface": {
-        "Comments": {
-          "MissingText": true
-        }
-      },
-      "Property": {
-        "cylinder": {
-          "Comments": {
-            "MissingText": true
-          }
-        }
-      }
-    },
     "PostProcessOptions": {
       "Type alias": {
         "Comments": {

src/Physics/babylon.physicsHelper.ts

@@ -707,7 +707,13 @@ module BABYLON {
      * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
      */
     export interface PhysicsForceAndContactPoint {
+        /**
+         * The force applied at the contact point
+         */
         force: Vector3;
+        /**
+         * The contact point
+         */
         contactPoint: Vector3;
     }
 
@@ -716,7 +722,13 @@ module BABYLON {
      * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
      */
     export interface PhysicsRadialExplosionEventData {
+        /**
+         * A sphere used for the radial explosion event
+         */
         sphere: Mesh;
+        /**
+         * An array of rays for the radial explosion event
+         */
         rays: Array<Ray>;
     }
 
@@ -725,6 +737,9 @@ module BABYLON {
      * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
      */
     export interface PhysicsGravitationalFieldEventData {
+        /**
+         * A sphere mesh used for the gravitational field event
+         */
         sphere: Mesh;
     }
 
@@ -733,6 +748,9 @@ module BABYLON {
      * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
      */
     export interface PhysicsUpdraftEventData {
+        /**
+         * A cylinder used for the updraft event
+         */
         cylinder: Mesh;
     }
 
@@ -741,6 +759,9 @@ module BABYLON {
      * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
      */
     export interface PhysicsVortexEventData {
+        /**
+         * A cylinder used for the vortex event
+         */
         cylinder: Mesh;
     }
 

src/Physics/babylon.physicsJoint.ts

@@ -190,8 +190,8 @@ module BABYLON {
         /**
          * Set the motor values.
          * Attention, this function is plugin specific. Engines won't react 100% the same.
-         * @param {number} force the force to apply
-         * @param {number} maxForce max force for this motor.
+         * @param force the force to apply
+         * @param maxForce max force for this motor.
          */
         public setMotor(force?: number, maxForce?: number) {
             this._physicsPlugin.setMotor(this, force || 0, maxForce);
@@ -285,8 +285,23 @@ module BABYLON {
      * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
      */
     export interface IMotorEnabledJoint {
+        /**
+         * Physics joint
+         */
         physicsJoint: any;
+        /**
+         * Sets the motor of the motor-enabled joint
+         * @param force The force of the motor
+         * @param maxForce The maximum force of the motor
+         * @param motorIndex The index of the motor
+         */
         setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
+        /**
+         * Sets the limit of the motor
+         * @param upperLimit The upper limit of the motor
+         * @param lowerLimit The lower limit of the motor
+         * @param motorIndex The index of the motor
+         */
         setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
     }