Add page regeneration script, fix yuidoc

gotwarlost · Oct 17, 2012 · ecfcf42 · ecfcf42
1 parent 7b3f92c
commit ecfcf42
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/.npmignore b/.npmignore
@@ -1,5 +1,6 @@
 .npmignore
 .gitignore
+generate-pages.sh
 .travis.yml
 *.tar
 *.tgz

diff --git a/generate-pages.sh b/generate-pages.sh
@@ -0,0 +1,9 @@
+export PAGES_DIR=../istanbul-pages
+npm install
+npm test --coverage
+npm install -g yuidocjs
+mkdir -p public/apidocs
+yuidoc .
+rsync -rvt ./public/apidocs/ ${PAGES_DIR}/public/apidocs/
+rsync -rvt ./build/coverage/ ${PAGES_DIR}/public/coverage
+
diff --git a/lib/object-utils.js b/lib/object-utils.js
@@ -258,6 +258,8 @@
      * returns the coverage summary for a single coverage object. This is
      * wrapper over `summarizeFileCoverage` and `mergeSummaryObjects` for
      * the common case of a single coverage object
+     * @method summarizeCoverage
+     * @static
      * @param {Object} coverage  the coverage object
      * @return {Object} summary coverage metrics across all files in the coverage object
      */