You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@guacamole.apache.org by mj...@apache.org on 2018/06/03 19:05:37 UTC
[02/50] guacamole-client git commit: GUACAMOLE-38: Style and typo
fix-ups.
GUACAMOLE-38: Style and typo fix-ups.
Project: http://git-wip-us.apache.org/repos/asf/guacamole-client/repo
Commit: http://git-wip-us.apache.org/repos/asf/guacamole-client/commit/6c235565
Tree: http://git-wip-us.apache.org/repos/asf/guacamole-client/tree/6c235565
Diff: http://git-wip-us.apache.org/repos/asf/guacamole-client/diff/6c235565
Branch: refs/heads/staging/1.0.0
Commit: 6c235565b0d1c4c39576fad37de345669f118af8
Parents: 039c512
Author: Nick Couchman <vn...@apache.org>
Authored: Sun Feb 18 21:10:49 2018 -0500
Committer: Nick Couchman <vn...@apache.org>
Committed: Fri Jun 1 13:40:50 2018 -0400
----------------------------------------------------------------------
.../auth/quickconnect/QuickConnectAuthenticationProvider.java | 2 +-
.../auth/quickconnect/QuickConnectConnectionGroup.java | 2 ++
.../guacamole/auth/quickconnect/QuickConnectDirectory.java | 6 +++---
.../guacamole/auth/quickconnect/QuickConnectUserContext.java | 1 +
.../apache/guacamole/auth/quickconnect/QuickConnection.java | 2 ++
.../guacamole/auth/quickconnect/rest/QuickConnectREST.java | 7 +++----
.../apache/guacamole/auth/quickconnect/utility/QCParser.java | 2 +-
7 files changed, 13 insertions(+), 9 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/guacamole-client/blob/6c235565/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnectAuthenticationProvider.java
----------------------------------------------------------------------
diff --git a/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnectAuthenticationProvider.java b/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnectAuthenticationProvider.java
index a94c7df..f725bdf 100644
--- a/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnectAuthenticationProvider.java
+++ b/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnectAuthenticationProvider.java
@@ -55,7 +55,7 @@ public class QuickConnectAuthenticationProvider extends SimpleAuthenticationProv
* @param credentials
* Credentials object passed in from Guacamole login.
*
- * @returns
+ * @return
* Returns null, which causes the client to move on to the next
* module.
*/
http://git-wip-us.apache.org/repos/asf/guacamole-client/blob/6c235565/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnectConnectionGroup.java
----------------------------------------------------------------------
diff --git a/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnectConnectionGroup.java b/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnectConnectionGroup.java
index 5abf0be..4faab1c 100644
--- a/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnectConnectionGroup.java
+++ b/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnectConnectionGroup.java
@@ -48,6 +48,7 @@ class QuickConnectConnectionGroup extends AbstractConnectionGroup {
*
* @param name
* The name of the QuickConnectConnectionGroup.
+ *
* @param identifier
* The identifier of the QuickConnectConnectionGroup.
*/
@@ -67,6 +68,7 @@ class QuickConnectConnectionGroup extends AbstractConnectionGroup {
*
* @param identifier
* The identifier of the connection to add to the group.
+ *
* @return
* The String identifier of the connection if the add
* operation was successful; otherwise null.
http://git-wip-us.apache.org/repos/asf/guacamole-client/blob/6c235565/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnectDirectory.java
----------------------------------------------------------------------
diff --git a/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnectDirectory.java b/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnectDirectory.java
index 5c9606d..ce1fd1f 100644
--- a/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnectDirectory.java
+++ b/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnectDirectory.java
@@ -66,7 +66,7 @@ public class QuickConnectDirectory extends SimpleConnectionDirectory {
/**
* Returns the current counter and then increments it.
*
- * @returns
+ * @return
* An Integer representing the next available connection
* ID to get used when adding connections.
*/
@@ -89,7 +89,7 @@ public class QuickConnectDirectory extends SimpleConnectionDirectory {
* @param object
* The QuickConnection object to add to the tree.
*
- * @returns
+ * @return
* The connectionId of the object added to the directory.
*
* @throws GuacamoleException
@@ -123,7 +123,7 @@ public class QuickConnectDirectory extends SimpleConnectionDirectory {
* The GuacamoleConfiguration to use to create the
* QuickConnection object.
*
- * @returns
+ * @return
* The connectionId of the object creation in the directory.
*
* @throws GuacamoleException
http://git-wip-us.apache.org/repos/asf/guacamole-client/blob/6c235565/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnectUserContext.java
----------------------------------------------------------------------
diff --git a/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnectUserContext.java b/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnectUserContext.java
index b1a2752..d9eb389 100644
--- a/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnectUserContext.java
+++ b/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnectUserContext.java
@@ -94,6 +94,7 @@ public class QuickConnectUserContext implements UserContext {
* @param authProvider
* The authentication provider module instantiating this
* this class.
+ *
* @param username
* The name of the user logging in and using this class.
*/
http://git-wip-us.apache.org/repos/asf/guacamole-client/blob/6c235565/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnection.java
----------------------------------------------------------------------
diff --git a/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnection.java b/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnection.java
index 1735757..a2f3814 100644
--- a/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnection.java
+++ b/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/QuickConnection.java
@@ -68,9 +68,11 @@ public class QuickConnection extends AbstractConnection {
*
* @param name
* The name of the connection.
+ *
* @param identifier
* The unique identifier of this connection within this
* authentication module.
+ *
* @param config
* The GuacamoleConfiguration object to store in this
* QuickConnection.
http://git-wip-us.apache.org/repos/asf/guacamole-client/blob/6c235565/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/rest/QuickConnectREST.java
----------------------------------------------------------------------
diff --git a/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/rest/QuickConnectREST.java b/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/rest/QuickConnectREST.java
index d494eb8..42e53a2 100644
--- a/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/rest/QuickConnectREST.java
+++ b/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/rest/QuickConnectREST.java
@@ -80,12 +80,11 @@ public class QuickConnectREST {
* @param uri
* The URI to parse into a connection.
*
- * @returns
+ * @return
* The ID of the connection in the directory.
*
- * @throws
- * Throws a GuacamoleException if an error is encountered
- * parsing the URI.
+ * @throws GuacamoleException
+ * If an error is encountered parsing the URI.
*/
@POST
@Path("create")
http://git-wip-us.apache.org/repos/asf/guacamole-client/blob/6c235565/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/utility/QCParser.java
----------------------------------------------------------------------
diff --git a/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/utility/QCParser.java b/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/utility/QCParser.java
index 4ada3f0..05b892f 100644
--- a/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/utility/QCParser.java
+++ b/extensions/guacamole-auth-quickconnect/src/main/java/org/apache/guacamole/auth/quickconnect/utility/QCParser.java
@@ -51,7 +51,7 @@ public class QCParser {
* @param uri
* The string form of the URI to be parsed.
*
- * @returns
+ * @return
* A GuacamoleConfiguration using a combination of the parsed
* URI values and default values when not specified in the
* URI.