Browse Source

Fixed to get TypeDoc to run

Shaddock Heath 9 years ago
parent
commit
4cf9b61bd3
3 changed files with 5 additions and 4 deletions
  1. 1 1
      Build/CIScripts/GenEditorData.js
  2. 1 1
      Build/Docs/gendocs.sh
  3. 3 2
      Script/TypeScript/EditorWork.d.ts

+ 1 - 1
Build/CIScripts/GenEditorData.js

@@ -52,7 +52,7 @@ namespace('build', function() {
 
     cmds = [
       "git clone https://github.com/AtomicGameEngine/AtomicExamples " + buildDir + "AtomicExamples && rm -rf " + buildDir + "AtomicExamples/.git",
-      "cd " + jsDocFolder + " && npm install typedoc",
+      "cd " + jsDocFolder + " && npm install typedoc@0.3.12",
       "cd " + jsDocFolder + " && ./node_modules/.bin/typedoc --out out ../../../Script/TypeScript/dist/Atomic.d.ts --module commonjs --includeDeclarations --mode file --theme atomic-theme --name 'Atomic Game Engine' --readme ./Readme.md",
     ];
 

+ 1 - 1
Build/Docs/gendocs.sh

@@ -2,7 +2,7 @@
 cp Readme.md ../../Artifacts/Build/JSDoc
 cp -R atomic-theme ../../Artifacts/Build/JSDoc/
 cd ../../Artifacts/Build/JSDoc
-npm install typedoc
+npm install typedoc@0.3.12
 ./node_modules/.bin/typedoc --out out ../../../Script/TypeScript/dist/Atomic.d.ts --module commonjs --includeDeclarations --mode file --theme atomic-theme --name 'Atomic Game Engine' --readme ./Readme.md
 
 cp -R out/ ../EditorData/Docs

+ 3 - 2
Script/TypeScript/EditorWork.d.ts

@@ -149,7 +149,8 @@ declare module Editor.EditorEvents {
 }
 
 declare module Editor.Templates {
-    export type TemplateType = "component" | "script";
+    // Commented out until the TSDoc gets updated to the latest version of TypeScript
+    //export type TemplateType = "component" | "script";
     /**
      * New file defintion
      */
@@ -159,7 +160,7 @@ declare module Editor.Templates {
         /** description */
         desc: string;
         /** type of template */
-        templateType: TemplateType;
+        templateType: string;
         /** file extension */
         ext: string;
         /** file name/path of the source templage file to clone from.  Note, needs to be in the atomic cache */