From 49c94485c575a16ae722b3fab634313cc8a6502a Mon Sep 17 00:00:00 2001 From: Sebastian Sdorra Date: Wed, 17 Oct 2012 14:13:36 +0200 Subject: [PATCH] fix minor javadoc warnings --- .../java/sonia/scm/BasicPropertiesAware.java | 41 +++++-------------- .../main/java/sonia/scm/ScmClientConfig.java | 7 ++-- .../sonia/scm/config/ScmConfiguration.java | 2 +- .../scm/repository/RepositoryHookSupport.java | 2 +- .../api/RepositoryServiceFactory.java | 1 - .../sonia/scm/security/SecurityContext.java | 4 +- 6 files changed, 19 insertions(+), 38 deletions(-) diff --git a/scm-core/src/main/java/sonia/scm/BasicPropertiesAware.java b/scm-core/src/main/java/sonia/scm/BasicPropertiesAware.java index b320f109e0..d273e88e98 100644 --- a/scm-core/src/main/java/sonia/scm/BasicPropertiesAware.java +++ b/scm-core/src/main/java/sonia/scm/BasicPropertiesAware.java @@ -56,12 +56,8 @@ public class BasicPropertiesAware implements PropertiesAware { /** - * Returns true if this object is the same as the obj argument. + * {@inheritDoc} * - * - * @param obj - the reference object with which to compare - * - * @return true if this object is the same as the obj argument */ @Override public boolean equals(Object obj) @@ -79,8 +75,8 @@ public class BasicPropertiesAware implements PropertiesAware final BasicPropertiesAware other = (BasicPropertiesAware) obj; if ((this.properties != other.properties) - && ((this.properties == null) - ||!this.properties.equals(other.properties))) + && ((this.properties == null) + ||!this.properties.equals(other.properties))) { return false; } @@ -89,10 +85,8 @@ public class BasicPropertiesAware implements PropertiesAware } /** - * Returns a hash code value for this object. + * {@inheritDoc} * - * - * @return a hash code value for this object */ @Override public int hashCode() @@ -100,17 +94,15 @@ public class BasicPropertiesAware implements PropertiesAware int hash = 7; hash = 41 * hash + ((this.properties != null) - ? this.properties.hashCode() - : 0); + ? this.properties.hashCode() + : 0); return hash; } /** - * @see {@link PropertiesAware#removeProperty(String)} + * {@inheritDoc} * - * - * @param key */ @Override public void removeProperty(String key) @@ -121,10 +113,8 @@ public class BasicPropertiesAware implements PropertiesAware //~--- get methods ---------------------------------------------------------- /** - * @see {@link PropertiesAware#getProperties()} + * {@inheritDoc} * - * - * @return */ @Override public Map getProperties() @@ -133,12 +123,8 @@ public class BasicPropertiesAware implements PropertiesAware } /** - * @see {@link PropertiesAware#getProperty(String)} + * {@inheritDoc} * - * - * @param key - * - * @return */ @Override public String getProperty(String key) @@ -149,10 +135,8 @@ public class BasicPropertiesAware implements PropertiesAware //~--- set methods ---------------------------------------------------------- /** - * @see {@link PropertiesAware#setProperties(java.util.Map)} + * {@inheritDoc} * - * - * @param properties */ @Override public void setProperties(Map properties) @@ -161,11 +145,8 @@ public class BasicPropertiesAware implements PropertiesAware } /** - * @see {@link PropertiesAware#setProperty(String,String) } + * {@inheritDoc} * - * - * @param key - * @param value */ @Override public void setProperty(String key, String value) diff --git a/scm-core/src/main/java/sonia/scm/ScmClientConfig.java b/scm-core/src/main/java/sonia/scm/ScmClientConfig.java index 0e6b4ed023..40b7d36aaa 100644 --- a/scm-core/src/main/java/sonia/scm/ScmClientConfig.java +++ b/scm-core/src/main/java/sonia/scm/ScmClientConfig.java @@ -95,10 +95,9 @@ public class ScmClientConfig /** * Returns the date format for the user interface. This format is a - * JavaScript date format, see - * {@link http://jacwright.com/projects/javascript/date_format}. - * - * + * JavaScript date format. + * + * @see Date Format * @return JavaScript date format */ public String getDateFormat() 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 3d61e77fb8..7885b295eb 100644 --- a/scm-core/src/main/java/sonia/scm/config/ScmConfiguration.java +++ b/scm-core/src/main/java/sonia/scm/config/ScmConfiguration.java @@ -256,7 +256,7 @@ public class ScmConfiguration *
  • os = Operation System
    • *
  • arch = Architecture
    • * - * For example {@link http://plugins.scm-manager.org/scm-plugin-backend/api/{version}/plugins?os={os}&arch={arch}&snapshot=false"} + * For example http://plugins.scm-manager.org/scm-plugin-backend/api/{version}/plugins?os={os}&arch={arch}&snapshot=false * * @return the complete plugin url. */ diff --git a/scm-core/src/main/java/sonia/scm/repository/RepositoryHookSupport.java b/scm-core/src/main/java/sonia/scm/repository/RepositoryHookSupport.java index 3fced455cf..abff10135f 100644 --- a/scm-core/src/main/java/sonia/scm/repository/RepositoryHookSupport.java +++ b/scm-core/src/main/java/sonia/scm/repository/RepositoryHookSupport.java @@ -87,7 +87,7 @@ public interface RepositoryHookSupport /** * Fires a hook event. This methods calls the - * {@link RepositoryHook#onEvent(RepositoryHookEvent} of each registered + * {@link RepositoryHook#onEvent(RepositoryHookEvent)} of each registered * {@link RepositoryHook}. * * diff --git a/scm-core/src/main/java/sonia/scm/repository/api/RepositoryServiceFactory.java b/scm-core/src/main/java/sonia/scm/repository/api/RepositoryServiceFactory.java index eb1371ddd7..16d183c97f 100644 --- a/scm-core/src/main/java/sonia/scm/repository/api/RepositoryServiceFactory.java +++ b/scm-core/src/main/java/sonia/scm/repository/api/RepositoryServiceFactory.java @@ -153,7 +153,6 @@ public final class RepositoryServiceFactory * @param configuration configuration * @param cacheManager cache manager * @param repositoryManager manager for repositories - * @param securityContextProvider provider for the current security context * @param resolvers a set of {@link RepositoryServiceResolver} * @param preProcessorUtil helper object for pre processor handling * diff --git a/scm-core/src/main/java/sonia/scm/security/SecurityContext.java b/scm-core/src/main/java/sonia/scm/security/SecurityContext.java index 34baca2f5e..90d7ac00d9 100644 --- a/scm-core/src/main/java/sonia/scm/security/SecurityContext.java +++ b/scm-core/src/main/java/sonia/scm/security/SecurityContext.java @@ -35,12 +35,14 @@ package sonia.scm.security; //~--- non-JDK imports -------------------------------------------------------- +import org.apache.shiro.SecurityUtils; + import sonia.scm.user.User; /** * * @author Sebastian Sdorra - * @deprecated use {@link SecurityUtils#getSecurityManager()} instead. + * @deprecated use {@link SecurityUtils#getSubject()} instead. */ @Deprecated public interface SecurityContext