Fix up JSDoc for core module

hawtio · Nov 26, 2013 · 128f41b · 128f41b
1 parent c6b1f16
commit 128f41b
Show file tree

Hide file tree

Showing 8 changed files with 223 additions and 51 deletions.
diff --git a/hawtio-web/genDocs b/hawtio-web/genDocs
@@ -1,12 +1,15 @@
 #!/bin/bash 
 
-tsFiles=$(find . -type f -name *.ts | grep -v [.]d[.]ts | grep -v /test/ | grep -v target)
+#tsFiles=$(find . -type f -name *.ts | grep -v [.]d[.]ts | grep -v /test/ | grep -v target)
 
 # install yuidoc using the steps mentioned here -> http://yui.github.io/yuidoc/##install
 
 
 # starts yuidoc in server mode
-yuidoc -e .ts -o target/docs --server src/main/webapp/app/forcegraph/js/
+yuidoc -e .ts -o target/docs --server src/main/webapp/app/core/js/
+
+# Just evaluates JSDoc comments
+#yuidoc -e .ts -o target/docs --lint src/main/webapp/app/core/js/
 
 
 
diff --git a/hawtio-web/src/main/webapp/app/core/js/CodeEditor.ts b/hawtio-web/src/main/webapp/app/core/js/CodeEditor.ts
@@ -64,7 +64,7 @@ module CodeEditor {
    *
    * @method createEditorSettings
    * @param {Object} options
-   * @returns {Object}
+   * @return {Object}
    */
   export function createEditorSettings(options:any = {}) {
     options.extraKeys = options.extraKeys || {};