GUACAMOLE-1446: Merge corrections to various typos in documentation.

This commit is contained in:
Mike Jumper
2021-10-26 18:43:04 -07:00
committed by GitHub
15 changed files with 44 additions and 48 deletions

View File

@@ -76,11 +76,11 @@ public abstract class RelatedObjectSet<ParentObjectType extends ModeledDirectory
} }
/** /**
* Returns the mapper which provides low-level access to the the database * Returns the mapper which provides low-level access to the database
* models which drive the relation represented by this RelatedObjectSet. * models which drive the relation represented by this RelatedObjectSet.
* *
* @return * @return
* The mapper which provides low-level access to the the database * The mapper which provides low-level access to the database
* models which drive the relation represented by this * models which drive the relation represented by this
* RelatedObjectSet. * RelatedObjectSet.
*/ */

View File

@@ -438,8 +438,7 @@ public class TOTPGenerator {
* *
* @return * @return
* The TOTP code which would have been generated immediately prior to * The TOTP code which would have been generated immediately prior to
* the the code returned by invoking generate() with the given * the code returned by invoking generate() with the given timestamp.
* timestamp.
*/ */
public String previous(long time) { public String previous(long time) {
return generate(Math.max(startTime, time - timeStep)); return generate(Math.max(startTime, time - timeStep));

View File

@@ -541,7 +541,7 @@ Guacamole.Client = function(tunnel) {
*/ */
this.createObjectOutputStream = function createObjectOutputStream(index, mimetype, name) { this.createObjectOutputStream = function createObjectOutputStream(index, mimetype, name) {
// Allocate and ssociate stream with object metadata // Allocate and associate stream with object metadata
var stream = guac_client.createOutputStream(); var stream = guac_client.createOutputStream();
tunnel.sendMessage("put", index, stream.index, mimetype, name); tunnel.sendMessage("put", index, stream.index, mimetype, name);
return stream; return stream;
@@ -666,7 +666,7 @@ Guacamole.Client = function(tunnel) {
* *
* @return {Guacamole.AudioPlayer} * @return {Guacamole.AudioPlayer}
* An object which implements the Guacamole.AudioPlayer interface and * An object which implements the Guacamole.AudioPlayer interface and
* has been initialied to play the data in the provided stream, or null * has been initialized to play the data in the provided stream, or null
* if the built-in audio players of the Guacamole client should be * if the built-in audio players of the Guacamole client should be
* used. * used.
*/ */
@@ -690,7 +690,7 @@ Guacamole.Client = function(tunnel) {
* *
* @return {Guacamole.VideoPlayer} * @return {Guacamole.VideoPlayer}
* An object which implements the Guacamole.VideoPlayer interface and * An object which implements the Guacamole.VideoPlayer interface and
* has been initialied to play the data in the provided stream, or null * has been initialized to play the data in the provided stream, or null
* if the built-in video players of the Guacamole client should be * if the built-in video players of the Guacamole client should be
* used. * used.
*/ */

View File

@@ -602,7 +602,7 @@ Guacamole.Display = function() {
* Draws the image within the given stream at the given coordinates. The * Draws the image within the given stream at the given coordinates. The
* image will be loaded automatically, and this and any future operations * image will be loaded automatically, and this and any future operations
* will wait for the image to finish loading. This function will * will wait for the image to finish loading. This function will
* automatically choose an approriate method for reading and decoding the * automatically choose an appropriate method for reading and decoding the
* given image stream, and should be preferred for received streams except * given image stream, and should be preferred for received streams except
* where manual decoding of the stream is unavoidable. * where manual decoding of the stream is unavoidable.
* *

View File

@@ -205,8 +205,8 @@ Guacamole.Layer = function(width, height) {
* rectangle to fit. * rectangle to fit.
* @param {Number} y The Y coordinate of the upper-left corner of the * @param {Number} y The Y coordinate of the upper-left corner of the
* rectangle to fit. * rectangle to fit.
* @param {Number} w The width of the the rectangle to fit. * @param {Number} w The width of the rectangle to fit.
* @param {Number} h The height of the the rectangle to fit. * @param {Number} h The height of the rectangle to fit.
*/ */
function fitRect(x, y, w, h) { function fitRect(x, y, w, h) {
@@ -234,7 +234,7 @@ Guacamole.Layer = function(width, height) {
} }
/** /**
* Set to true if this Layer should resize itself to accomodate the * Set to true if this Layer should resize itself to accommodate the
* dimensions of any drawing operation, and false (the default) otherwise. * dimensions of any drawing operation, and false (the default) otherwise.
* *
* Note that setting this property takes effect immediately, and thus may * Note that setting this property takes effect immediately, and thus may
@@ -904,7 +904,7 @@ Guacamole.Layer.PLUS = 0xF;
/** /**
* Channel mask for the composite operation "rin". * Channel mask for the composite operation "rin".
* Beware that WebKit-based browsers may leave the contents of the destionation * Beware that WebKit-based browsers may leave the contents of the destination
* layer where the source layer is transparent, despite the definition of this * layer where the source layer is transparent, despite the definition of this
* operation. * operation.
*/ */
@@ -912,7 +912,7 @@ Guacamole.Layer.RIN = 0x1;
/** /**
* Channel mask for the composite operation "in". * Channel mask for the composite operation "in".
* Beware that WebKit-based browsers may leave the contents of the destionation * Beware that WebKit-based browsers may leave the contents of the destination
* layer where the source layer is transparent, despite the definition of this * layer where the source layer is transparent, despite the definition of this
* operation. * operation.
*/ */
@@ -920,7 +920,7 @@ Guacamole.Layer.IN = 0x4;
/** /**
* Channel mask for the composite operation "out". * Channel mask for the composite operation "out".
* Beware that WebKit-based browsers may leave the contents of the destionation * Beware that WebKit-based browsers may leave the contents of the destination
* layer where the source layer is transparent, despite the definition of this * layer where the source layer is transparent, despite the definition of this
* operation. * operation.
*/ */
@@ -928,7 +928,7 @@ Guacamole.Layer.OUT = 0x8;
/** /**
* Channel mask for the composite operation "ratop". * Channel mask for the composite operation "ratop".
* Beware that WebKit-based browsers may leave the contents of the destionation * Beware that WebKit-based browsers may leave the contents of the destination
* layer where the source layer is transparent, despite the definition of this * layer where the source layer is transparent, despite the definition of this
* operation. * operation.
*/ */
@@ -936,7 +936,7 @@ Guacamole.Layer.RATOP = 0x9;
/** /**
* Channel mask for the composite operation "src". * Channel mask for the composite operation "src".
* Beware that WebKit-based browsers may leave the contents of the destionation * Beware that WebKit-based browsers may leave the contents of the destination
* layer where the source layer is transparent, despite the definition of this * layer where the source layer is transparent, despite the definition of this
* operation. * operation.
*/ */

View File

@@ -24,8 +24,7 @@ import org.apache.guacamole.io.GuacamoleReader;
/** /**
* GuacamoleReader which applies a given GuacamoleFilter to observe or alter all * GuacamoleReader which applies a given GuacamoleFilter to observe or alter all
* read instructions. Instructions may also be dropped or denied by the the * read instructions. Instructions may also be dropped or denied by the filter.
* filter.
*/ */
public class FilteredGuacamoleReader implements GuacamoleReader { public class FilteredGuacamoleReader implements GuacamoleReader {

View File

@@ -158,8 +158,7 @@ public interface Environment {
* connect to guacd. * connect to guacd.
* *
* @throws GuacamoleException * @throws GuacamoleException
* If the the connection information for guacd cannot be * If the connection information for guacd cannot be retrieved.
* retrieved.
*/ */
public GuacamoleProxyConfiguration getDefaultGuacamoleProxyConfiguration() public GuacamoleProxyConfiguration getDefaultGuacamoleProxyConfiguration()
throws GuacamoleException; throws GuacamoleException;

View File

@@ -558,7 +558,7 @@ angular.module('client').directive('guacClient', [function guacClient() {
/** /**
* Displays a visual indication that dropping the file currently * Displays a visual indication that dropping the file currently
* being dragged is possible. Further propogation and default behavior * being dragged is possible. Further propagation and default behavior
* of the given event is automatically prevented. * of the given event is automatically prevented.
* *
* @param {Event} e * @param {Event} e
@@ -577,7 +577,7 @@ angular.module('client').directive('guacClient', [function guacClient() {
/** /**
* Removes the visual indication that dropping the file currently * Removes the visual indication that dropping the file currently
* being dragged is possible. Further propogation and default behavior * being dragged is possible. Further propagation and default behavior
* of the given event is automatically prevented. * of the given event is automatically prevented.
* *
* @param {Event} e * @param {Event} e

View File

@@ -432,7 +432,7 @@ angular.module('client').factory('ManagedClient', ['$rootScope', '$injector',
ManagedClientState.ConnectionState.IDLE); ManagedClientState.ConnectionState.IDLE);
break; break;
// Conneccting // Connecting
case 1: case 1:
ManagedClientState.setConnectionState(managedClient.clientState, ManagedClientState.setConnectionState(managedClient.clientState,
ManagedClientState.ConnectionState.CONNECTING); ManagedClientState.ConnectionState.CONNECTING);
@@ -899,7 +899,7 @@ angular.module('client').factory('ManagedClient', ['$rootScope', '$injector',
* *
* @returns {boolean} * @returns {boolean}
* true if there are any file transfers associated with the * true if there are any file transfers associated with the
* given client, false otherise. * given client, false otherwise.
*/ */
ManagedClient.hasTransfers = function hasTransfers(client) { ManagedClient.hasTransfers = function hasTransfers(client) {
return !!(client && client.uploads && client.uploads.length); return !!(client && client.uploads && client.uploads.length);

View File

@@ -88,12 +88,12 @@ angular.module('clipboard').factory('clipboardService', ['$injector',
document.body.appendChild(clipboardContent); document.body.appendChild(clipboardContent);
/** /**
* Stops the propogation of the given event through the DOM tree. This is * Stops the propagation of the given event through the DOM tree. This is
* identical to invoking stopPropogation() on the event directly, except * identical to invoking stopPropagation() on the event directly, except
* that this function is usable as an event handler itself. * that this function is usable as an event handler itself.
* *
* @param {Event} e * @param {Event} e
* The event whose propogation through the DOM tree should be stopped. * The event whose propagation through the DOM tree should be stopped.
*/ */
var stopEventPropagation = function stopEventPropagation(e) { var stopEventPropagation = function stopEventPropagation(e) {
e.stopPropagation(); e.stopPropagation();

View File

@@ -44,7 +44,7 @@ angular.module('element').directive('guacClick', [function guacClick() {
/** /**
* The callback to invoke when a click or click-like event is * The callback to invoke when a click or click-like event is
* received on the assocaited element. * received on the associated element.
* *
* @type guacClick~callback * @type guacClick~callback
*/ */

View File

@@ -34,7 +34,7 @@ angular.module('navigation').factory('PageDefinition', [function definePageDefin
var PageDefinition = function PageDefinition(template) { var PageDefinition = function PageDefinition(template) {
/** /**
* The the name of the page, which should be a translation table key. * The name of the page, which should be a translation table key.
* Alternatively, this may also be a list of names, where the final * Alternatively, this may also be a list of names, where the final
* name represents the page and earlier names represent categorization. * name represents the page and earlier names represent categorization.
* Those categorical names may be rendered hierarchically as a system * Those categorical names may be rendered hierarchically as a system

View File

@@ -221,7 +221,7 @@ public class ExtensionModule extends ServletModule {
} }
/** /**
* Binds each of the the given AuthenticationProvider classes such that any * Binds each of the given AuthenticationProvider classes such that any
* service requiring access to the AuthenticationProvider can obtain it via * service requiring access to the AuthenticationProvider can obtain it via
* injection. * injection.
* *
@@ -277,7 +277,7 @@ public class ExtensionModule extends ServletModule {
} }
/** /**
* Binds each of the the given Listener classes such that any * Binds each of the given Listener classes such that any
* service requiring access to the Listener can obtain it via * service requiring access to the Listener can obtain it via
* injection. * injection.
* *

View File

@@ -160,8 +160,8 @@ public class DecoratedUserContext extends DelegatingUserContext {
} }
/** /**
* Creates a new DecoratedUserContext, invoking the the decorate() function * Creates a new DecoratedUserContext, invoking the decorate() function of
* of the given AuthenticationProvider to decorate the provided, undecorated * the given AuthenticationProvider to decorate the provided, undecorated
* UserContext. If the AuthenticationProvider originated the given * UserContext. If the AuthenticationProvider originated the given
* UserContext, then the given UserContext is wrapped without any * UserContext, then the given UserContext is wrapped without any
* decoration. * decoration.
@@ -200,7 +200,7 @@ public class DecoratedUserContext extends DelegatingUserContext {
} }
/** /**
* Creates a new DecoratedUserContext, invoking the the decorate() function * Creates a new DecoratedUserContext, invoking the decorate() function
* of the given AuthenticationProvider to apply an additional layer of * of the given AuthenticationProvider to apply an additional layer of
* decoration to a DecoratedUserContext. If the AuthenticationProvider * decoration to a DecoratedUserContext. If the AuthenticationProvider
* originated the given UserContext, then the given UserContext is wrapped * originated the given UserContext, then the given UserContext is wrapped
@@ -240,12 +240,11 @@ public class DecoratedUserContext extends DelegatingUserContext {
} }
/** /**
* Creates a new DecoratedUserContext, invoking the the redecorate() * Creates a new DecoratedUserContext, invoking the redecorate() function
* function of the given AuthenticationProvider to reapply decoration to the * of the given AuthenticationProvider to reapply decoration to the provided,
* provided, undecorated UserContext, which has been updated relative to a * undecorated UserContext, which has been updated relative to a past version
* past version which was decorated. If the AuthenticationProvider * which was decorated. If the AuthenticationProvider originated the given
* originated the given UserContext, then the given UserContext is wrapped * UserContext, then the given UserContext is wrapped without any decoration.
* without any decoration.
* *
* @param decorated * @param decorated
* The DecoratedUserContext associated with the older version of the * The DecoratedUserContext associated with the older version of the
@@ -281,8 +280,8 @@ public class DecoratedUserContext extends DelegatingUserContext {
} }
/** /**
* Creates a new DecoratedUserContext, invoking the the redecorate() * Creates a new DecoratedUserContext, invoking the redecorate() function
* function of the given AuthenticationProvider to reapply decoration to a * of the given AuthenticationProvider to reapply decoration to a
* DecoratedUserContext which already has at least one layer of decoration * DecoratedUserContext which already has at least one layer of decoration
* applied, and which is associated with a UserContext which was updated * applied, and which is associated with a UserContext which was updated
* relative to a past version which was decorated. If the * relative to a past version which was decorated. If the

View File

@@ -44,7 +44,7 @@ public class DecorationService {
private List<AuthenticationProvider> authProviders; private List<AuthenticationProvider> authProviders;
/** /**
* Creates a new DecoratedUserContext, invoking the the decorate() function * Creates a new DecoratedUserContext, invoking the decorate() function
* of all AuthenticationProviders to decorate the provided UserContext. * of all AuthenticationProviders to decorate the provided UserContext.
* Decoration by each AuthenticationProvider will occur in the order that * Decoration by each AuthenticationProvider will occur in the order that
* the AuthenticationProviders were loaded. Only AuthenticationProviders * the AuthenticationProviders were loaded. Only AuthenticationProviders
@@ -94,11 +94,11 @@ public class DecorationService {
} }
/** /**
* Creates a new DecoratedUserContext, invoking the the redecorate() * Creates a new DecoratedUserContext, invoking the redecorate() function
* function of all AuthenticationProviders to reapply decoration. Decoration * of all AuthenticationProviders to reapply decoration. Decoration by each
* by each AuthenticationProvider will occur in the order that the * AuthenticationProvider will occur in the order that the AuthenticationProviders
* AuthenticationProviders were loaded. Only AuthenticationProviders which * were loaded. Only AuthenticationProviders which did not originate the given
* did not originate the given UserContext will be used. * UserContext will be used.
* *
* @param decorated * @param decorated
* The DecoratedUserContext associated with an older version of the * The DecoratedUserContext associated with an older version of the