adding ngdocs site for tower doc site

This commit is contained in:
Jared Tabor
2014-08-28 10:36:55 -04:00
parent fd97aa85b6
commit ca8e52bfff
106 changed files with 757 additions and 195 deletions

View File

@@ -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

View File

@@ -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', {

View File

@@ -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', {

View File

@@ -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',

View File

@@ -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

View File

@@ -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

View File

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

View File

@@ -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,

View File

@@ -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

View File

@@ -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',

View File

@@ -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'])

View File

@@ -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: {

View File

@@ -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: { }
}
}

View File

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

View File

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

View File

@@ -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",

View File

@@ -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
}
}
});

View File

@@ -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

View File

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

View File

@@ -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,

View File

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

View File

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

View File

@@ -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', {

View File

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