Couple JSDoc tweaks

hawtio · Nov 26, 2013 · d8e1f7d · d8e1f7d
1 parent a62c0e9
commit d8e1f7d
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/hawtio-web/src/main/webapp/app/branding/js/brandingPlugin.ts b/hawtio-web/src/main/webapp/app/branding/js/brandingPlugin.ts
@@ -5,8 +5,13 @@ module Core {
 
   /**
    * Ensure whatever value is passed in is converted to a boolean
-   * Added here because it's needed for the below stuff...
-   * @method
+   *
+   * In the branding module for now as it's needed before bootstrap
+   *
+   * @method parseBooleanValue
+   * @for Core
+   * @param {any} value
+   * @return {Boolean}
    */
   export function parseBooleanValue(value):boolean {
     if (!angular.isDefined(value)) {
@@ -39,7 +44,10 @@ module Core {
 }
 
 /**
+ * The Red Hat hawtio theme
+ *
  * @module Branding
+ * @main Branding
  */
 module Branding {
 

diff --git a/hawtio-web/src/main/webapp/app/dashboard/js/dashboardRepository.ts b/hawtio-web/src/main/webapp/app/dashboard/js/dashboardRepository.ts
@@ -122,6 +122,7 @@ module Dashboard {
    * dashboard repository
    *
    * @class DefaultDashboardRepository
+   * @uses DashboardRepository
    */
   export class DefaultDashboardRepository implements DashboardRepository {
     constructor(public workspace:Workspace, public jolokia, public localStorage) {
@@ -200,6 +201,7 @@ module Dashboard {
 
   /**
    * @class LocalDashboardRepository
+   * @uses DashboardRepository
    */
   export class LocalDashboardRepository implements DashboardRepository {
 
@@ -289,6 +291,7 @@ module Dashboard {
 
   /**
    * @class GitDashboardRepository
+   * @uses DashboardRepository
    */
   export class GitDashboardRepository implements DashboardRepository {
     constructor(public workspace:Workspace, public git:Git.GitRepository) {