Merge pull request #752 from denzelsN/master

Add jsdoc base code
This commit is contained in:
HyoJong
2015-07-21 13:39:23 +09:00
18 changed files with 148 additions and 16 deletions
@@ -1,9 +1,24 @@
/**
* @namespace
*/
(function() {
'use strict';
/**
* (en)문자열에 포함된 '.', '^', ':' 문자를 '_' 문자로 치환한다.
* @ko 문자열에 포함된 '.', '^', ':' 문자를 '_' 문자로 치환한다.
* @group Filter
* @name pinpointApp#applicationNameToClassName
* @method pinpointApp#applicationNameToCalssName
* @param {String} inputString
* @return {String} converted string
* @example
* ```
* expect( applicationNameToClassName("com.test.domain") ).toEqual( "com_test_domain" );
* ```
*/
angular.module('pinpointApp').filter('applicationNameToClassName', function () {
return function (input) {
return input.replace(/\./gi,'_').replace(/\^/gi,'_').replace(/:/gi, '_');
return input.replace( /[\.\^:]/gi, '_');
};
});
})();
@@ -1,6 +1,22 @@
/**
* @namespace
*/
(function() {
'use strict';
/**
* (en)icon의 URL 경로를 반환 함.
* @ko icon의 URL 경로를 반환 함.
* @group Filter
* @name pinpointApp#iconUrl
* @method pinpointApp#iconUrl
* @param {String} iconName
* @return {String} icon Url
* @example
* ```
* expect( iconUrl("TOMCAT") ).toEqual( "/images/icons/TOMCAT.png" );
* ```
*/
angular.module('pinpointApp').filter('iconUrl', function () {
return function(name) {
var imageUrl = "/images/icons/";
@@ -1,6 +1,13 @@
(function() {
'use strict';
/**
* (en)Agent의 Chart 정보를 로드하고 chart library에 사용할 수 있도록 데이터를 가공함.
* @ko Agent의 Chart 정보를 로드하고 chart library에 사용할 수 있도록 데이터를 가공함.
* @group Service
* @name AgentDaoService
* @class
*/
pinpointApp.constant('agentDaoServiceConfig', {
agentStatUrl: '/getAgentStat.pinpoint'
});
@@ -8,6 +15,13 @@
pinpointApp.service('AgentDaoService', [ 'agentDaoServiceConfig',
function AgentDaoService(cfg) {
/**
* (en)선택한 Agent의 Chart 정보를 로드함.
* @ko 선택한 Agent의 Chart 정보를 로드함.
* @method AgentDaoService#getAgentStat
* @param {String} query
* @param {Function} cb
*/
this.getAgentStat = function (query, cb) {
jQuery.ajax({
type: 'GET',
@@ -1,6 +1,12 @@
(function() {
'use strict';
/**
* (en)AlertsService
* @ko AlertsService.
* @group Service
* @name AlertsService
* @class
*/
pinpointApp.factory('AlertsService', ['$timeout', function ($timeout) {
return function (parent) {
@@ -1,6 +1,12 @@
(function() {
'use strict';
/**
* (en)filteredMapUtilService
* @ko filteredMapUtilService
* @group Service
* @name filteredMapUtilService
* @class
*/
pinpointApp.factory('filteredMapUtilService', [ 'filterConfig', 'ServerMapFilterVoService', '$window',
function (cfg, ServerMapFilterVoService, $window) {
// define private variables
@@ -1,6 +1,12 @@
(function() {
'use strict';
/**
* (en)helpContentService
* @ko helpContentService
* @group Service
* @name helpContentService
* @class
*/
pinpointApp.factory('helpContentService', [ '$window', '$injector', 'UserLocalesService', function($window, $injector, UserLocalesService) {
var name = "helpContent-" + UserLocalesService.userLocale;
@@ -1,6 +1,12 @@
(function() {
'use strict';
/**
* (en)isVisibleService
* @ko isVisibleService
* @group Service
* @name isVisibleService
* @class
*/
pinpointApp.factory('isVisibleService', function () {
/**
@@ -1,6 +1,12 @@
(function() {
'use strict';
/**
* (en)locationService
* @ko locationService
* @group Service
* @name locationService
* @class
*/
pinpointApp.factory('locationService', [ '$location', '$route', '$rootScope', function ($location, $route, $rootScope) {
$location.skipReload = function () {
var lastRoute = $route.current;
@@ -1,6 +1,12 @@
(function() {
'use strict';
/**
* (en)NavbarVoService
* @ko NavbarVoService
* @group Service
* @name NavbarVoService
* @class
*/
pinpointApp.factory('NavbarVoService', function () {
return function () {
// define and initialize private variables;
@@ -1,6 +1,12 @@
(function() {
'use strict';
/**
* (en)ProgressBarService
* @ko ProgressBarService
* @group Service
* @name ProgressBarService
* @class
*/
pinpointApp.factory('ProgressBarService', [ '$timeout', '$window', '$location', 'UserLocalesService', function ($timeout, $window, $location, UserLocalesService) {
var AVAILABLE_LOCALE = [ "ko", "en" ];
var TIP_MAX_COUNT = 5;
@@ -1,6 +1,12 @@
(function() {
'use strict';
/**
* (en)ServerMapDaoService
* @ko ServerMapDaoService
* @group Service
* @name ServerMapDaoService
* @class
*/
pinpointApp.constant('serverMapDaoServiceConfig', {
serverMapDataUrl: '/getServerMapData.pinpoint',
filteredServerMapDataUrl: '/getFilteredServerMapData.pinpoint',
@@ -1,6 +1,12 @@
(function() {
'use strict';
/**
* (en)ServerMapFilterVoService
* @ko ServerMapFilterVoService
* @group Service
* @name ServerMapFilterVoService
* @class
*/
pinpointApp.factory('ServerMapFilterVoService', [ function () {
return function ServerMapFilterVoService(dataSet) {
var self = this;
@@ -1,6 +1,12 @@
(function() {
'use strict';
/**
* (en)ServerMapHintVoService
* @ko ServerMapHintVoService
* @group Service
* @name ServerMapHintVoService
* @class
*/
pinpointApp.factory('ServerMapHintVoService', [function () {
return function ServerMapHintVo(dataSet) {
var self = this;
@@ -1,6 +1,12 @@
(function() {
'use strict';
/**
* (en)SidebarTitleVoService
* @ko SidebarTitleVoService
* @group Service
* @name SidebarTitleVoService
* @class
*/
pinpointApp.factory('SidebarTitleVoService', [ function () {
return function () {
var self = this;
@@ -1,6 +1,12 @@
(function() {
'use strict';
/**
* (en)TimeSliderVoService
* @ko TimeSliderVoService
* @group Service
* @name TimeSliderVoService
* @class
*/
pinpointApp.factory('TimeSliderVoService', function () {
return function () {
// define and initialize private variables;
@@ -1,6 +1,12 @@
(function() {
'use strict';
/**
* (en)TransactionDaoService
* @ko TransactionDaoService
* @group Service
* @name TransactionDaoService
* @class
*/
pinpointApp.constant('TransactionDaoServiceConfig', {
transactionInfoUrl: '/transactionInfo.pinpoint'
});
@@ -1,6 +1,12 @@
(function() {
'use strict';
/**
* (en)UserLocalesService
* @ko UserLocalesService
* @group Service
* @name UserLocalesService
* @class
*/
pinpointApp.factory("UserLocalesService", function( $window) {
var defaultLocale = "en";
// May not be the best way to get locale.
+3
View File
@@ -1,3 +1,6 @@
/**
* @namespace pinpointApp
*/
'use strict';
//nv.dev = false;