adding ngdocs site for tower doc site

awx/ui/static/js/controllers/Admins.js

@@ -1,13 +1,22 @@
 /************************************
  * Copyright (c) 2014 AnsibleWorks, Inc.
  *
+ */
+ /**
+ * @ngdoc overview
+ * @name controllers
+ * @description These are all the controllers that are used throughout the application
  *
+*/
+/**
+ * @ngdoc function
+ * @name controllers.function:Admins
+ * @description This controller's for administrators
  *  Admins.js
  *
  *  Controller functions for ading Admins to an Organization.
  *
- */
-
+*/
 'use strict';
 
 function AdminsList($scope, $rootScope, $location, $log, $routeParams, Rest, Alert, AdminList, GenerateList, LoadBreadCrumbs,

awx/ui/static/js/controllers/Authentication.js

@@ -7,7 +7,11 @@
  *  Controller functions for user authentication.
  *
  */
-
+/**
+ * @ngdoc function
+ * @name controllers.function:Authentication
+ * @description This controller's for authenticating users
+*/
 'use strict';
 
 function Authenticate($log, $cookieStore, $compile, $window, $scope, $rootScope, $location, Authorization, ToggleClass, Alert, Wait,

awx/ui/static/js/controllers/Credentials.js

@@ -6,7 +6,11 @@
  *  Controller functions for the Credential model.
  *
  */
-
+/**
+ * @ngdoc function
+ * @name controllers.function:Credentials
+ * @description This controller's for the credentials page
+*/
 'use strict';
 
 function CredentialsList($scope, $rootScope, $location, $log, $routeParams, Rest, Alert, CredentialList,

awx/ui/static/js/controllers/Home.js

@@ -8,8 +8,23 @@
  *
  */
 
+
+/**
+ * @ngdoc function
+ * @name controllers.function:Home
+ * @description This controller's for the dashboard
+*/
 'use strict';
 
+/**
+ * @ngdoc method
+ * @name controllers.function:Home#Home
+ * @methodOf controllers.function:Home
+ * @description this function loads all the widgets on the dashboard.
+ *  dashboardReady (emit) - this is called when the preliminary parts of the dashboard have been loaded, and loads each of the widgets. Note that the
+ *                  Host count graph should only be loaded if the user is a super user
+ *
+*/
 function Home($scope, $compile, $routeParams, $rootScope, $location, Wait, DashboardCounts, HostGraph, JobStatusGraph, HostPieChart, DashboardJobs,
     ClearScope, Stream, Rest, GetBasePath, ProcessErrors, Button){
 
@@ -77,6 +92,8 @@ function Home($scope, $compile, $routeParams, $rootScope, $location, Wait, Dashb
         }
     });
 
+
+
     if ($scope.removeDashboardReady) {
         $scope.removeDashboardReady();
     }
@@ -162,6 +179,13 @@ Home.$inject = ['$scope', '$compile', '$routeParams', '$rootScope', '$location',
 ];
 
 
+/**
+ * @ngdoc method
+ * @name controllers.function:Home#HomeGroups
+ * @methodOf controllers.function:Home
+ * @description This controls the 'home/groups' page that is loaded from the dashboard
+ *
+*/
 function HomeGroups($log, $scope, $filter, $compile, $location, $routeParams, LogViewer, HomeGroupList, GenerateList, ProcessErrors, LoadBreadCrumbs, ReturnToCaller, ClearScope,
     GetBasePath, SearchInit, PaginateInit, FormatDate, GetHostsStatusMsg, GetSyncStatusMsg, ViewUpdateStatus, Stream, GroupsEdit, Wait,
     Alert, Rest, Empty, InventoryUpdate, Find, GroupsCancelUpdate, Store, Socket) {
@@ -594,7 +618,13 @@ HomeGroups.$inject = ['$log', '$scope', '$filter', '$compile', '$location', '$ro
     'Stream', 'GroupsEdit', 'Wait', 'Alert', 'Rest', 'Empty', 'InventoryUpdate', 'Find', 'GroupsCancelUpdate', 'Store', 'Socket'
 ];
 
-
+/**
+ * @ngdoc method
+ * @name controllers.function:Home#HomeHosts
+ * @methodOf controllers.function:Home
+ * @description This loads the page for 'home/hosts'
+ *
+*/
 function HomeHosts($scope, $location, $routeParams, HomeHostList, GenerateList, ProcessErrors, LoadBreadCrumbs, ReturnToCaller, ClearScope,
     GetBasePath, SearchInit, PaginateInit, FormatDate, SetStatus, ToggleHostEnabled, HostsEdit, Stream, Find, ShowJobSummary, ViewJob) {
 

awx/ui/static/js/controllers/Inventories.js

@@ -7,7 +7,11 @@
  *  Controller functions for the Inventory model.
  *
  */
-
+/**
+ * @ngdoc function
+ * @name controllers.function:Inventories
+ * @description This controller's for the Inventory page
+*/
 'use strict';
 
 function InventoriesList($scope, $rootScope, $location, $log, $routeParams, $compile, $filter, Rest, Alert, InventoryList, GenerateList,

awx/ui/static/js/controllers/JobDetail.js

@@ -4,7 +4,11 @@
  *  JobDetail.js
  *
  */
-
+/**
+ * @ngdoc function
+ * @name controllers.function:JobDetail
+ * @description This controller's for the Job Detail Page
+*/
 'use strict';
 
 function JobDetailController ($location, $rootScope, $scope, $compile, $routeParams, $log, ClearScope, Breadcrumbs, LoadBreadCrumbs, GetBasePath, Wait, Rest,

awx/ui/static/js/controllers/JobEvents.js

@@ -7,15 +7,19 @@
  *  Controller functions for the Job Events model.
  *
  */
-
+/**
+ * @ngdoc function
+ * @name controllers.function:JobEvent
+ * @description This controller's for the job event page
+*/
 'use strict';
 
 function JobEventsList($sce, $filter, $scope, $rootScope, $location, $log, $routeParams, Rest, Alert, JobEventList, GenerateList,
     LoadBreadCrumbs, Prompt, SearchInit, PaginateInit, ReturnToCaller, ClearScope, ProcessErrors, GetBasePath, LookUpInit, ToggleChildren,
     FormatDate, EventView, Refresh, Wait) {
-    
+
     ClearScope();
-    
+
     var list = JobEventList,
         defaultUrl = GetBasePath('jobs') + $routeParams.id + '/job_events/', //?parent__isnull=1';
         generator = GenerateList,
@@ -44,7 +48,7 @@ function JobEventsList($sce, $filter, $scope, $rootScope, $location, $log, $rout
 
     function formatJSON(eventData) {
         //turn JSON event data into an html form
-        
+
         var i, n, rows, fld, txt,
             html = '',
             found = false;
@@ -125,9 +129,9 @@ function JobEventsList($sce, $filter, $scope, $rootScope, $location, $log, $rout
     }
     $scope.removePostRefresh = $scope.$on('PostRefresh', function () {
         // Initialize the parent levels
-        
+
         generator.inject(list, { mode: 'edit', scope: $scope });
-        
+
         var set = $scope[list.name], i;
         for (i = 0; i < set.length; i++) {
             set[i].event_display = set[i].event_display.replace(/^\u00a0*/g, '');
@@ -207,7 +211,7 @@ function JobEventsList($sce, $filter, $scope, $rootScope, $location, $log, $rout
     });
 
     page = ($routeParams.page) ? parseInt($routeParams.page,10) - 1 : null;
-    
+
     PaginateInit({
         scope: $scope,
         list: list,
@@ -258,13 +262,13 @@ JobEventsList.$inject = ['$sce', '$filter', '$scope', '$rootScope', '$location',
 
 function JobEventsEdit($scope, $rootScope, $compile, $location, $log, $routeParams, JobEventsForm, GenerateForm,
     Rest, Alert, ProcessErrors, LoadBreadCrumbs, ClearScope, GetBasePath, FormatDate, EventView, Wait) {
-    
+
     ClearScope();
 
     var form = JobEventsForm,
         generator = GenerateForm,
         defaultUrl = GetBasePath('base') + 'job_events/' + $routeParams.event_id + '/';
-    
+
     generator.inject(form, { mode: 'edit', related: true, scope: $scope});
     generator.reset();
 

awx/ui/static/js/controllers/JobHosts.js

@@ -7,20 +7,24 @@
  *  Controller functions for the Job Hosts Summary model.
  *
  */
-
+/**
+ * @ngdoc function
+ * @name controllers.function:JobHosts
+ * @description This controller's for the job hosts page
+*/
 'use strict';
 
 function JobHostSummaryList($scope, $rootScope, $location, $log, $routeParams, Rest, Alert, JobHostList, GenerateList,
     LoadBreadCrumbs, Prompt, SearchInit, PaginateInit, ReturnToCaller, ClearScope, ProcessErrors, GetBasePath, Refresh,
     JobStatusToolTip) {
-    
+
     ClearScope();
-    
+
     var list = JobHostList,
         defaultUrl = GetBasePath('jobs') + $routeParams.id + '/job_host_summaries/',
         view = GenerateList,
         inventory;
-        
+
     $scope.job_id = $routeParams.id;
     $scope.host_id = null;
 
@@ -56,7 +60,7 @@ function JobHostSummaryList($scope, $rootScope, $location, $log, $routeParams, R
     }
     $scope.removeJobReady = $scope.$on('JobReady', function() {
         view.inject(list, { mode: 'edit', scope: $scope });
-        
+
         SearchInit({
             scope: $scope,
             set: 'jobhosts',

awx/ui/static/js/controllers/JobStdout.js

@@ -4,7 +4,11 @@
  *  JobStdout.js
  *
  */
-
+/**
+ * @ngdoc function
+ * @name controllers.function:JobStdout
+ * @description This controller's for the standard out page that can be displayed when a job runs
+*/
 'use strict';
 
 function JobStdoutController ($log, $rootScope, $scope, $compile, $routeParams, ClearScope, GetBasePath, Wait, Rest, ProcessErrors, Socket) {

awx/ui/static/js/controllers/JobTemplates.js

@@ -7,7 +7,11 @@
  *  Controller functions for the Job Template model.
  *
  */
-
+/**
+ * @ngdoc function
+ * @name controllers.function:JobTemplate
+ * @description This controller's for the Job Template page
+*/
 'use strict';
 
 function JobTemplatesList($scope, $rootScope, $location, $log, $routeParams, Rest, Alert, JobTemplateList,

awx/ui/static/js/controllers/Jobs.js

@@ -7,7 +7,11 @@
  *  Controller functions for the Inventory model.
  *
  */
-
+/**
+ * @ngdoc function
+ * @name controllers.function:Jobs
+ * @description This controller's for the jobs page
+*/
 'use strict';
 
 function JobsListController ($rootScope, $log, $scope, $compile, $routeParams, ClearScope, Breadcrumbs, LoadBreadCrumbs, LoadSchedulesScope,

awx/ui/static/js/controllers/Organizations.js

@@ -7,7 +7,11 @@
  *  Controller functions for Organization model.
  *
  */
-
+/**
+ * @ngdoc function
+ * @name controllers.function:Organizations
+ * @description This controller's for the Organizations page
+*/
 'use strict';
 
 function OrganizationsList($routeParams, $scope, $rootScope, $location, $log, Rest, Alert, LoadBreadCrumbs, Prompt,

awx/ui/static/js/controllers/Permissions.js

@@ -7,7 +7,11 @@
  *  Controller functions for Permissions model.
  *
  */
-
+/**
+ * @ngdoc function
+ * @name controllers.function:Permissions
+ * @description This controller's for permissions
+*/
 'use strict';
 
 function PermissionsList($scope, $rootScope, $location, $log, $routeParams, Rest, Alert, PermissionList,

awx/ui/static/js/controllers/Projects.js

@@ -7,7 +7,11 @@
  *  Controller functions for the Projects model.
  *
  */
-
+/**
+ * @ngdoc function
+ * @name controllers.function:Projects
+ * @description This controller's for the projects page
+*/
 'use strict';
 
 function ProjectsList ($scope, $rootScope, $location, $log, $routeParams, Rest, Alert, ProjectList, GenerateList, LoadBreadCrumbs,

awx/ui/static/js/controllers/Schedules.js

@@ -7,7 +7,11 @@
  *  Controller functions for the Schedule model.
  *
  */
-
+/**
+ * @ngdoc function
+ * @name controllers.function:Schedules
+ * @description This controller's for schedules
+*/
 'use strict';
 
 function ScheduleEditController($scope, $compile, $location, $routeParams, SchedulesList, Rest, ProcessErrors, LoadBreadCrumbs, ReturnToCaller, ClearScope,

awx/ui/static/js/controllers/Sockets.js

@@ -5,7 +5,12 @@
 *  SocketsController- simple test of socket connection
 *
 */
-
+/**
+ * @ngdoc function
+ * @name controllers.function:Sockets
+ * @description This controller's for controlling websockets
+ * discuss
+*/
 'use strict';
 
 function SocketsController ($scope, $compile, ClearScope, Socket) {

awx/ui/static/js/controllers/Teams.js

@@ -7,7 +7,11 @@
  *  Controller functions for the Team model.
  *
  */
-
+/**
+ * @ngdoc function
+ * @name controllers.function:Teams
+ * @description This controller's for teams
+*/
 'use strict';
 
 function TeamsList($scope, $rootScope, $location, $log, $routeParams, Rest, Alert, TeamList, GenerateList, LoadBreadCrumbs,

awx/ui/static/js/controllers/Users.js

@@ -6,7 +6,11 @@
  *  Controller functions for User model.
  *
  */
-
+/**
+ * @ngdoc function
+ * @name controllers.function:Users
+ * @description This controller's the Users page
+*/
 'use strict';
 
 function UsersList($scope, $rootScope, $location, $log, $routeParams, Rest, Alert, UserList, GenerateList, LoadBreadCrumbs,

awx/ui/static/js/forms/ActivityDetail.js

@@ -3,8 +3,19 @@
  *
  *  ActivityDetail.js
  *  Form definition for Activity Stream detail
- *  
+ *
  */
+ /**
+ * @ngdoc overview
+ * @name forms
+ * @description These are all the controllers that are used throughout the application
+ *
+*/
+/**
+ * @ngdoc function
+ * @name forms.function:ActivityDetail
+ * @description This form is for activity detail modal that can be shown on most pages.
+*/
 angular.module('ActivityDetailDefinition', [])
     .value('ActivityDetailForm', {
 
@@ -33,5 +44,5 @@ angular.module('ActivityDetailDefinition', [])
                 readonly: true
             }
         }
-    
+
     }); //Form

awx/ui/static/js/forms/Credentials.js

@@ -5,6 +5,11 @@
  *  Form definition for Credential model
  *
  */
+ /**
+ * @ngdoc function
+ * @name forms.function:Credentials
+ * @description This form is for adding/editing a Credential
+*/
 angular.module('CredentialFormDefinition', [])
     .value('CredentialForm', {
 

awx/ui/static/js/forms/EventsViewer.js

@@ -4,6 +4,11 @@
  *  JobEventsForm.js
  *
  */
+ /**
+ * @ngdoc function
+ * @name forms.function:EventsViewer
+ * @description This form is for events on the job detail page
+*/
 angular.module('EventsViewerFormDefinition', [])
     .value('EventsViewerForm', {
 

awx/ui/static/js/forms/Groups.js

@@ -6,6 +6,11 @@
  *
  *
  */
+ /**
+ * @ngdoc function
+ * @name forms.function:Groups
+ * @description This form is for adding/editing a Group on the inventory page
+*/
 angular.module('GroupFormDefinition', [])
     .value('GroupForm', {
 
@@ -15,7 +20,7 @@ angular.module('GroupFormDefinition', [])
         cancelButton: false,
         name: 'group',
         well: false,
-        
+
         fields: {
             name: {
                 label: 'Name',

awx/ui/static/js/forms/HostGroups.js

@@ -4,11 +4,16 @@
  *  HostGroups.js
  *  Form definition for Host model
  *
- *  
+ *
  */
+ /**
+ * @ngdoc function
+ * @name forms.function:HostGroups
+ * @description This form is for groups of hosts on the inventory page
+*/
 angular.module('HostGroupsFormDefinition', [])
     .value('HostGroupsForm', {
-        
+
         editTitle: 'Host Groups',
         name: 'host',
         well: false,
@@ -35,7 +40,7 @@ angular.module('HostGroupsFormDefinition', [])
             }
         },
 
-        buttons: { //for now always generates <button> tags 
+        buttons: { //for now always generates <button> tags
             save: {
                 ngClick: 'formSave()',
                 ngDisabled: true

awx/ui/static/js/forms/Hosts.js

@@ -6,6 +6,11 @@
  *
  *
  */
+ /**
+ * @ngdoc function
+ * @name forms.function:Hosts
+ * @description This form is for adding/editing a host on the inventory page
+*/
 angular.module('HostFormDefinition', [])
     .value('HostForm', {
 
@@ -77,7 +82,7 @@ angular.module('HostFormDefinition', [])
             }
         },
 
-        buttons: { //for now always generates <button> tags 
+        buttons: { //for now always generates <button> tags
            /*
             save: {
                 ngClick: 'formSave()', //$scope.function to call on click, optional

awx/ui/static/js/forms/Inventories.js

@@ -6,6 +6,11 @@
  *
  *
  */
+ /**
+ * @ngdoc function
+ * @name forms.function:Inventories
+ * @description This form is for adding/editing an inventory
+*/
 angular.module('InventoryFormDefinition', [])
     .value('InventoryForm', {
 

awx/ui/static/js/forms/InventoryStatus.js

@@ -4,11 +4,16 @@
  *  InventoryStatus.js
  *
  *  Use to show inventory sync status
- *  
+ *
  */
+ /**
+ * @ngdoc function
+ * @name forms.function:InventoryStatus
+ * @description This form is for adding/editing an InventoryStatus
+*/
 angular.module('InventoryStatusDefinition', [])
     .value('InventoryStatusForm', {
-    
+
         name: 'inventory_update',
         editTitle: 'Inventory Status',
         well: false,

awx/ui/static/js/forms/JobEventData.js

@@ -4,11 +4,16 @@
  *  JobEventData.js
  *  Form definition for Job Events -JSON view
  *
- *  
+ *
  */
+ /**
+ * @ngdoc function
+ * @name forms.function:JobEventData
+ * @description Not sure if this is used...
+*/
 angular.module('JobEventDataDefinition', [])
     .value('JobEventDataForm', {
-        
+
         editTitle: '{{ id }} - {{ event_display }}',
         name: 'job_events',
         well: false,
@@ -23,5 +28,5 @@ angular.module('JobEventDataDefinition', [])
                 'class': 'modal-input-xxlarge'
             }
         }
-            
+
     }); //Form

awx/ui/static/js/forms/JobSummary.js

@@ -6,13 +6,19 @@
  *  Display job status info in a dialog
  *
  */
+ /**
+ * @ngdoc function
+ * @name forms.function:JobSummary
+ * @description Display job status info in a dialog
+*/
+
 angular.module('JobSummaryDefinition', [])
     .value('JobSummary', {
-        
+
         editTitle: '{{ id }} - {{ name }}',
         name: 'jobs',
         well: false,
-        
+
         fields: {
             status: {
                 //label: 'Job Status',

awx/ui/static/js/forms/JobTemplates.js

@@ -7,7 +7,11 @@
  *  To get the JobTemplateForm object: JobTemplateForm();
  *
  */
-
+/**
+ * @ngdoc function
+ * @name forms.function:JobTemplate
+ * @description This form is for adding/editing a Job Template
+*/
 'use strict';
 
 angular.module('JobTemplateFormDefinition', ['SchedulesListDefinition', 'CompletedJobsDefinition'])

awx/ui/static/js/forms/JobVarsPrompt.js

@@ -2,22 +2,26 @@
  *  Copyright (c) 2014 AnsibleWorks, Inc.
  *
  *  JobVarsPrompt.js
- *  
- *  Form definition used during job submission to prompt for extra vars 
- *  
+ *
+ *  Form definition used during job submission to prompt for extra vars
+ *
  */
-
+/**
+ * @ngdoc function
+ * @name forms.function:JobVarsPrompt
+ * @description This form is for job variables prompt modal
+*/
 'use strict';
 
 angular.module('JobVarsPromptFormDefinition', [])
-    
+
     .value ('JobVarsPromptForm', {
 
         addTitle: '',
         editTitle: '',
         name: 'job',
         well: false,
-        
+
         actions: { },
 
         fields: {

awx/ui/static/js/forms/Jobs.js

@@ -6,6 +6,11 @@
  *
  *  @dict
  */
+ /**
+ * @ngdoc function
+ * @name forms.function:Jobs
+ * @description This form is for adding/editing a Job
+*/
 angular.module('JobFormDefinition', [])
     .value('JobForm', {
 
@@ -18,7 +23,7 @@ angular.module('JobFormDefinition', [])
         collapseMode: 'edit',
         collapseTitle: 'Job Status',
         collapseOpenFirst: true,   //Always open first panel
-        
+
         navigationLinks: {
             details: {
                 href: "/#/jobs/{{ job_id }}",
@@ -105,7 +110,7 @@ angular.module('JobFormDefinition', [])
                 iterator: 'job',
                 index: false,
                 open: false,
-                
+
                 fields: { }
             }
         }

awx/ui/static/js/forms/LicenseForm.js

@@ -5,7 +5,11 @@
  *
  *
  */
-
+/**
+ * @ngdoc function
+ * @name forms.function:LicenseForm
+ * @description This form is for viewing the license information
+*/
 'use strict';
 
 angular.module('LicenseFormDefinition', [])

awx/ui/static/js/forms/LicenseUpdate.js

@@ -6,6 +6,11 @@
  *
  *
  */
+ /**
+ * @ngdoc function
+ * @name forms.function:LicenseUpdate
+ * @description This form is for updating a license
+*/
 angular.module('LicenseUpdateFormDefinition', [])
     .value('LicenseUpdateForm', {
 

awx/ui/static/js/forms/LogViewerOptions.js

@@ -6,12 +6,17 @@
  *  Form definition for LogViewer.js helper
  *
  */
+ /**
+ * @ngdoc function
+ * @name forms.function:LogViewerOptions
+ * @description This form is for the page to view logs
+*/
 angular.module('LogViewerOptionsDefinition', [])
     .value('LogViewerOptionsForm', {
 
         name: 'status',
         well: false,
-        
+
         fields: {
             "job_template": {
                 label: "Job Template",

awx/ui/static/js/forms/LogViewerStatus.js

@@ -6,12 +6,17 @@
  *  Form definition for LogViewer.js helper
  *
  */
+ /**
+ * @ngdoc function
+ * @name forms.function:LogViewerStatus
+ * @description Form definition for LogViewer.js helper
+*/
 angular.module('LogViewerStatusDefinition', [])
     .value('LogViewerStatusForm', {
 
         name: 'status',
         well: false,
-        
+
         fields: {
             "name": {
                 label: "Name",
@@ -51,5 +56,5 @@ angular.module('LogViewerStatusDefinition', [])
                 readonly: true
             }
         }
-        
+
     });

awx/ui/static/js/forms/Organizations.js

@@ -6,6 +6,11 @@
  *
  *
  */
+ /**
+ * @ngdoc function
+ * @name forms.function:Organizations
+ * @description This form is for adding/editing an organization
+*/
 angular.module('OrganizationFormDefinition', [])
     .value('OrganizationForm', {
 
@@ -46,7 +51,7 @@ angular.module('OrganizationFormDefinition', [])
             }
         },
 
-        buttons: { //for now always generates <button> tags 
+        buttons: { //for now always generates <button> tags
             save: {
                 ngClick: 'formSave()', //$scope.function to call on click, optional
                 ngDisabled: true //Disable when $pristine or $invalid, optional

awx/ui/static/js/forms/Permissions.js

@@ -7,6 +7,11 @@
  *
  *
  */
+ /**
+ * @ngdoc function
+ * @name forms.function:Permissions
+ * @description This form is for adding/editing persmissions
+*/
 angular.module('PermissionFormDefinition', [])
     .value('PermissionsForm', {
 

awx/ui/static/js/forms/ProjectStatus.js

@@ -4,11 +4,16 @@
  *  ProjectStatus.js
  *  Form definition for Project Status -JSON view
  *
- *  
+ *
  */
+  /**
+ * @ngdoc function
+ * @name forms.function:ProjectStatus
+ * @description This form is for adding/editing project status
+*/
 angular.module('ProjectStatusDefinition', [])
     .value('ProjectStatusForm', {
-    
+
         name: 'project_update',
         editTitle: 'SCM Status',
         well: false,

awx/ui/static/js/forms/Projects.js

@@ -7,6 +7,11 @@
  *
  *
  */
+  /**
+ * @ngdoc function
+ * @name forms.function:Projects
+ * @description This form is for adding/editing projects
+*/
 angular.module('ProjectFormDefinition', ['SchedulesListDefinition'])
     .value('ProjectsFormObject', {
 

awx/ui/static/js/forms/Source.js

@@ -6,6 +6,11 @@
  *
  *
  */
+  /**
+ * @ngdoc function
+ * @name forms.function:Source
+ * @description This form is for group model
+*/
 angular.module('SourceFormDefinition', [])
     .value('SourceForm', {
 

awx/ui/static/js/forms/Teams.js

@@ -6,6 +6,11 @@
  *  Form definition for Team model
  *
  */
+  /**
+ * @ngdoc function
+ * @name forms.function:Teams
+ * @description This form is for adding/editing teams
+*/
 angular.module('TeamFormDefinition', [])
     .value('TeamForm', {
 

awx/ui/static/js/forms/Users.js

@@ -6,6 +6,11 @@
  *
  *
  */
+  /**
+ * @ngdoc function
+ * @name forms.function:Users
+ * @description This form is for adding/editing users
+*/
 angular.module('UserFormDefinition', [])
     .value('UserForm', {
 

awx/ui/static/js/help/ChromeSocketHelp.js

@@ -7,6 +7,17 @@
  *
  */
 
+  /**
+ * @ngdoc overview
+ * @name help
+ * @description These are the modal windows that are shown to the user to give additional guidance on certain tasks that might not be straightforward.
+*/
+
+ /**
+ * @ngdoc function
+ * @name help.function:ChromeSocketHelp
+ * @description This help modal gives instructions on what the user should do if not connected to the web sockets while using Chrome.
+*/
 'use strict';
 
 angular.module('ChromeSocketHelpDefinition', [])

awx/ui/static/js/help/FirefoxSocketHelp.js

@@ -6,7 +6,11 @@
  *  Help object for socket connection troubleshooting
  *
  */
-
+ /**
+ * @ngdoc function
+ * @name help.function:FirefoxSocketHelp
+ * @description This help modal gives instructions on what the user should do if not connected to the web sockets while using Firefox.
+*/
 'use strict';
 
 angular.module('FFSocketHelpDefinition', [])

awx/ui/static/js/help/InventoryGroups.js

@@ -7,7 +7,11 @@
  *
  *  @dict
  */
-
+ /**
+ * @ngdoc function
+ * @name help.function:InventoryGroups
+ * @description This help modal walks the user how to add groups to an inventory or a subgroup to an existing group.
+*/
 'use strict';
 
 angular.module('InventoryGroupsHelpDefinition', [])

awx/ui/static/js/help/SafariSocketHelp.js

@@ -6,7 +6,11 @@
  *  Help object for socket connection troubleshooting
  *
  */
-
+ /**
+ * @ngdoc function
+ * @name help.function:SafariSocketHelp
+ * @description This help modal gives instructions on what the user should do if not connected to the web sockets while using Safari. Safari does not support websockets.
+*/
 'use strict';
 
 angular.module('SafariSocketHelpDefinition', [])

awx/ui/static/js/helpers/AboutAnsible.js

@@ -1,12 +1,21 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
  *
- * Dashboard.js
+ * aboutansible.js
  *
- * The new dashboard
+ * The new about menu
  *
  */
-
+  /**
+ * @ngdoc overview
+ * @name helpers
+ * @description These are helpers...figure it out :)
+*/
+ /**
+ * @ngdoc function
+ * @name helpers.function:AboutAnsible
+ * @description This is the code for the About Ansible modal window that pops up with cowsay giving company/tower info and copyright information.
+*/
 'use strict';
 
 angular.module('AboutAnsibleHelpModal', ['RestServices', 'Utilities','ModalDialog'])

awx/ui/static/js/helpers/Access.js

@@ -6,6 +6,11 @@
  *  Routines for checking user access
  *
  */
+  /**
+ * @ngdoc function
+ * @name helpers.function:Access
+ * @description  routines checking user access
+*/
 
 'use strict';
 

awx/ui/static/js/helpers/Children.js

@@ -3,12 +3,14 @@
  *
  *  ChildrenHelper
  *
- *  Used in job_events to expand/collapse children by setting the
+ */
+ /**
+ * @ngdoc function
+ * @name helpers.function:Children
+ * @descriptionUsed in job_events to expand/collapse children by setting the
  *  'show' attribute of each job_event in the set of job_events.
  *  See the filter in job_events.js list.
- *
- */
-
+*/
 'use strict';
 
 angular.module('ChildrenHelper', ['RestServices', 'Utilities'])
@@ -93,7 +95,7 @@ angular.module('ChildrenHelper', ['RestServices', 'Utilities'])
                 }
                 return true;
             });
-            
+
             // Expand or collapse children based on clicked element's icon
             if (/plus-square-o/.test(set[clicked].ngicon)) {
                 // Expand: lookup and display children

awx/ui/static/js/helpers/Credentials.js

@@ -3,10 +3,13 @@
  *
  *  Credentials.js
  *
- *  Functions shared amongst Credential related controllers
  *
  */
-
+  /**
+ * @ngdoc function
+ * @name helpers.function:Credentials
+ * @description   Functions shared amongst Credential related controllers
+*/
 'use strict';
 
 angular.module('CredentialsHelper', ['Utilities'])

awx/ui/static/js/helpers/EventViewer.js

@@ -4,7 +4,11 @@
  *  EventsViewer.js
  *
  */
-
+   /**
+ * @ngdoc function
+ * @name helpers.function:EventViewer
+ * @description eventviewerhelper
+*/
 'use strict';
 
 angular.module('EventViewerHelper', ['ModalDialog', 'Utilities', 'EventsViewerFormDefinition', 'HostsHelper'])

awx/ui/static/js/helpers/Events.js

@@ -3,14 +3,18 @@
  *
  *  EventsHelper
  *
- *  EventView - show the job_events form in a modal dialog
+ *
  *
  */
- 
+   /**
+ * @ngdoc function
+ * @name helpers.function:Events
+ * @description    EventView - show the job_events form in a modal dialog
+*/
 'use strict';
 
 angular.module('EventsHelper', ['RestServices', 'Utilities', 'JobEventDataDefinition', 'JobEventsFormDefinition'])
-    
+
     .factory('EventView', ['$rootScope', '$location', '$log', '$routeParams', 'Rest', 'Alert', 'GenerateForm',
         'Prompt', 'ProcessErrors', 'GetBasePath', 'FormatDate', 'JobEventDataForm', 'Empty', 'JobEventsForm',
         function ($rootScope, $location, $log, $routeParams, Rest, Alert, GenerateForm, Prompt, ProcessErrors, GetBasePath,

awx/ui/static/js/helpers/Groups.js

@@ -6,7 +6,11 @@
  *  Routines that handle group add/edit/delete on the Inventory tree widget.
  *
  */
-
+   /**
+ * @ngdoc function
+ * @name helpers.function:Groups
+ * @description    inventory tree widget add/edit/delete
+*/
 'use strict';
 
 angular.module('GroupsHelper', [ 'RestServices', 'Utilities', 'ListGenerator', 'GroupListDefinition', 'SearchHelper',

awx/ui/static/js/helpers/HostEventsViewer.js

@@ -6,7 +6,11 @@
  *  View a list of events for a given job and host
  *
  */
-
+   /**
+ * @ngdoc function
+ * @name helpers.function:HostEventsViewer
+ * @description   view a list of events for a given job and host
+*/
 'use strict';
 
 angular.module('HostEventsViewerHelper', ['ModalDialog', 'Utilities', 'EventViewerHelper'])

awx/ui/static/js/helpers/Hosts.js

@@ -8,6 +8,11 @@
  */
 
 /* jshint loopfunc: true */
+   /**
+ * @ngdoc function
+ * @name helpers.function:Hosts
+ * @description    Routines that handle host add/edit/delete on the Inventory detail page.
+*/
 
 'use strict';
 

awx/ui/static/js/helpers/JobDetail.js

@@ -6,8 +6,10 @@
  *  Helper moduler for JobDetails controller
  *
  */
-
-/*
+   /**
+ * @ngdoc function
+ * @name helpers.function:JobDetail
+ * @description    helper moduler for jobdetails controller
     # Playbook events will be structured to form the following hierarchy:
     # - playbook_on_start (once for each playbook file)
     #   - playbook_on_vars_prompt (for each play, but before play starts, we

awx/ui/static/js/helpers/JobSubmission.js

@@ -4,7 +4,11 @@
  *  JobSubmission.js
  *
  */
-
+   /**
+ * @ngdoc function
+ * @name helpers.function:JobSubmission
+ * @description
+*/
 'use strict';
 
 angular.module('JobSubmissionHelper', [ 'RestServices', 'Utilities', 'CredentialFormDefinition', 'CredentialsListDefinition',

awx/ui/static/js/helpers/JobTemplates.js

@@ -6,7 +6,11 @@
  *  Routines shared by job related controllers
  *
  */
-
+   /**
+ * @ngdoc function
+ * @name helpers.function:JobTemplatesHelper
+ * @description  Routines shared by job related controllers
+*/
 'use strict';
 
 angular.module('JobTemplatesHelper', ['Utilities'])

awx/ui/static/js/helpers/Jobs.js

@@ -6,7 +6,11 @@
  *  Routines shared by job related controllers
  *
  */
-
+   /**
+ * @ngdoc function
+ * @name helpers.function:Jobs
+ * @description    routines shared by job related controllers
+*/
 'use strict';
 
 angular.module('JobsHelper', ['Utilities', 'RestServices', 'FormGenerator', 'JobSummaryDefinition', 'InventoryHelper', 'GeneratorHelpers',

awx/ui/static/js/helpers/License.js

@@ -4,10 +4,14 @@
  *
  *  helpers/License.js
  *
- *  Routines for checking and reporting license status
+ *
  *
  */
-
+   /**
+ * @ngdoc function
+ * @name helpers.function:License
+ * @description    Routines for checking and reporting license status
+*/
 'use strict';
 
 angular.module('LicenseHelper', ['RestServices', 'Utilities', 'LicenseUpdateFormDefinition', 'FormGenerator', 'ParseHelper', 'ModalDialog', 'VariablesHelper', 'LicenseFormDefinition', 'AccessHelper'])

awx/ui/static/js/helpers/LoadConfig.js

@@ -1,10 +1,14 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+    /**
+ * @ngdoc function
+ * @name helpers.function:LoadConfig
+ * @description   Attempts to load local_config.js. If not found, loads config.js. Then evaluates the loaded
+ *  javascript, putting the result in $AnsibleConfig.
  *  LoadConfigHelper
  *
- *  Attempts to load local_config.js. If not found, loads config.js. Then evaluates the loaded
- *  javascript, putting the result in $AnsibleConfig.
+ *
  *
  */
 

awx/ui/static/js/helpers/LogViewer.js

@@ -4,7 +4,11 @@
  *  LogViewer.js
  *
  */
-
+   /**
+ * @ngdoc function
+ * @name helpers.function:LogViewer
+ * @description    logviewer
+*/
 'use strict';
 
 angular.module('LogViewerHelper', ['ModalDialog', 'Utilities', 'FormGenerator', 'VariablesHelper'])

awx/ui/static/js/helpers/Lookup.js

@@ -3,7 +3,12 @@
  *
  *  LookupHelper
  *  Build a lookup dialog
- *
+ */
+
+   /**
+ * @ngdoc function
+ * @name helpers.function:Lookup
+ * @description
  *  LookUpInit( {
  *      scope: <caller's scope>,
  *      form: <form object>,

awx/ui/static/js/helpers/PaginationHelpers.js

@@ -4,7 +4,11 @@
  *  PaginationHelpers.js
  *
  */
-
+   /**
+ * @ngdoc function
+ * @name helpers.function:PaginationHelpers
+ * @description  pagination
+*/
 'use strict';
 
 angular.module('PaginationHelpers', ['Utilities', 'RefreshHelper', 'RefreshRelatedHelper'])

awx/ui/static/js/helpers/Parse.js

@@ -2,7 +2,11 @@
  *  Copyright (c) 2014 AnsibleWorks, Inc.
  *
  *  ParseHelper
- *
+ */
+    /**
+ * @ngdoc function
+ * @name helpers.function:Parse
+ * @description
  *  Show the CodeMirror variable editor and allow
  *  toggle between JSON and YAML
  *

awx/ui/static/js/helpers/Permissions.js

@@ -2,7 +2,11 @@
  *  Copyright (c) 2014 AnsibleWorks, Inc.
  *
  *  Permissions.js
- *
+ */
+    /**
+ * @ngdoc function
+ * @name helpers.function:Permissions
+ * @description
  *  Functions shared amongst Permission related controllers
  *
  */

awx/ui/static/js/helpers/ProjectPath.js

@@ -2,7 +2,11 @@
  *  Copyright (c) 2014 AnsibleWorks, Inc.
  *
  *  ProjectPathHelper
- *
+ */
+    /**
+ * @ngdoc function
+ * @name helpers.function:ProjectPath
+ * @description
  *  Use GetProjectPath({ scope: <scope>, master: <master obj> }) to
  *  load scope.project_local_paths (array of options for drop-down) and
  *  scope.base_dir (readonly field).
@@ -47,7 +51,7 @@ angular.module('ProjectPathHelper', ['RestServices', 'Utilities'])
                             });
                         }
                         if (scope.local_path) {
-                            // List only includes paths not assigned to projects, so add the 
+                            // List only includes paths not assigned to projects, so add the
                             // path assigned to the current project.
                             opts.push({
                                 label: scope.local_path,

awx/ui/static/js/helpers/Projects.js

@@ -2,7 +2,11 @@
  *  Copyright (c) 2014 AnsibleWorks, Inc.
  *
  *  ProjectsHelper
- *
+ */
+   /**
+ * @ngdoc function
+ * @name helpers.function:Projects
+ * @description
  *  Use GetProjectPath({ scope: <scope>, master: <master obj> }) to
  *  load scope.project_local_paths (array of options for drop-down) and
  *  scope.base_dir (readonly field).

awx/ui/static/js/helpers/Schedules.js

@@ -1,6 +1,10 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+    /**
+ * @ngdoc function
+ * @name helpers.function:Schedules
+ * @description
  *  Schedules Helper
  *
  *  Display the scheduler widget in a dialog

awx/ui/static/js/helpers/Selection.js

@@ -1,6 +1,10 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+    /**
+ * @ngdoc function
+ * @name helpers.function:Selection
+ * @description
  *  SelectionHelper
  *  Used in list controllers where the list might also be used as a selection list.
  *
@@ -80,9 +84,9 @@ angular.module('SelectionHelper', ['Utilities', 'RestServices'])
             // Add the selections
             scope.finishSelection = function () {
                 Rest.setUrl(target_url);
-                
+
                 var queue = [], j;
-                
+
                 scope.formModalActionDisabled = true;
                 scope.disableSelectBtn = true;
 

awx/ui/static/js/helpers/SocketHelper.js

@@ -1,6 +1,10 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+    /**
+ * @ngdoc function
+ * @name helpers.function:SocketHelper
+ * @description
  *  SocketHelper.js
  *
  *  Show web socket troubleshooting help

awx/ui/static/js/helpers/Users.js

@@ -1,6 +1,10 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+     /**
+ * @ngdoc function
+ * @name helpers.function:Users
+ * @description
  *  UserHelper
  *  Routines shared amongst the user controllers
  *
@@ -12,7 +16,7 @@ angular.module('UserHelper', ['UserFormDefinition'])
     .factory('ResetForm', ['UserForm',
         function (UserForm) {
             return function () {
-                // Restore form to default conditions.  Run before applying LDAP configuration. 
+                // Restore form to default conditions.  Run before applying LDAP configuration.
                 // LDAP may manage some or all of these fields in which case the user cannot
                 // make changes to their values in AWX.
 

awx/ui/static/js/helpers/Variables.js

@@ -1,6 +1,10 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+     /**
+ * @ngdoc function
+ * @name helpers.function:Variables
+ * @description
  *  VariablesHelper
  *
  *

awx/ui/static/js/helpers/api-defaults.js

@@ -5,7 +5,11 @@
  *
  *
  */
-
+ /**
+ * @ngdoc function
+ * @name helpers.function:api-defaults
+ * @description this could use more discussion
+*/
 'use strict';
 
 angular.module('APIDefaults', ['RestServices', 'Utilities'])

awx/ui/static/js/helpers/inventory.js

@@ -1,13 +1,15 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
  *
- *  InventoryHelper
+ */
+   /**
+ * @ngdoc function
+ * @name helpers.function:Inventory
+ * @description   InventoryHelper
  *  Routines for building the tree. Everything related to the tree is here except
  *  for the menu piece. The routine for building the menu is in InventoriesEdit controller
  *  (controllers/Inventories.js)
- *
- */
-
+*/
 'use strict';
 
 angular.module('InventoryHelper', ['RestServices', 'Utilities', 'OrganizationListDefinition', 'ListGenerator', 'AuthService',

awx/ui/static/js/helpers/md5.js

@@ -3,9 +3,14 @@
  *
  *  md5helper
  *
- *  Run md5Setup({ scope: , master:, check_field:, default_val: }) 
+ */
+    /**
+ * @ngdoc function
+ * @name helpers.function:md5
+ * @description
+ *  Run md5Setup({ scope: , master:, check_field:, default_val: })
  *  to initialize md5 fields (checkbox and text field).
- *
+ * discussion
  */
 
 'use strict';
@@ -13,7 +18,7 @@
 angular.module('md5Helper', ['RestServices', 'Utilities', 'angular-md5'])
     .factory('md5Setup', ['md5', function (md5) {
         return function (params) {
-          
+
             var scope = params.scope,
                 master = params.master,
                 check_field = params.check_field,

awx/ui/static/js/helpers/refresh-related.js

@@ -1,6 +1,11 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+   /**
+ * @ngdoc function
+ * @name helpers.function:refresh-related
+ * @description
+ * discussion
  *  RefreshRelatedHelper
  *
  *  Used to refresh a related set whenever pagination or filter options change.

awx/ui/static/js/helpers/refresh.js

@@ -1,6 +1,10 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+    /**
+ * @ngdoc function
+ * @name helpers.function:refresh
+ * @description
  *  RefreshHelper
  *
  *  Used to refresh a related set whenever pagination or filter options change.

awx/ui/static/js/helpers/related-search.js

@@ -1,6 +1,10 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+    /**
+ * @ngdoc function
+ * @name helpers.function:related-search
+ * @description
  *  RelatedSearchHelper
  *
  *  All the parts for controlling the search widget on
@@ -41,7 +45,7 @@ angular.module('RelatedSearchHelper', ['RestServices', 'Utilities', 'RefreshRela
                                     break;
                                 }
                             }
-                            
+
                             if (Empty(scope[iterator + 'SearchField'])) {
                                 // A field marked as key may not be 'searchable'. Find the first searchable field.
                                 for (fld in form.related[set].fields) {
@@ -84,7 +88,7 @@ angular.module('RelatedSearchHelper', ['RestServices', 'Utilities', 'RefreshRela
 
                 // Functions to handle search widget changes
                 scope.setSearchField = function (iterator, fld, label) {
-                    
+
                     var f, related;
 
                     for (related in form.related) {
@@ -111,7 +115,7 @@ angular.module('RelatedSearchHelper', ['RestServices', 'Utilities', 'RefreshRela
                     }
 
                     if (f.searchType !== undefined && f.searchType === 'int') {
-                        //scope[iterator + 'HideSearchType'] = true;   
+                        //scope[iterator + 'HideSearchType'] = true;
                         scope[iterator + 'SearchType'] = 'int';
                     }
 
@@ -223,7 +227,7 @@ angular.module('RelatedSearchHelper', ['RestServices', 'Utilities', 'RefreshRela
                     });
 
                     // Toggle the icon for the clicked column
-                    // and set the sort direction  
+                    // and set the sort direction
                     icon = $('#' + iterator + '-' + fld + '-header i');
                     direction = '';
                     if (icon.hasClass('fa-sort')) {

awx/ui/static/js/helpers/search.js

@@ -1,6 +1,10 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+    /**
+ * @ngdoc function
+ * @name helpers.function:search
+ * @description
  *  SearchHelper
  *
  *  All the parts for controlling the search widget on

awx/ui/static/js/helpers/teams.js

@@ -1,6 +1,10 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+/**
+ * @ngdoc function
+ * @name helpers.function:teams
+ * @description
  *  TeamHelper
  *  Routines shared amongst the team controllers
  */
@@ -39,7 +43,7 @@ angular.module('TeamHelper', ['RestServices', 'Utilities', 'OrganizationListDefi
 
                 scope.$on('TeamRefreshFinished', function (e, results) {
                     // Loop through the result set (sent to us by the search helper) and
-                    // lookup the id and name of each organization. After each lookup 
+                    // lookup the id and name of each organization. After each lookup
                     // completes, call resultFound.
 
                     var i, lookup_results = [], url;

awx/ui/static/js/widgets/DashboardCounts.js

@@ -1,8 +1,14 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
- * Dashboard.js
- *
+ */
+    /**
+ * @ngdoc overview
+ * @name widgets
+ * @description Various widgets, including widgets on the dashboard
+    /**
+ * @ngdoc function
+ * @name widgets.function:DashboardCounts
+ * @description
  * The dashboard widget with stats across the top
  *
  */

awx/ui/static/js/widgets/DashboardJobs.js

@@ -1,9 +1,10 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
- * Dashboard.js
- *
- * The new dashboard
+ */
+    /**
+ * @ngdoc function
+ * @name widgets.function:DashboardJobs
+ * @description
  *
  */
 

awx/ui/static/js/widgets/HostGraph.js

@@ -1,12 +1,14 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
- * Dashboard.js
- *
- * The new dashboard
+ */
+    /**
+ * @ngdoc function
+ * @name widgets.function:HostGraph
+ * @description
  *
  */
 
+
 'use strict';
 
 angular.module('HostGraphWidget', ['RestServices', 'Utilities'])

awx/ui/static/js/widgets/HostPieChart.js

@@ -1,6 +1,10 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+    /**
+ * @ngdoc function
+ * @name widgets.function:HostPieChart
+ * @description
  * HostPieChart.js
  *
  * file for the host status pie chart

awx/ui/static/js/widgets/InventorySyncStatus.js

@@ -1,6 +1,10 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+    /**
+ * @ngdoc function
+ * @name widgets.function:InventorySyncStatus
+ * @description
  * InventorySyncStatus.js
  *
  * Dashboard widget showing object counts and license availability.

awx/ui/static/js/widgets/JobStatus.js

@@ -1,6 +1,10 @@
 /*********************************************
 * Copyright (c) 2014 AnsibleWorks, Inc.
-*
+*/
+    /**
+ * @ngdoc function
+ * @name widgets.function:JobStatus
+ * @description
 * JobStatus.js
 *
 * Dashboard widget showing object counts and license availability.

awx/ui/static/js/widgets/JobStatusGraph.js

@@ -1,18 +1,12 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
- * Dashboard.js
- *
- * The new dashboard
- *
+ */
+    /**
+ * @ngdoc function
+ * @name widgets.function:JobStatusGraph
+ * @description
  */
 
- /**
- * @ngdoc overview
- * @name jobstatusgraph
- * @description this is hte job status graph widget
- *
-*/
 
 'use strict';
 

awx/ui/static/js/widgets/ObjectCount.js

@@ -1,6 +1,10 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+    /**
+ * @ngdoc function
+ * @name widgets.function:ObjectCount
+ * @description
  * ObjectCount.js
  *
  * Dashboard widget showing object counts and license availability.

awx/ui/static/js/widgets/SCMSyncStatus.js

@@ -1,6 +1,10 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+    /**
+ * @ngdoc function
+ * @name widgets.function:SCMSyncStatus
+ * @description
  * SCMSyncStatus.js
  *
  * Dashboard widget showing object counts and license availability.

awx/ui/static/js/widgets/Stream.js

@@ -1,6 +1,10 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+    /**
+ * @ngdoc function
+ * @name widgets.function:Stream
+ * @description
  *  Stream.js
  *
  *  Activity stream widget that can be called from anywhere

awx/ui/static/lib/ansible/AuthService.js

@@ -1,7 +1,10 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
- *  AuthService.js
+ */
+  /**
+ *  @ngdoc function
+ *  @name lib.ansible.function:AuthService
+ *  @description  AuthService.js
  *
  *  User authentication functions
  *

awx/ui/static/lib/ansible/InventoryTree.js

@@ -1,7 +1,11 @@
 /************************************
  *
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+  /**
+ *  @ngdoc function
+ *  @name lib.ansible.function:inventoryTree
+ *  @description
  *  InventoryTree.js
  *
  *  Build data for the tree selector table used on inventory detail page.

awx/ui/static/lib/ansible/Modal.js

@@ -1,7 +1,11 @@
 /************************************
  *
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+  /**
+ *  @ngdoc function
+ *  @name lib.ansible.function:Modal
+ *  @description
  *  Modal.js
  *
  *  Create a draggable, resizable modal dialog using jQueryUI.
@@ -14,7 +18,10 @@
 angular.module('ModalDialog', ['Utilities', 'ParseHelper'])
 
     /**
-     *
+     * @ngdoc method
+     * @name lib.ansible.function:Modal#CreateDialog
+     * @methodOf lib.ansible.function:Modal
+     * @description
      * CreateDialog({
      *     id:          - id attribute value of the target DOM element
      *     scope:       - Required, $scope associated with the #id DOM element

awx/ui/static/lib/ansible/RestServices.js

@@ -1,11 +1,20 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+  /**
+ *  @ngdoc function
+ *  @name lib.ansible.function:RestServices
+ *  @description
  * Generic accessor for Ansible Commander services
  *
  */
 'use strict';
-
+/**
+* @ngdoc method
+* @name lib.ansible.function:RestServices#Rest
+* @methodOf lib.ansible.function:RestServices
+* @description discuss reason to use this over built in functions with angular/jquery
+*/
 angular.module('RestServices', ['ngCookies', 'AuthService'])
     .factory('Rest', ['$http', '$rootScope', '$cookieStore', '$q', 'Authorization',
         function ($http, $rootScope, $cookieStore, $q, Authorization) {

awx/ui/static/lib/ansible/Socket.js

@@ -1,6 +1,10 @@
 /**************************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+  /**
+ *  @ngdoc function
+ *  @name lib.ansible.function:Socket
+ *  @description
  *  Socket.js
  *
  *  Wrapper for lib/socket.io-client/dist/socket.io.js.
@@ -9,7 +13,12 @@
 /* global io */
 
 'use strict';
-
+/**
+ * @ngdoc method
+ * @name lib.ansible.function:Socket#SocketIO
+ * @methodOf lib.ansible.function:Socket
+ * @description
+ */
 angular.module('SocketIO', ['AuthService', 'Utilities'])
 
     .factory('Socket', ['$rootScope', '$location', '$log', 'Authorization', 'Store', function ($rootScope, $location, $log, Authorization, Store) {

awx/ui/static/lib/ansible/Timer.js

@@ -1,6 +1,10 @@
 /**************************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+  /**
+ *  @ngdoc function
+ *  @name lib.ansible.function:Timer
+ *  @description
  *  Timer.js
  *
  *  Use to track user idle time and expire session. Timeout
@@ -8,7 +12,12 @@
  *
  */
 'use strict';
-
+/**
+ * @ngdoc method
+ * @name lib.ansible.function:Timer#TimerService
+ * @methodOf lib.ansible.function:Timer
+ * @description
+ */
 angular.module('TimerService', ['ngCookies', 'Utilities'])
     .factory('Timer', ['$rootScope', '$cookieStore', '$location', 'GetBasePath', 'Empty',
         function ($rootScope, $cookieStore) {

awx/ui/static/lib/ansible/Utilities.js

@@ -1,7 +1,11 @@
 /************************************
  *
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+  /**
+ *  @ngdoc function
+ *  @name lib.ansible.function:Utilities
+ *  @description
  *  Utility functions
  *
  */
@@ -12,7 +16,11 @@
 
 angular.module('Utilities', ['RestServices', 'Utilities'])
 
-/*
+/**
+ * @ngdoc method
+ * @name lib.ansible.function:Utilities#ClearScope
+ * @methodOf lib.ansible.function:Utilities
+ * @description
  *  Place to remove things that might be lingering from a prior tab or view.
  *  This used to destroy the scope, but that causes issues in angular 1.2.x
  */
@@ -42,7 +50,11 @@ angular.module('Utilities', ['RestServices', 'Utilities'])
 }])
 
 
-/* Empty()
+/**
+ * @ngdoc method
+ * @name lib.ansible.function:Utilities#Empty
+ * @methodOf lib.ansible.function:Utilities
+ * @description Empty()
  *
  * Test if a value is 'empty'. Returns true if val is null | '' | undefined.
  * Only works on non-Ojbect types.
@@ -56,7 +68,12 @@ angular.module('Utilities', ['RestServices', 'Utilities'])
     }
 ])
 
-
+/**
+ * @ngdoc method
+ * @name lib.ansible.function:Utilities#ToggleClass
+ * @methodOf lib.ansible.function:Utilities
+ * @description
+ */
 .factory('ToggleClass', function () {
     return function (selector, cssClass) {
         // Toggles the existance of a css class on a given element
@@ -69,8 +86,11 @@ angular.module('Utilities', ['RestServices', 'Utilities'])
 })
 
 
-/*
- * Pass in the header and message you want displayed on TB modal dialog found in index.html.
+/**
+ * @ngdoc method
+ * @name lib.ansible.function:Utilities#Alert
+ * @methodOf lib.ansible.function:Utilities
+ * @description Pass in the header and message you want displayed on TB modal dialog found in index.html.
  * Assumes an #id of 'alert-modal'. Pass in an optional TB alert class (i.e. alert-danger, alert-success,
  * alert-info...). Pass an optional function(){}, if you want a specific action to occur when user
  * clicks 'OK' button. Set secondAlert to true, when a second dialog is needed.
@@ -140,7 +160,12 @@ angular.module('Utilities', ['RestServices', 'Utilities'])
     };
 }])
 
-
+/**
+ * @ngdoc method
+ * @name lib.ansible.function:Utilities#ProcessErrors
+ * @methodOf lib.ansible.function:Utilities
+ * @description For handling errors that are returned from the API
+*/
 .factory('ProcessErrors', ['$rootScope', '$cookieStore', '$log', '$location', 'Alert', 'Wait',
     function ($rootScope, $cookieStore, $log, $location, Alert, Wait) {
         return function (scope, data, status, form, defaultMsg) {
@@ -314,11 +339,14 @@ angular.module('Utilities', ['RestServices', 'Utilities'])
     }
 ])
 
-
-/* Display a help dialog
+/**
+ * @ngdoc method
+ * @name lib.ansible.function:Utilities#HelpDialog
+ * @methodOf lib.ansible.function:Utilities
+ * @description Display a help dialog
  *
  * HelpDialog({ defn: <HelpDefinition> })
- *
+ * discuss difference b/t this and other modal windows/dialogs
  */
 .factory('HelpDialog', ['$rootScope', '$compile', '$location', 'Store',
     function ($rootScope, $compile, $location, Store) {
@@ -500,7 +528,11 @@ angular.module('Utilities', ['RestServices', 'Utilities'])
 ])
 
 
-/*
+/**
+ * @ngdoc method
+ * @name lib.ansible.function:Utilities#ReturnToCaller
+ * @methodOf lib.ansible.function:Utilities
+ * @description
  * Split the current path by '/' and use the array elements from 0 up to and
  * including idx as the new path.  If no idx value supplied, use 0 to length - 1.
  *
@@ -521,7 +553,11 @@ angular.module('Utilities', ['RestServices', 'Utilities'])
 ])
 
 
-/*
+/**
+ * @ngdoc method
+ * @name lib.ansible.function:Utilities#FormatDate
+ * @methodOf lib.ansible.function:Utilities
+ * @description
  * Wrapper for data filter- an attempt to insure all dates display in
  * the same format. Pass in date object or string. See: http://docs.angularjs.org/api/ng.filter:date
  */
@@ -533,7 +569,11 @@ angular.module('Utilities', ['RestServices', 'Utilities'])
     }
 ])
 
-/*
+/**
+ * @ngdoc method
+ * @name lib.ansible.function:Utilities#Wait
+ * @methodOf lib.ansible.function:Utilities
+ * @description
  * Display a spinning icon in the center of the screen to freeze the
  * UI while waiting on async things to complete (i.e. API calls).
  * Wait('start' | 'stop');
@@ -612,9 +652,11 @@ angular.module('Utilities', ['RestServices', 'Utilities'])
     }
 ])
 
-/*
- * Make an Options call to the API and retrieve dropdown options
- *
+/**
+ * @ngdoc method
+ * @name lib.ansible.function:Utilities#GetChoices
+ * @methodOf lib.ansible.function:Utilities
+ * @description Make an Options call to the API and retrieve dropdown options
  * GetChoices({
  *     scope:       Parent $scope
  *     url:         API resource to access
@@ -665,7 +707,11 @@ angular.module('Utilities', ['RestServices', 'Utilities'])
     }
 ])
 
-/*
+/**
+ * @ngdoc method
+ * @name lib.ansible.function:Utilities#Find
+ * @methodOf lib.ansible.function:Utilities
+ * @description
  * Search an array of objects, returning the matchting object or null
  *
  *  Find({ list: [], key: "key", val: <key value> });
@@ -692,7 +738,11 @@ angular.module('Utilities', ['RestServices', 'Utilities'])
     }
 ])
 
-/*
+/**
+ * @ngdoc method
+ * @name lib.ansible.function:Utilities#DebugForm
+ * @methodOf lib.ansible.function:Utilities
+ * @description
  * DebugForm({ form: <form object>, scope: <current scope object> });
  *
  * Use to log the $pristine and $valid properties of each form element. Helpful when form
@@ -723,7 +773,11 @@ angular.module('Utilities', ['RestServices', 'Utilities'])
 ])
 
 
-/* Store
+/**
+ * @ngdoc method
+ * @name lib.ansible.function:Utilities#Store
+ * @methodOf lib.ansible.function:Utilities
+ * @description Store
  *
  * Wrapper for local storage. All local storage requests flow through here so that we can
  * stringify/unstringify objects and respond to future issues in one place. For example,
@@ -733,7 +787,7 @@ angular.module('Utilities', ['RestServices', 'Utilities'])
  * store(key,value) will store the value using the key
  *
  * store(key) retrieves the value of the key
- *
+ * discuss use case
  */
 .factory('Store', ['Empty',
     function (Empty) {
@@ -750,10 +804,13 @@ angular.module('Utilities', ['RestServices', 'Utilities'])
     }
 ])
 
-/*
- *
+/**
+ * @ngdoc method
+ * @name lib.ansible.function:Utilities#ApplyEllipsis
+ * @methodOf lib.ansible.function:Utilities
+ * @description
  * ApplyEllipsis()
- *
+ * discuss significance
  */
 .factory('ApplyEllipsis', [
     function () {

awx/ui/static/lib/ansible/api-loader.js

@@ -2,7 +2,17 @@
  *  Copyright (c) 2014 AnsibleWorks, Inc.
  *
  *
- *  Read /api and /api/X to discover all the base paths needed
+ */
+ /**
+ *  @ngdoc overview
+ *  @name lib.ansible
+ *  @description lib files
+ *
+ */
+ /**
+ *  @ngdoc function
+ *  @name lib.ansible.function:api-loader
+ *  @description Read /api and /api/X to discover all the base paths needed
  *  to access the primary model objects.
  *
  */

awx/ui/static/lib/ansible/directives.js

@@ -1,6 +1,10 @@
 /*********************************************
  *  Copyright (c) 2014 AnsibleWorks, Inc.
- *
+ */
+  /**
+ *  @ngdoc function
+ *  @name lib.ansible.function:directives
+ *  @description
  * Custom directives for form validation
  *
  */