GUACAMOLE-38: Style and typo fix-ups.

This commit is contained in:
Nick Couchman
2018-02-18 21:10:49 -05:00
parent 039c5120df
commit 6c235565b0
7 changed files with 13 additions and 9 deletions

View File

@@ -55,7 +55,7 @@ public class QuickConnectAuthenticationProvider extends SimpleAuthenticationProv
* @param credentials * @param credentials
* Credentials object passed in from Guacamole login. * Credentials object passed in from Guacamole login.
* *
* @returns * @return
* Returns null, which causes the client to move on to the next * Returns null, which causes the client to move on to the next
* module. * module.
*/ */

View File

@@ -48,6 +48,7 @@ class QuickConnectConnectionGroup extends AbstractConnectionGroup {
* *
* @param name * @param name
* The name of the QuickConnectConnectionGroup. * The name of the QuickConnectConnectionGroup.
*
* @param identifier * @param identifier
* The identifier of the QuickConnectConnectionGroup. * The identifier of the QuickConnectConnectionGroup.
*/ */
@@ -67,6 +68,7 @@ class QuickConnectConnectionGroup extends AbstractConnectionGroup {
* *
* @param identifier * @param identifier
* The identifier of the connection to add to the group. * The identifier of the connection to add to the group.
*
* @return * @return
* The String identifier of the connection if the add * The String identifier of the connection if the add
* operation was successful; otherwise null. * operation was successful; otherwise null.

View File

@@ -66,7 +66,7 @@ public class QuickConnectDirectory extends SimpleConnectionDirectory {
/** /**
* Returns the current counter and then increments it. * Returns the current counter and then increments it.
* *
* @returns * @return
* An Integer representing the next available connection * An Integer representing the next available connection
* ID to get used when adding connections. * ID to get used when adding connections.
*/ */
@@ -89,7 +89,7 @@ public class QuickConnectDirectory extends SimpleConnectionDirectory {
* @param object * @param object
* The QuickConnection object to add to the tree. * The QuickConnection object to add to the tree.
* *
* @returns * @return
* The connectionId of the object added to the directory. * The connectionId of the object added to the directory.
* *
* @throws GuacamoleException * @throws GuacamoleException
@@ -123,7 +123,7 @@ public class QuickConnectDirectory extends SimpleConnectionDirectory {
* The GuacamoleConfiguration to use to create the * The GuacamoleConfiguration to use to create the
* QuickConnection object. * QuickConnection object.
* *
* @returns * @return
* The connectionId of the object creation in the directory. * The connectionId of the object creation in the directory.
* *
* @throws GuacamoleException * @throws GuacamoleException

View File

@@ -94,6 +94,7 @@ public class QuickConnectUserContext implements UserContext {
* @param authProvider * @param authProvider
* The authentication provider module instantiating this * The authentication provider module instantiating this
* this class. * this class.
*
* @param username * @param username
* The name of the user logging in and using this class. * The name of the user logging in and using this class.
*/ */

View File

@@ -68,9 +68,11 @@ public class QuickConnection extends AbstractConnection {
* *
* @param name * @param name
* The name of the connection. * The name of the connection.
*
* @param identifier * @param identifier
* The unique identifier of this connection within this * The unique identifier of this connection within this
* authentication module. * authentication module.
*
* @param config * @param config
* The GuacamoleConfiguration object to store in this * The GuacamoleConfiguration object to store in this
* QuickConnection. * QuickConnection.

View File

@@ -80,12 +80,11 @@ public class QuickConnectREST {
* @param uri * @param uri
* The URI to parse into a connection. * The URI to parse into a connection.
* *
* @returns * @return
* The ID of the connection in the directory. * The ID of the connection in the directory.
* *
* @throws * @throws GuacamoleException
* Throws a GuacamoleException if an error is encountered * If an error is encountered parsing the URI.
* parsing the URI.
*/ */
@POST @POST
@Path("create") @Path("create")

View File

@@ -51,7 +51,7 @@ public class QCParser {
* @param uri * @param uri
* The string form of the URI to be parsed. * The string form of the URI to be parsed.
* *
* @returns * @return
* A GuacamoleConfiguration using a combination of the parsed * A GuacamoleConfiguration using a combination of the parsed
* URI values and default values when not specified in the * URI values and default values when not specified in the
* URI. * URI.