Browse Source

Added typedoc plus grunt task.

Sebastian Haas 9 years ago
parent
commit
e860ac82ea
3 changed files with 21 additions and 3 deletions
  1. 3 0
      .gitignore
  2. 13 0
      Gruntfile.js
  3. 5 3
      package.json

+ 3 - 0
.gitignore

@@ -11,6 +11,9 @@ pids
 *.pid
 *.seed
 
+# Documentation
+docs
+
 # Directory for instrumented libs generated by jscoverage/JSCover
 lib-cov
 

+ 13 - 0
Gruntfile.js

@@ -121,6 +121,17 @@ module.exports = function (grunt) {
         typings: {
             install: {}
         },
+        typedoc: {
+            build: {
+                options: {
+                    module: 'commonjs',
+                    out: './docs',
+                    name: 'opensheetmusicdisplay',
+                    target: 'es5'
+                },
+                src: ['./src/**/*.ts', './external/**/*.ts', './typings/**/*.ts']
+            }
+        },
         // Cleaning task setup
         clean: {
             options: {
@@ -168,6 +179,7 @@ module.exports = function (grunt) {
     grunt.loadNpmTasks('grunt-contrib-jshint');
     grunt.loadNpmTasks('grunt-contrib-uglify');
     grunt.loadNpmTasks('grunt-http-server');
+    grunt.loadNpmTasks('grunt-typedoc');
 
     // Register tasks
     grunt.registerTask('lint',      ['jshint', 'tslint']);
@@ -175,6 +187,7 @@ module.exports = function (grunt) {
     grunt.registerTask('all',       ['typings', 'default']);
     grunt.registerTask('default',   ['browserify', 'uglify']);
     grunt.registerTask('npm-test',  ['typings', 'test']);
+    grunt.registerTask('docs',      ['typedoc']);
     grunt.registerTask('test',      ['browserify:debug', 'lint', 'karma:ci']);
     grunt.registerTask('fast-test', ['browserify:debug', 'karma:ci']);
     grunt.registerTask('rebuild',   ['clean', 'default']);

+ 5 - 3
package.json

@@ -41,10 +41,12 @@
     "grunt-contrib-jshint": "^1.0.0",
     "grunt-contrib-uglify": "^2.0.0",
     "grunt-contrib-watch": "^1.0.0",
+    "grunt-http-server": "",
     "grunt-karma": "^2.0.0",
     "grunt-tslint": "^3.1.1",
+    "grunt-typedoc": "^0.2.4",
     "grunt-typings": "^0.1.5",
-    "grunt-http-server": "",
+    "http-server": "",
     "karma": "^1.1.1",
     "karma-base64-to-js-preprocessor": "0.0.1",
     "karma-chai": "^0.1.0",
@@ -58,8 +60,8 @@
     "phantomjs-prebuilt": "^2.1.8",
     "tsify": "^1.0.2",
     "tslint": "3.8.0",
+    "typedoc": "^0.4.4",
     "typescript": "^1.8.10",
-    "typings": "^1.3.1",
-    "http-server": ""
+    "typings": "^1.3.1"
   }
 }