fix minor javadoc warnings

This commit is contained in:
Sebastian Sdorra
2012-10-17 14:13:36 +02:00
parent 49a4fbda5d
commit 49c94485c5
6 changed files with 19 additions and 38 deletions

View File

@@ -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<String, String> 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<String, String> 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)

View File

@@ -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 <a target="_blank" href="http://jacwright.com/projects/javascript/date_format">Date Format</a>
* @return JavaScript date format
*/
public String getDateFormat()

View File

@@ -256,7 +256,7 @@ public class ScmConfiguration
* <li><b>os</b> = Operation System</li>
* <li><b>arch</b> = Architecture</li>
* </ul>
* 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.
*/

View File

@@ -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}.
*
*

View File

@@ -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
*

View File

@@ -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