GUAC-1053: Clean up comment wrapping, now that everything is two levels deeper.

This commit is contained in:
Michael Jumper
2015-04-17 20:46:18 -07:00
parent 419949787f
commit 32e51bd812
3 changed files with 58 additions and 52 deletions

View File

@@ -51,8 +51,8 @@ angular.module('settings').directive('guacManageConnections', [function guacMana
var currentUserID = authenticationService.getCurrentUserID(); var currentUserID = authenticationService.getCurrentUserID();
/** /**
* An action to be provided along with the object sent to showStatus which * An action to be provided along with the object sent to
* closes the currently-shown status dialog. * showStatus which closes the currently-shown status dialog.
*/ */
var ACKNOWLEDGE_ACTION = { var ACKNOWLEDGE_ACTION = {
name : "MANAGE_CONNECTION.ACTION_ACKNOWLEDGE", name : "MANAGE_CONNECTION.ACTION_ACKNOWLEDGE",
@@ -78,24 +78,25 @@ angular.module('settings').directive('guacManageConnections', [function guacMana
$scope.canManageConnections = null; $scope.canManageConnections = null;
/** /**
* Whether the current user can create new connections. If the current * Whether the current user can create new connections. If the
* permissions have not yet been loaded, this will be null. * current permissions have not yet been loaded, this will be null.
* *
* @type Boolean * @type Boolean
*/ */
$scope.canCreateConnections = null; $scope.canCreateConnections = null;
/** /**
* Whether the current user can create new connection groups. If the * Whether the current user can create new connection groups. If
* current permissions have not yet been loaded, this will be null. * the current permissions have not yet been loaded, this will be
* null.
* *
* @type Boolean * @type Boolean
*/ */
$scope.canCreateConnectionGroups = null; $scope.canCreateConnectionGroups = null;
/** /**
* All permissions associated with the current user, or null if the user's * All permissions associated with the current user, or null if the
* permissions have not yet been loaded. * user's permissions have not yet been loaded.
* *
* @type PermissionSet * @type PermissionSet
*/ */
@@ -105,8 +106,8 @@ angular.module('settings').directive('guacManageConnections', [function guacMana
* Returns whether critical data has completed being loaded. * Returns whether critical data has completed being loaded.
* *
* @returns {Boolean} * @returns {Boolean}
* true if enough data has been loaded for the user interface to be * true if enough data has been loaded for the user interface
* useful, false otherwise. * to be useful, false otherwise.
*/ */
$scope.isLoaded = function isLoaded() { $scope.isLoaded = function isLoaded() {

View File

@@ -52,16 +52,17 @@ angular.module('settings').directive('guacManageSessions', [function guacManageS
var permissionService = $injector.get('permissionService'); var permissionService = $injector.get('permissionService');
/** /**
* All permissions associated with the current user, or null if the user's * All permissions associated with the current user, or null if the
* permissions have not yet been loaded. * user's permissions have not yet been loaded.
* *
* @type PermissionSet * @type PermissionSet
*/ */
$scope.permissions = null; $scope.permissions = null;
/** /**
* The ActiveConnectionWrappers of all active sessions accessible by the * The ActiveConnectionWrappers of all active sessions accessible
* current user, or null if the active sessions have not yet been loaded. * by the current user, or null if the active sessions have not yet
* been loaded.
* *
* @type ActiveConnectionWrapper[] * @type ActiveConnectionWrapper[]
*/ */
@@ -93,16 +94,16 @@ angular.module('settings').directive('guacManageSessions', [function guacManageS
]; ];
/** /**
* All active connections, if known, or null if active connections have not * All active connections, if known, or null if active connections
* yet been loaded. * have not yet been loaded.
* *
* @type ActiveConnection * @type ActiveConnection
*/ */
var activeConnections = null; var activeConnections = null;
/** /**
* Map of all visible connections by object identifier, or null if visible * Map of all visible connections by object identifier, or null if
* connections have not yet been loaded. * visible connections have not yet been loaded.
* *
* @type Object.<String, Connection> * @type Object.<String, Connection>
*/ */
@@ -116,7 +117,8 @@ angular.module('settings').directive('guacManageSessions', [function guacManageS
var sessionDateFormat = null; var sessionDateFormat = null;
/** /**
* Map of all currently-selected active connection wrappers by identifier. * Map of all currently-selected active connection wrappers by
* identifier.
* *
* @type Object.<String, ActiveConnectionWrapper> * @type Object.<String, ActiveConnectionWrapper>
*/ */
@@ -127,7 +129,8 @@ angular.module('settings').directive('guacManageSessions', [function guacManageS
* connections. * connections.
* *
* @param {Connection} connection * @param {Connection} connection
* The connection to add to the internal set of visible connections. * The connection to add to the internal set of visible
* connections.
*/ */
var addConnection = function addConnection(connection) { var addConnection = function addConnection(connection) {
@@ -137,12 +140,12 @@ angular.module('settings').directive('guacManageSessions', [function guacManageS
}; };
/** /**
* Adds all descendant connections of the given connection group to the * Adds all descendant connections of the given connection group to
* internal set of connections. * the internal set of connections.
* *
* @param {ConnectionGroup} connectionGroup * @param {ConnectionGroup} connectionGroup
* The connection group whose descendant connections should be added to * The connection group whose descendant connections should be
* the internal set of connections. * added to the internal set of connections.
*/ */
var addDescendantConnections = function addDescendantConnections(connectionGroup) { var addDescendantConnections = function addDescendantConnections(connectionGroup) {
@@ -157,9 +160,9 @@ angular.module('settings').directive('guacManageSessions', [function guacManageS
}; };
/** /**
* Wraps all loaded active connections, storing the resulting array within * Wraps all loaded active connections, storing the resulting array
* the scope. If required data has not yet finished loading, this function * within the scope. If required data has not yet finished loading,
* has no effect. * this function has no effect.
*/ */
var wrapActiveConnections = function wrapActiveConnections() { var wrapActiveConnections = function wrapActiveConnections() {
@@ -229,8 +232,8 @@ angular.module('settings').directive('guacManageSessions', [function guacManageS
* Returns whether critical data has completed being loaded. * Returns whether critical data has completed being loaded.
* *
* @returns {Boolean} * @returns {Boolean}
* true if enough data has been loaded for the user interface to be * true if enough data has been loaded for the user interface
* useful, false otherwise. * to be useful, false otherwise.
*/ */
$scope.isLoaded = function isLoaded() { $scope.isLoaded = function isLoaded() {
@@ -241,8 +244,8 @@ angular.module('settings').directive('guacManageSessions', [function guacManageS
}; };
/** /**
* An action to be provided along with the object sent to showStatus which * An action to be provided along with the object sent to
* closes the currently-shown status dialog. * showStatus which closes the currently-shown status dialog.
*/ */
var ACKNOWLEDGE_ACTION = { var ACKNOWLEDGE_ACTION = {
name : "MANAGE_SESSION.ACTION_ACKNOWLEDGE", name : "MANAGE_SESSION.ACTION_ACKNOWLEDGE",
@@ -253,8 +256,8 @@ angular.module('settings').directive('guacManageSessions', [function guacManageS
}; };
/** /**
* An action to be provided along with the object sent to showStatus which * An action to be provided along with the object sent to
* closes the currently-shown status dialog. * showStatus which closes the currently-shown status dialog.
*/ */
var CANCEL_ACTION = { var CANCEL_ACTION = {
name : "MANAGE_SESSION.ACTION_CANCEL", name : "MANAGE_SESSION.ACTION_CANCEL",
@@ -265,8 +268,9 @@ angular.module('settings').directive('guacManageSessions', [function guacManageS
}; };
/** /**
* An action to be provided along with the object sent to showStatus which * An action to be provided along with the object sent to
* immediately deletes the currently selected sessions. * showStatus which immediately deletes the currently selected
* sessions.
*/ */
var DELETE_ACTION = { var DELETE_ACTION = {
name : "MANAGE_SESSION.ACTION_DELETE", name : "MANAGE_SESSION.ACTION_DELETE",
@@ -279,8 +283,8 @@ angular.module('settings').directive('guacManageSessions', [function guacManageS
}; };
/** /**
* Immediately deletes the selected sessions, without prompting the user for * Immediately deletes the selected sessions, without prompting the
* confirmation. * user for confirmation.
*/ */
var deleteSessionsImmediately = function deleteSessionsImmediately() { var deleteSessionsImmediately = function deleteSessionsImmediately() {
@@ -311,8 +315,8 @@ angular.module('settings').directive('guacManageSessions', [function guacManageS
}; };
/** /**
* Delete all selected sessions, prompting the user first to confirm that * Delete all selected sessions, prompting the user first to
* deletion is desired. * confirm that deletion is desired.
*/ */
$scope.deleteSessions = function deleteSessions() { $scope.deleteSessions = function deleteSessions() {
// Confirm deletion request // Confirm deletion request
@@ -340,7 +344,8 @@ angular.module('settings').directive('guacManageSessions', [function guacManageS
}; };
/** /**
* Called whenever an active connection wrapper changes selected status. * Called whenever an active connection wrapper changes selected
* status.
* *
* @param {ActiveConnectionWrapper} wrapper * @param {ActiveConnectionWrapper} wrapper
* The wrapper whose selected status has changed. * The wrapper whose selected status has changed.

View File

@@ -51,8 +51,8 @@ angular.module('settings').directive('guacManageUsers', [function guacManageUser
var currentUserID = authenticationService.getCurrentUserID(); var currentUserID = authenticationService.getCurrentUserID();
/** /**
* An action to be provided along with the object sent to showStatus which * An action to be provided along with the object sent to
* closes the currently-shown status dialog. * showStatus which closes the currently-shown status dialog.
*/ */
var ACKNOWLEDGE_ACTION = { var ACKNOWLEDGE_ACTION = {
name : "MANAGE_USER.ACTION_ACKNOWLEDGE", name : "MANAGE_USER.ACTION_ACKNOWLEDGE",
@@ -70,8 +70,8 @@ angular.module('settings').directive('guacManageUsers', [function guacManageUser
$scope.users = null; $scope.users = null;
/** /**
* Whether the current user can manage users. If the current permissions * Whether the current user can manage users. If the current
* have not yet been loaded, this will be null. * permissions have not yet been loaded, this will be null.
* *
* @type Boolean * @type Boolean
*/ */
@@ -86,16 +86,16 @@ angular.module('settings').directive('guacManageUsers', [function guacManageUser
$scope.canCreateUsers = null; $scope.canCreateUsers = null;
/** /**
* The name of the new user to create, if any, when user creation is * The name of the new user to create, if any, when user creation
* requested via newUser(). * is requested via newUser().
* *
* @type String * @type String
*/ */
$scope.newUsername = ""; $scope.newUsername = "";
/** /**
* All permissions associated with the current user, or null if the user's * All permissions associated with the current user, or null if the
* permissions have not yet been loaded. * user's permissions have not yet been loaded.
* *
* @type PermissionSet * @type PermissionSet
*/ */
@@ -105,8 +105,8 @@ angular.module('settings').directive('guacManageUsers', [function guacManageUser
* Returns whether critical data has completed being loaded. * Returns whether critical data has completed being loaded.
* *
* @returns {Boolean} * @returns {Boolean}
* true if enough data has been loaded for the user interface to be * true if enough data has been loaded for the user interface
* useful, false otherwise. * to be useful, false otherwise.
*/ */
$scope.isLoaded = function isLoaded() { $scope.isLoaded = function isLoaded() {
@@ -153,8 +153,8 @@ angular.module('settings').directive('guacManageUsers', [function guacManageUser
}); });
/** /**
* Creates a new user having the username specified in the user creation * Creates a new user having the username specified in the user
* interface. * creation interface.
*/ */
$scope.newUser = function newUser() { $scope.newUser = function newUser() {