tweak JSDoc comments, add @static tags to wiki methods

hawtio · Nov 27, 2013 · acb2d93 · acb2d93
1 parent 8d2a5f9
commit acb2d93
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 4 deletions.
diff --git a/hawtio-web/src/main/webapp/app/git/js/git.ts b/hawtio-web/src/main/webapp/app/git/js/git.ts
@@ -142,15 +142,19 @@ module Git {
 
     /**
      * Returns a list of commit tree info objects for the given commit ID
-     * @param commitId
-     * @param fn
+     *
+     * @method commitTree
+     * @param {String} commitId
+     * @param {Function} fn
      */
     commitTree(commitId:string, fn);
 
     /**
      * Returns details of a commit for the given commit ID
-     * @param commitId
-     * @param fn
+     *
+     * @method commitInfo
+     * @param {String} commitId
+     * @param {function} fn
      */
     commitInfo(commitId:string, fn);
 
@@ -173,7 +177,10 @@ module Git {
   /**
    * A default implementation which uses jolokia and the
    * GitFacadeMXBean over JMX
+   *
    * @class JolokiaGit
+   * @uses GitRepository
+   *
    */
   export class JolokiaGit implements GitRepository {
     constructor(public mbean:string, public jolokia, public localStorage, public branch = "master") {

diff --git a/hawtio-web/src/main/webapp/app/wiki/js/wikiHelpers.ts b/hawtio-web/src/main/webapp/app/wiki/js/wikiHelpers.ts
@@ -104,6 +104,7 @@ module Wiki {
    * Returns a new create document wizard tree
    * @method createWizardTree
    * @for Wiki
+   * @static
    */
   export function createWizardTree() {
     var root = new Folder("New Documents");
@@ -235,6 +236,7 @@ module Wiki {
    * Returns the file name of the given path; stripping off any directories
    * @method fileName
    * @for Wiki
+   * @static
    * @param {String} path
    * @return {String}
    */
@@ -252,6 +254,7 @@ module Wiki {
    * Returns the folder of the given path (everything but the last path name)
    * @method fileParent
    * @for Wiki
+   * @static
    * @param {String} path
    * @return {String}
    */
@@ -270,6 +273,7 @@ module Wiki {
    * Returns the file name for the given name; we hide some extensions
    * @method hideFineNameExtensions
    * @for Wiki
+   * @static
    * @param {String} name
    * @return {String}
    */
@@ -288,6 +292,13 @@ module Wiki {
    * Takes a row containing the entity object; or can take the entity directly.
    *
    * It then uses the name, directory and xmlNamespaces properties
+   *
+   * @method fileIconHtml
+   * @for Wiki
+   * @static
+   * @param {any} row
+   * @return {String}
+   *
    */
   export function fileIconHtml(row) {
     var name = row.name;
@@ -355,6 +366,7 @@ module Wiki {
    * Extracts the pageId, branch, objectId from the route parameters
    * @method initScope
    * @for Wiki
+   * @static
    * @param {ng.IScope} $scope
    * @param {any} $routeParams
    * @param {ng.ILocationService} $location
@@ -371,6 +383,7 @@ module Wiki {
    * Extracts the pageId from the route parameters
    * @method pageId
    * @for Wiki
+   * @static
    * @param {any} $routeParams
    * @param @ng.ILocationService @location
    * @return {String}
@@ -426,6 +439,7 @@ module Wiki {
    * Parses the given JSON text reporting to the user if there is a parse error
    * @method parseJson
    * @for Wiki
+   * @static
    * @param {String} text
    * @return {any}
    */
@@ -444,6 +458,7 @@ module Wiki {
    * Adjusts a relative or absolute link from a wiki or file system to one using the hash bang syntax
    * @method adjustHref
    * @for Wiki
+   * @static
    * @param {ng.IScope} $scope
    * @param {ng.ILocationService} $location
    * @param {String} href