From 736131230f48b07f3b524760533078a964ceb42c Mon Sep 17 00:00:00 2001 From: Joakim Erdfelt Date: Tue, 1 Mar 2011 17:16:47 +0000 Subject: [PATCH] Fixing other javadoc violations/errors git-svn-id: svn+ssh://dev.eclipse.org/svnroot/rt/org.eclipse.jetty/jetty/trunk@2839 7e9141cc-0065-0410-87d8-b60c137991c4 --- .../jetty/http/ssl/AliasedX509ExtendedKeyManager.java | 2 +- .../org/eclipse/jetty/http/ssl/SslContextFactory.java | 10 +++++----- .../java/org/eclipse/jetty/policy/PolicyMonitor.java | 11 ++++++----- .../eclipse/jetty/server/ssl/SslSocketConnector.java | 2 +- .../jetty/websocket/WebSocketConnectionD00.java | 8 ++++---- 5 files changed, 17 insertions(+), 16 deletions(-) diff --git a/jetty-http/src/main/java/org/eclipse/jetty/http/ssl/AliasedX509ExtendedKeyManager.java b/jetty-http/src/main/java/org/eclipse/jetty/http/ssl/AliasedX509ExtendedKeyManager.java index 0b5802ba94e..5e128ddfc57 100644 --- a/jetty-http/src/main/java/org/eclipse/jetty/http/ssl/AliasedX509ExtendedKeyManager.java +++ b/jetty-http/src/main/java/org/eclipse/jetty/http/ssl/AliasedX509ExtendedKeyManager.java @@ -118,7 +118,7 @@ public class AliasedX509ExtendedKeyManager extends X509ExtendedKeyManager /* ------------------------------------------------------------ */ /** - * @see javax.net.ssl.X509ExtendedKeyManager#chooseEngineClientAlias(java.lang.String, java.security.Principal[], javax.net.ssl.SSLEngine) + * @see javax.net.ssl.X509ExtendedKeyManager#chooseEngineClientAlias(String[], Principal[], SSLEngine) */ @Override public String chooseEngineClientAlias(String keyType[], Principal[] issuers, SSLEngine engine) diff --git a/jetty-http/src/main/java/org/eclipse/jetty/http/ssl/SslContextFactory.java b/jetty-http/src/main/java/org/eclipse/jetty/http/ssl/SslContextFactory.java index 3742a9ebe9e..31ce8dbd855 100644 --- a/jetty-http/src/main/java/org/eclipse/jetty/http/ssl/SslContextFactory.java +++ b/jetty-http/src/main/java/org/eclipse/jetty/http/ssl/SslContextFactory.java @@ -322,8 +322,8 @@ public class SslContextFactory extends AbstractLifeCycle } /* ------------------------------------------------------------ */ - /** Set the _keyStoreInputStream. - * @param _keyStoreInputStream the _keyStoreInputStream to set + /** Set the keyStoreInputStream. + * @param keystoreInputStream the InputStream to the KeyStore */ public void setKeyStoreInputStream(InputStream keystoreInputStream) { @@ -429,7 +429,7 @@ public class SslContextFactory extends AbstractLifeCycle /* ------------------------------------------------------------ */ /** Set the _trustStoreInputStream. - * @param _trustStoreInputStream the _trustStoreInputStream to set + * @param truststoreInputStream the InputStream to the TrustStore */ public void setTrustStoreInputStream(InputStream truststoreInputStream) { @@ -495,8 +495,8 @@ public class SslContextFactory extends AbstractLifeCycle /* ------------------------------------------------------------ */ /** - * @param validateServerCert - * true if SSL certificate has to be validated + * @param validateCerts + * true if SSL certificates have to be validated */ public void setValidateCerts(boolean validateCerts) { diff --git a/jetty-policy/src/main/java/org/eclipse/jetty/policy/PolicyMonitor.java b/jetty-policy/src/main/java/org/eclipse/jetty/policy/PolicyMonitor.java index 42aea8c3ef2..93cf4b7182d 100644 --- a/jetty-policy/src/main/java/org/eclipse/jetty/policy/PolicyMonitor.java +++ b/jetty-policy/src/main/java/org/eclipse/jetty/policy/PolicyMonitor.java @@ -93,7 +93,7 @@ public abstract class PolicyMonitor extends AbstractLifeCycle /** * gets the scanner interval * - * @return + * @return the scan interval */ public int getScanInterval() { @@ -103,7 +103,8 @@ public abstract class PolicyMonitor extends AbstractLifeCycle /** * sets the scanner interval on a non-running instance of the monitor * - * @param scanInterval + * @param scanInterval in seconds + * @see Scanner#setScanInterval(int) */ public void setScanInterval( int scanInterval ) { @@ -119,7 +120,7 @@ public abstract class PolicyMonitor extends AbstractLifeCycle * true of the monitor is initialized, meaning that at least one * scan cycle has completed and any policy grants found have been chirped * - * @return + * @return true if initialized */ public boolean isInitialized() { @@ -129,7 +130,7 @@ public abstract class PolicyMonitor extends AbstractLifeCycle /** * gets the number of times the scan has been run * - * @return + * @return scan count */ public int getScanCount() { @@ -153,7 +154,7 @@ public abstract class PolicyMonitor extends AbstractLifeCycle /** * true of reload is enabled, false otherwise * - * @return + * @return true if reload is enabled */ public boolean isReloadEnabled() { diff --git a/jetty-server/src/main/java/org/eclipse/jetty/server/ssl/SslSocketConnector.java b/jetty-server/src/main/java/org/eclipse/jetty/server/ssl/SslSocketConnector.java index b5f971e1e2e..6a6fac42fc8 100644 --- a/jetty-server/src/main/java/org/eclipse/jetty/server/ssl/SslSocketConnector.java +++ b/jetty-server/src/main/java/org/eclipse/jetty/server/ssl/SslSocketConnector.java @@ -328,7 +328,7 @@ public class SslSocketConnector extends SocketConnector implements SslConnector /* ------------------------------------------------------------ */ /** - * @see org.eclipse.jetty.server.nio.SelectChannelConnector#doStart() + * {@inheritDoc} */ @Override protected void doStart() throws Exception diff --git a/jetty-websocket/src/main/java/org/eclipse/jetty/websocket/WebSocketConnectionD00.java b/jetty-websocket/src/main/java/org/eclipse/jetty/websocket/WebSocketConnectionD00.java index 3dabb8f164f..392ba373a62 100644 --- a/jetty-websocket/src/main/java/org/eclipse/jetty/websocket/WebSocketConnectionD00.java +++ b/jetty-websocket/src/main/java/org/eclipse/jetty/websocket/WebSocketConnectionD00.java @@ -220,7 +220,7 @@ public class WebSocketConnectionD00 extends AbstractConnection implements WebSoc /* ------------------------------------------------------------ */ /** - * @see org.eclipse.jetty.websocket.WebSocketConnection#sendMessage(java.lang.String) + * {@inheritDoc} */ public void sendMessage(String content) throws IOException { @@ -229,7 +229,7 @@ public class WebSocketConnectionD00 extends AbstractConnection implements WebSoc /* ------------------------------------------------------------ */ /** - * @see org.eclipse.jetty.websocket.WebSocketConnection#sendMessage(byte, java.lang.String) + * {@inheritDoc} */ public void sendMessage(byte frame, String content) throws IOException { @@ -241,7 +241,7 @@ public class WebSocketConnectionD00 extends AbstractConnection implements WebSoc /* ------------------------------------------------------------ */ /** - * @see org.eclipse.jetty.websocket.WebSocketConnection#sendMessage(byte, byte[], int, int) + * {@inheritDoc} */ public void sendMessage(byte opcode, byte[] content, int offset, int length) throws IOException { @@ -253,7 +253,7 @@ public class WebSocketConnectionD00 extends AbstractConnection implements WebSoc /* ------------------------------------------------------------ */ /** - * @see org.eclipse.jetty.websocket.WebSocketConnection#sendFragment(boolean, byte, byte[], int, int) + * {@inheritDoc} */ public void sendFragment(boolean more,byte opcode, byte[] content, int offset, int length) throws IOException {