Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Fix up JSDoc for karaf, log, maven, jmx, jetty
  • Loading branch information
gashcrumb committed Nov 26, 2013
1 parent ed4ce89 commit c549643
Show file tree
Hide file tree
Showing 45 changed files with 235 additions and 15 deletions.
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/jetty/js/connectors.ts
@@ -1,3 +1,6 @@
/**
* @module Jetty
*/
module Jetty {

export function ConnectorsController($scope, $location, workspace:Workspace, jolokia) {
Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/jetty/js/jetty.ts
@@ -1,3 +1,6 @@
/**
* @module Jetty
*/
module Jetty {

export function JettyController($scope, $location, workspace:Workspace, jolokia) {
Expand Down
13 changes: 9 additions & 4 deletions hawtio-web/src/main/webapp/app/jetty/js/jettyHelpers.ts
@@ -1,3 +1,6 @@
/**
* @module Jetty
*/
module Jetty {

export function iconClass(state:string) {
Expand All @@ -14,9 +17,11 @@ module Jetty {

/**
* Returns true if the state of the item begins with the given state - or one of the given states
*
* @param item the item which has a State
* @param state a value or an array of states
* @method isState
* @for Jetty
* @param {any} item the item which has a State
* @param {any} state a value or an array of states
* @return {Boolean}
*/
export function isState(item, state) {
var value = (item.state || "").toLowerCase();
Expand All @@ -26,4 +31,4 @@ module Jetty {
return value.startsWith(state);
}
}
}
}
4 changes: 4 additions & 0 deletions hawtio-web/src/main/webapp/app/jetty/js/jettyPlugin.ts
@@ -1,3 +1,7 @@
/**
* @module Jetty
* @main Jetty
*/
module Jetty {
var pluginName = 'jetty';
angular.module(pluginName, ['bootstrap', 'ngResource', 'ui.bootstrap.dialog', 'hawtioCore']).
Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/jetty/js/tree.ts
@@ -1,3 +1,6 @@
/**
* @module Jetty
*/
module Jetty {

export function TreeController($scope, $location:ng.ILocationService, workspace:Workspace) {
Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/jmx/js/areaChart.ts
@@ -1,3 +1,6 @@
/**
* @module Jmx
*/
module Jmx {

export function AreaChartController($scope, $routeParams, jolokia, $templateCache, localStorage, $element) {
Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/jmx/js/attribute.ts
@@ -1,3 +1,6 @@
/**
* @module Jmx
*/
module Jmx {

export function AttributeController($scope, jolokia) {
Expand Down
5 changes: 4 additions & 1 deletion hawtio-web/src/main/webapp/app/jmx/js/attributes.ts
@@ -1,3 +1,6 @@
/**
* @module Jmx
*/
module Jmx {

export var propertiesColumnDefs = [
Expand Down Expand Up @@ -110,7 +113,7 @@ module Jmx {
$location.url(Jmx.createDashboardLink(type, widget));
};

/**
/*
* Returns the toolBar template HTML to use for the current selection
*/
$scope.toolBarTemplate = () => {
Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/jmx/js/attributesOld.ts
@@ -1,3 +1,6 @@
/**
* @module Jmx
*/
module Jmx {

export function AttributesOldController($scope, $routeParams, workspace:Workspace, $rootScope) {
Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/jmx/js/chartEdit.ts
@@ -1,3 +1,6 @@
/**
* @module Jmx
*/
module Jmx {
export function ChartEditController($scope, $location, workspace:Workspace, jolokia) {
$scope.selectedAttributes = [];
Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/jmx/js/charts.ts
@@ -1,3 +1,6 @@
/**
* @module Jmx
*/
module Jmx {
export function ChartController($scope, $element, $location, workspace:Workspace, localStorage, jolokiaUrl, jolokiaParams) {

Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/jmx/js/donutChart.ts
@@ -1,3 +1,6 @@
/**
* @module Jmx
*/
module Jmx {

export function DonutChartController($scope, $routeParams, jolokia, $templateCache) {
Expand Down
18 changes: 13 additions & 5 deletions hawtio-web/src/main/webapp/app/jmx/js/jmxHelpers.ts
@@ -1,3 +1,6 @@
/**
* @module Jmx
*/
module Jmx {

export var log:Logging.Logger = Logger.get("JMX");
Expand Down Expand Up @@ -43,10 +46,11 @@ module Jmx {

/**
* Registers a toolbar template for the given plugin name, jmxDomain.
*
* @param pluginName used so that we can later on remove this function when the plugin is removed
* @param jmxDomain the JMX domain to avoid having to evaluate too many functions on each selection
* @param fn the function used to decide which attributes tool bar should be used for the given select
* @method addAttributeToolBar
* @for Jmx
* @param {String} pluginName used so that we can later on remove this function when the plugin is removed
* @param {String} jmxDomain the JMX domain to avoid having to evaluate too many functions on each selection
* @param {Function} fn the function used to decide which attributes tool bar should be used for the given select
*/
export function addAttributeToolBar(pluginName: string, jmxDomain: string, fn: (NodeSelection) => string) {
var array = attributesToolBars[jmxDomain];
Expand All @@ -59,6 +63,10 @@ module Jmx {

/**
* Try find a custom toolbar HTML template for the given selection or returns the default value
* @method getAttributeToolbar
* @for Jmx
* @param {Core.NodeSelection} node
* @param {String} defaultValue
*/
export function getAttributeToolBar(node: NodeSelection, defaultValue: string = "app/jmx/html/attributeToolBar.html") {
var answer = null;
Expand Down Expand Up @@ -127,7 +135,7 @@ module Jmx {
if (treeElement.length) {
workspace.treeElement = treeElement;
treeElement.dynatree({
/**
/*
* The event handler called when a different node in the tree is selected
*/
onActivate: function (node:DynaTreeNode) {
Expand Down
4 changes: 4 additions & 0 deletions hawtio-web/src/main/webapp/app/jmx/js/jmxPlugin.ts
@@ -1,3 +1,7 @@
/**
* @module Jmx
* @main Jmx
*/
module Jmx {
var pluginName = 'jmx';

Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/jmx/js/mbeans.ts
@@ -1,3 +1,6 @@
/**
* @module Jmx
*/

module Jmx {
export function MBeansController($scope, $location: ng.ILocationService, workspace: Workspace) {
Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/jmx/js/operations.ts
@@ -1,3 +1,6 @@
/**
* @module Jmx
*/
module Jmx {

// IOperationControllerScope
Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/jmx/js/widgetRepository.ts
@@ -1,3 +1,6 @@
/**
* @module Jmx
*/
module Jmx {

export function createDashboardLink(widgetType, widget) {
Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/jvm/js/connect.ts
@@ -1,3 +1,6 @@
/**
* @module Jvm
*/
module JVM {
export function ConnectController($scope, $location, localStorage, workspace) {

Expand Down
8 changes: 8 additions & 0 deletions hawtio-web/src/main/webapp/app/jvm/js/jvmHelpers.ts
@@ -1,7 +1,15 @@
/**
* @module Jvm
*/
module JVM {

/**
* Adds common properties and functions to the scope
* @method configureScope
* @for Jvm
* @param {ng.IScope} $scope
* @param {ng.ILocationService} $location
* @param {Core.Workspace} workspace
*/
export function configureScope($scope, $location, workspace) {

Expand Down
4 changes: 4 additions & 0 deletions hawtio-web/src/main/webapp/app/jvm/js/jvmPlugin.ts
@@ -1,3 +1,7 @@
/**
* @module Jvm
* @main Jvm
*/
module Jvm {

var pluginName = 'jvm';
Expand Down
5 changes: 4 additions & 1 deletion hawtio-web/src/main/webapp/app/jvm/js/local.ts
@@ -1,4 +1,7 @@
module JVM {
/**
* @module Jvm
*/
module JVM {

export function JVMsController($scope, $window, $location, workspace, jolokia, mbeanName) {

Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/karaf/js/feature.ts
@@ -1,3 +1,6 @@
/**
* @module Karaf
*/
module Karaf {

export function FeatureController($scope, jolokia, workspace:Workspace, $routeParams) {
Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/karaf/js/features.ts
@@ -1,3 +1,6 @@
/**
* @module Karaf
*/
module Karaf {

export function FeaturesController($scope, $location, workspace, jolokia) {
Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/karaf/js/karafHelpers.ts
@@ -1,3 +1,6 @@
/**
* @module Karaf
*/
module Karaf {

export var log:Logging.Logger = Logger.get("Karaf");
Expand Down
4 changes: 4 additions & 0 deletions hawtio-web/src/main/webapp/app/karaf/js/karafPlugin.ts
@@ -1,3 +1,7 @@
/**
* @module Karaf
* @main Karaf
*/
module Karaf {
var pluginName = 'karaf';
angular.module(pluginName, ['bootstrap', 'ngResource', 'hawtioCore']).config(($routeProvider) => {
Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/karaf/js/navbar.ts
@@ -1,3 +1,6 @@
/**
* @module Karaf
*/
module Karaf {

export function NavBarController($scope, workspace:Workspace) {
Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/karaf/js/scr-component.ts
@@ -1,3 +1,6 @@
/**
* @module Karaf
*/
module Karaf {

export function ScrComponentController($scope, $location, workspace, jolokia, $routeParams) {
Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/karaf/js/scr-components.ts
@@ -1,3 +1,6 @@
/**
* @module Karaf
*/
module Karaf {

export function ScrComponentsController($scope, $location, workspace, jolokia) {
Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/karaf/js/server.ts
@@ -1,3 +1,6 @@
/**
* @module Karaf
*/
module Karaf {

export function ServerController($scope, $location, workspace:Workspace, jolokia) {
Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/log/js/logHelpers.ts
@@ -1,3 +1,6 @@
/**
* @module Log
*/
module Log {
export function logSourceHref(row) {
if (!row) {
Expand Down
4 changes: 4 additions & 0 deletions hawtio-web/src/main/webapp/app/log/js/logPlugin.ts
@@ -1,3 +1,7 @@
/**
* @module Log
* @main Log
*/
module Log {
var pluginName = 'log';
angular.module(pluginName, ['bootstrap', 'ngResource', 'ngGrid', 'datatable', 'hawtioCore']).
Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/log/js/logs.ts
@@ -1,3 +1,6 @@
/**
* @module Log
*/
module Log {
export interface ILog {
// TODO What is the point of seq?
Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/maven/js/artifact.ts
@@ -1,3 +1,6 @@
/**
* @module Maven
*/
module Maven {

export function ArtifactController($scope, $routeParams, workspace:Workspace, jolokia) {
Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/maven/js/dependencies.ts
@@ -1,3 +1,6 @@
/**
* @module Maven
*/
module Maven {

export function DependenciesController($scope, $routeParams, $location, workspace:Workspace, jolokia) {
Expand Down
7 changes: 7 additions & 0 deletions hawtio-web/src/main/webapp/app/maven/js/mavenHelpers.ts
@@ -1,9 +1,16 @@
/**
* @module Maven
*/
module Maven {

export var log:Logging.Logger = Logger.get("Maven");

/**
* Returns the maven indexer mbean (from the hawtio-maven-indexer library)
* @method getMavenIndexerMBean
* @for Maven
* @param {Core.Workspace} workspace
* @return {String}
*/
export function getMavenIndexerMBean(workspace:Workspace) {
if (workspace) {
Expand Down
4 changes: 4 additions & 0 deletions hawtio-web/src/main/webapp/app/maven/js/mavenPlugin.ts
@@ -1,3 +1,7 @@
/**
* @module Maven
* @main Maven
*/
module Maven {
var pluginName = 'maven';
angular.module(pluginName, ['bootstrap', 'ngResource', 'datatable', 'tree', 'hawtioCore', 'hawtio-ui']).
Expand Down
5 changes: 4 additions & 1 deletion hawtio-web/src/main/webapp/app/maven/js/pom.ts
@@ -1,3 +1,6 @@
/**
* @module Maven
*/
module Maven {

export function PomXmlController($scope) {
Expand All @@ -12,4 +15,4 @@ module Maven {
return text || "";
}
}
}
}
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/maven/js/search.ts
@@ -1,3 +1,6 @@
/**
* @module Maven
*/
module Maven {

export function SearchController($scope, $location, workspace:Workspace, jolokia) {
Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/maven/js/test.ts
@@ -1,3 +1,6 @@
/**
* @module Maven
*/
module Maven {
export function TestController($scope, workspace, jolokia, $q, $templateCache) {

Expand Down
3 changes: 3 additions & 0 deletions hawtio-web/src/main/webapp/app/maven/js/versions.ts
@@ -1,3 +1,6 @@
/**
* @module Maven
*/
module Maven {

export function VersionsController($scope, $routeParams, workspace:Workspace, jolokia) {
Expand Down
5 changes: 4 additions & 1 deletion hawtio-web/src/main/webapp/app/maven/js/view.ts
@@ -1,3 +1,6 @@
/**
* @module Maven
*/
module Maven {

export function ViewController($scope, $location, workspace:Workspace, jolokia) {
Expand All @@ -15,4 +18,4 @@ module Maven {
function loadData() {
}
}
}
}

0 comments on commit c549643

Please sign in to comment.