typedoc serializers

Tools/Gulp/result.txt

@@ -1,4 +1,20 @@
-[17:29:16] Using gulpfile c:\Dev\Babylon\Babylon.js\Tools\Gulp\gulpfile.js
-[17:29:16] Starting 'typedoc-validate'...
-[17:29:17] All formatting check passed successfully during the validation !
-[17:29:17] Finished 'typedoc-validate' after 579 ms
+[20:24:06] Using gulpfile c:\Dev\Babylon\Babylon.js\Tools\Gulp\gulpfile.js
+[20:24:06] Starting 'typedoc-validate'...
+[20:24:07] Missing text for Class : OBJExport (id: 60192) serializers/babylonjs.serializers.d.ts:6
+[20:24:07] Missing text for Method : MTL (id: 60200) in OBJExport (id: 60192) serializers/babylonjs.serializers.d.ts:8
+[20:24:07] Missing text for parameter mesh (id: 60201) of MTL (id: 60199) serializers/babylonjs.serializers.d.ts:8
+[20:24:07] Missing text for Method : OBJ (id: 60194) in OBJExport (id: 60192) serializers/babylonjs.serializers.d.ts:7
+[20:24:07] Missing text for parameter mesh (id: 60195) of OBJ (id: 60193) serializers/babylonjs.serializers.d.ts:7
+[20:24:07] Missing text for parameter materials (id: 60196) of OBJ (id: 60193) serializers/babylonjs.serializers.d.ts:7
+[20:24:07] Missing text for parameter matlibname (id: 60197) of OBJ (id: 60193) serializers/babylonjs.serializers.d.ts:7
+[20:24:07] Missing text for parameter globalposition (id: 60198) of OBJ (id: 60193) serializers/babylonjs.serializers.d.ts:7
+[20:24:07] 8 errors have been detected during the validation !
+[20:24:07] 'typedoc-validate' errored after 743 ms
+[20:24:07] Error in plugin "gulp-validateTypedoc"
+Message:
+    8 errors have been detected during the validation !
+Details:
+    domainEmitter: [object Object]
+    domain: [object Object]
+    domainThrown: false
+

serializers/src/OBJ/objSerializer.ts

@@ -1,7 +1,17 @@
 import { Mesh, Nullable, Matrix, Geometry, Tools, StandardMaterial } from "babylonjs";
 
+/**
+ * Class for generating OBJ data from a Babylon scene.
+ */
 export class OBJExport {
-    //Exports the geometry of a Mesh array in .OBJ file format (text)
+    /**
+     * Exports the geometry of a Mesh array in .OBJ file format (text)
+     * @param mesh defines the list of meshes to serialize
+     * @param materials defines if materials should be exported
+     * @param matlibname defines the name of the associated mtl file
+     * @param globalposition defines if the exported positions are globals or local to the exported mesh
+     * @returns the OBJ content
+     */
     public static OBJ(mesh: Mesh[], materials?: boolean, matlibname?: string, globalposition?: boolean): string {
         const output: string[] = [];
         let v = 1;
@@ -90,7 +100,12 @@ export class OBJExport {
         const text: string = output.join("\n");
         return (text);
     }
-    //Exports the material(s) of a mesh in .MTL file format (text)
+
+    /**
+     * Exports the material(s) of a mesh in .MTL file format (text)
+     * @param mesh defines the mesh to extract the material from
+     * @returns the mtl content
+     */
     //TODO: Export the materials of mesh array
     public static MTL(mesh: Mesh): string {
         var output = [];