Commit 223aa9e1 authored by Arent-Jan Banck's avatar Arent-Jan Banck

CMS7-9218: Update Javadoc to fix build issues and warnings

parent 35bbfa42
......@@ -29,7 +29,7 @@ import java.lang.annotation.Target;
public @interface FieldGroupList {
/**
* @return the array of {@FieldGroup}s that should be rendered in the array order.
* @return the array of {@link FieldGroup}s that should be rendered in the array order.
*/
FieldGroup[] value();
......
......@@ -24,7 +24,7 @@ import java.lang.annotation.Target;
/**
* Annotation indicating that a getter method returns the value of an HST parameter.
*
* @see {@link ParametersInfo}
* @see ParametersInfo
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
......
......@@ -30,17 +30,19 @@ import java.lang.annotation.Target;
* For example you can write your org.hippoecm.hst.core.component.HstComponent for a search as follows:
* <blockquote>
* <pre>
* {@code
* @ParametersInfo(type = SearchInfo.class)
* public class Search extends BaseHstComponent {
* <code>
* &#64;ParametersInfo(type = SearchInfo.class)
* public class Search extends BaseHstComponent {
* public static final Logger log = LoggerFactory.getLogger(SearchNoParameterInfo.class);
* @Override
* &#64;Override
* public void doBeforeRender(HstRequest request, HstResponse response) throws HstComponentException {
* SearchInfo info = getParametersInfo(request);
* }
* }
* </code>
* </pre>
* </blockquote>
* </p>
* </p>
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
......
/*
* Copyright 2008-2013 Hippo B.V. (http://www.onehippo.com)
* Copyright 2008-2015 Hippo B.V. (http://www.onehippo.com)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......@@ -38,8 +38,7 @@ public interface AuthenticationProvider {
/**
* Returns security roles of the given username
* @param user
* @return
* @param username
*/
Set<Role> getRolesByUsername(String username) throws SecurityException;
......
......@@ -46,7 +46,7 @@ import org.apache.log4j.spi.LoggingEvent;
* with the specified property value. In this case, the logging event will be accepted when the runtime property value doesn't match.
* </P>
*
* @see {@link org.apache.log4j.spi.Filter}
* @see org.apache.log4j.spi.Filter
*/
public abstract class AbstractPropertyFilter extends Filter {
......@@ -127,9 +127,8 @@ public abstract class AbstractPropertyFilter extends Filter {
/**
* Returns the deciding option whether or not the log message should be logged if a match is found.
* @return
* @see {@link org.apache.log4j.spi.Filter#ACCEPT}
* @see {@link org.apache.log4j.spi.Filter#DENY}
* @see org.apache.log4j.spi.Filter#ACCEPT
* @see org.apache.log4j.spi.Filter#DENY
*/
public int getOnMatch() {
return onMatch;
......@@ -139,8 +138,8 @@ public abstract class AbstractPropertyFilter extends Filter {
* Sets the deciding option whether or not the log message should be logged.
* Allowed option is either {@link org.apache.log4j.spi.Filter#ACCEPT} or {@link org.apache.log4j.spi.Filter#DENY}.
* @param onMatch
* @see {@link org.apache.log4j.spi.Filter#ACCEPT}
* @see {@link org.apache.log4j.spi.Filter#DENY}
* @see org.apache.log4j.spi.Filter#ACCEPT
* @see org.apache.log4j.spi.Filter#DENY
*/
public void setOnMatch(int onMatch) {
this.onMatch = onMatch;
......@@ -148,9 +147,8 @@ public abstract class AbstractPropertyFilter extends Filter {
/**
* Returns string representation of the option flag whether or not the log message should be logged if a match is found.
* @return
* @see {@link org.apache.log4j.spi.Filter#ACCEPT}
* @see {@link org.apache.log4j.spi.Filter#DENY}
* @see org.apache.log4j.spi.Filter#ACCEPT
* @see org.apache.log4j.spi.Filter#DENY
*/
public String getOnMatchOption() {
if (ACCEPT == onMatch) {
......@@ -166,8 +164,8 @@ public abstract class AbstractPropertyFilter extends Filter {
* Sets string representation of the option flag whether or not the log message should be logged.
* Allowed option is either 'ACCEPT' or 'DENY'.
* @param onMatchOption
* @see {@link org.apache.log4j.spi.Filter#ACCEPT}
* @see {@link org.apache.log4j.spi.Filter#DENY}
* @see org.apache.log4j.spi.Filter#ACCEPT
* @see org.apache.log4j.spi.Filter#DENY
*/
public void setOnMatchOption(String onMatchOption) {
if (!"ACCEPT".equals(onMatchOption) && !"DENY".equals(onMatchOption) && !"NEUTRAL".equals(onMatchOption)) {
......@@ -187,7 +185,6 @@ public abstract class AbstractPropertyFilter extends Filter {
* Finds the property value by the name from the underlying environment.
* @param event
* @param name
* @return
*/
abstract protected String getProperty(LoggingEvent event, String name);
}
......@@ -45,7 +45,6 @@ public class JndiPropertyFilter extends AbstractPropertyFilter {
/**
* Return whether the lookup occurs in a J2EE container.
* @return
*/
public boolean isResourceRef() {
return resourceRef;
......
......@@ -43,7 +43,6 @@ public final class UrlSafeBase64 {
/**
* @param string
* @return
* @throws IllegalArgumentException
*/
public static byte[] decode(String string) throws IllegalArgumentException {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment