Add a couple JSDoc comments that yuidoc doesn't complain about

hawtio · Nov 25, 2013 · c6b1f16 · c6b1f16
1 parent 706293d
commit c6b1f16
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 6 deletions.
diff --git a/hawtio-web/genDocs b/hawtio-web/genDocs
@@ -6,7 +6,7 @@ tsFiles=$(find . -type f -name *.ts | grep -v [.]d[.]ts | grep -v /test/ | grep
 
 
 # starts yuidoc in server mode
-yuidoc -e .ts -o target/docs --server src/main/webapp/app/core/js/
+yuidoc -e .ts -o target/docs --server src/main/webapp/app/forcegraph/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
@@ -18,9 +18,7 @@ module CodeEditor {
 
     $scope.preferences = GlobalCodeMirrorOptions;
 
-    /**
-     * If any of the preferences change, make sure to save them automatically
-     */
+    // If any of the preferences change, make sure to save them automatically
     $scope.$watch("preferences", function(newValue, oldValue) {
       if (newValue !== oldValue) {
         // such a cheap and easy way to update the example view :-)
@@ -45,6 +43,10 @@ module CodeEditor {
 
   /**
    * Auto formats the CodeMirror editor content to pretty print
+   *
+   * @method autoFormatEditor
+   * @param {CodeMirrorEditor} editor
+   * @return {void}
    */
   export function autoFormatEditor(editor:CodeMirrorEditor) {
     if (editor) {
@@ -58,7 +60,11 @@ module CodeEditor {
   }
 
   /**
-   * Used to configures the default editor settings (Per Editor Instance)
+   * Used to configures the default editor settings (per Editor Instance)
+   *
+   * @method createEditorSettings
+   * @param {Object} options
+   * @returns {Object}
    */
   export function createEditorSettings(options:any = {}) {
     options.extraKeys = options.extraKeys || {};

diff --git a/hawtio-web/src/main/webapp/app/core/js/coreHelpers.ts b/hawtio-web/src/main/webapp/app/core/js/coreHelpers.ts
@@ -19,6 +19,11 @@ var numberTypeNames = {
 
 /**
  * Returns the number of lines in the given text
+ *
+ * @method lineCount
+ * @param {String} value
+ * @return {Number}
+ *
  */
 function lineCount(value): number {
   var rows = 0;
@@ -89,6 +94,11 @@ function trimQuotes(text:string) {
  *
  * If the value is null an empty array is returned.
  * If the value is a non empty string then the string is split by commas
+ *
+ * @method toSearchArgumentArray
+ * @param {Object} value
+ * @return {String[]}
+ *
  */
 function toSearchArgumentArray(value): string[] {
   if (value) {

diff --git a/hawtio-web/src/main/webapp/app/forcegraph/js/forceGraphPlugin.ts b/hawtio-web/src/main/webapp/app/forcegraph/js/forceGraphPlugin.ts
@@ -1,3 +1,8 @@
+/**
+ * Force Graph plugin & directive
+ *
+ * @module ForceGraph
+ */
 module ForceGraph {
     var pluginName = 'forceGraph';
 

diff --git a/hawtio-web/src/main/webapp/app/forcegraph/js/graphBuilder.ts b/hawtio-web/src/main/webapp/app/forcegraph/js/graphBuilder.ts
@@ -1,11 +1,21 @@
 module ForceGraph {
 
+    /**
+     * GraphBuilder
+     *
+     * @class GraphBuilder
+     */
     export class GraphBuilder {
 
         private nodes = {};
         private links = [];
         private linkTypes = {};
 
+      /**
+       * Adds a node to this graph
+       * @method addNode
+       * @param {Object} node
+       */
         public addNode(node) {
             if(!this.nodes[node.id]) {
                 this.nodes[node.id] = node;
@@ -115,4 +125,4 @@ module ForceGraph {
             }
         }
     }
-}
+}