From 1dfb688f21bf11d46bfab13d2dad33acc4ea319b Mon Sep 17 00:00:00 2001 From: Sebastian Sdorra Date: Wed, 12 Aug 2020 10:50:01 +0200 Subject: [PATCH] Fix javadoc --- .../sonia/scm/config/ScmConfiguration.java | 22 ++++++++++++------- .../scm/security/TokenExpiredException.java | 2 +- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/scm-core/src/main/java/sonia/scm/config/ScmConfiguration.java b/scm-core/src/main/java/sonia/scm/config/ScmConfiguration.java index 327ee926a1..3a69917df1 100644 --- a/scm-core/src/main/java/sonia/scm/config/ScmConfiguration.java +++ b/scm-core/src/main/java/sonia/scm/config/ScmConfiguration.java @@ -313,16 +313,19 @@ public class ScmConfiguration implements Configuration { } /** - * since 2.4.0 - * @return anonymousMode + * Returns the currently enabled type of anonymous mode. + * + * @return anonymous mode + * @since 2.4.0 */ public AnonymousMode getAnonymousMode() { return anonymousMode; } /** - * @deprecated since 2.4.0 - * @use {@link ScmConfiguration#getAnonymousMode} instead + * Returns {@code true} if anonymous mode is enabled. + * @return {@code true} if anonymous mode is enabled + * @deprecated since 2.4.0 use {@link ScmConfiguration#getAnonymousMode} instead */ @Deprecated public boolean isAnonymousAccessEnabled() { @@ -375,8 +378,9 @@ public class ScmConfiguration implements Configuration { } /** - * @deprecated since 2.4.0 - * @use {@link ScmConfiguration#setAnonymousMode(AnonymousMode)} instead + * Enables the anonymous access at protocol level. + * @param anonymousAccessEnabled enable or disables the anonymous access + * @deprecated since 2.4.0 use {@link ScmConfiguration#setAnonymousMode(AnonymousMode)} instead */ @Deprecated public void setAnonymousAccessEnabled(boolean anonymousAccessEnabled) { @@ -388,8 +392,10 @@ public class ScmConfiguration implements Configuration { } /** - * since 2.4.0 - * @param mode + * Configures the anonymous mode. + * @param mode type of anonymous mode + * + * @since 2.4.0 */ public void setAnonymousMode(AnonymousMode mode) { this.anonymousMode = mode; diff --git a/scm-core/src/main/java/sonia/scm/security/TokenExpiredException.java b/scm-core/src/main/java/sonia/scm/security/TokenExpiredException.java index a4da835c0a..5f570277a0 100644 --- a/scm-core/src/main/java/sonia/scm/security/TokenExpiredException.java +++ b/scm-core/src/main/java/sonia/scm/security/TokenExpiredException.java @@ -27,7 +27,7 @@ package sonia.scm.security; import org.apache.shiro.authc.AuthenticationException; /** - * This exception is thrown if the session token is expired + * This exception is thrown if the session token is expired * @since 2.4.0 */ @SuppressWarnings("squid:MaximumInheritanceDepth") // exceptions have a deep inheritance depth themselves; therefore we accept this here