Fixing malformed Javadoc warnings in jetty-annotations

This commit is contained in:
Joakim Erdfelt 2013-08-14 12:23:58 -07:00
parent c93363055c
commit 1abad26e99
6 changed files with 11 additions and 20 deletions

View File

@ -257,9 +257,9 @@ public class AnnotationConfiguration extends AbstractConfiguration
/** /**
* Check to see if the ServletContainerIntializer loaded via the ServiceLoader came * Check to see if the ServletContainerIntializer loaded via the ServiceLoader came
* from a jar that is excluded by the fragment ordering. See ServletSpec 3.0 p.85. * from a jar that is excluded by the fragment ordering. See ServletSpec 3.0 p.85.
* @param orderedJars * @param context
* @param service * @param service
* @return * @return true if excluded
*/ */
public boolean isFromExcludedJar (WebAppContext context, ServletContainerInitializer service) public boolean isFromExcludedJar (WebAppContext context, ServletContainerInitializer service)
throws Exception throws Exception
@ -298,7 +298,7 @@ public class AnnotationConfiguration extends AbstractConfiguration
/** /**
* @param context * @param context
* @return * @return list of non-excluded {@link ServletContainerInitializer}s
* @throws Exception * @throws Exception
*/ */
public List<ServletContainerInitializer> getNonExcludedInitializers (WebAppContext context) public List<ServletContainerInitializer> getNonExcludedInitializers (WebAppContext context)
@ -508,7 +508,7 @@ public class AnnotationConfiguration extends AbstractConfiguration
* *
* @param jar * @param jar
* @param frags * @param frags
* @return * @return the fragment if found, or null of not found
* @throws Exception * @throws Exception
*/ */
public FragmentDescriptor getFragmentFromJar (Resource jar, List<FragmentDescriptor> frags) public FragmentDescriptor getFragmentFromJar (Resource jar, List<FragmentDescriptor> frags)

View File

@ -237,8 +237,6 @@ public class AnnotationParser
/** /**
* Get the name of the annotation processed by this handler. Can be null * Get the name of the annotation processed by this handler. Can be null
*
* @return
*/ */
public String getAnnotationName(); public String getAnnotationName();
} }
@ -513,7 +511,7 @@ public class AnnotationParser
* Register a handler that will be called back when the named annotation is * Register a handler that will be called back when the named annotation is
* encountered on a class. * encountered on a class.
* *
* @deprecated see registerHandler(Handler) * @deprecated see {@link #registerHandler(Handler)}
* @param annotationName * @param annotationName
* @param handler * @param handler
*/ */
@ -525,9 +523,8 @@ public class AnnotationParser
/** /**
* @deprecated * @deprecated no replacement provided
* @param annotationName * @param annotationName
* @return
*/ */
@Deprecated @Deprecated
public List<DiscoverableAnnotationHandler> getAnnotationHandlers(String annotationName) public List<DiscoverableAnnotationHandler> getAnnotationHandlers(String annotationName)
@ -547,8 +544,7 @@ public class AnnotationParser
} }
/** /**
* @deprecated * @deprecated no replacement available
* @return
*/ */
@Deprecated @Deprecated
public List<DiscoverableAnnotationHandler> getAnnotationHandlers() public List<DiscoverableAnnotationHandler> getAnnotationHandlers()
@ -563,7 +559,7 @@ public class AnnotationParser
} }
/** /**
* @deprecated see registerHandler(Handler) * @deprecated see {@link #registerHandler(Handler)}
* @param handler * @param handler
*/ */
@Deprecated @Deprecated
@ -605,7 +601,6 @@ public class AnnotationParser
* Remove a particular handler * Remove a particular handler
* *
* @param h * @param h
* @return
*/ */
public boolean deregisterHandler(Handler h) public boolean deregisterHandler(Handler h)
{ {
@ -625,7 +620,6 @@ public class AnnotationParser
/** /**
* True if the class has already been processed, false otherwise * True if the class has already been processed, false otherwise
* @param className * @param className
* @return
*/ */
public boolean isParsed (String className) public boolean isParsed (String className)
{ {

View File

@ -126,7 +126,6 @@ public class ServletSecurityAnnotationHandler extends AbstractIntrospectableAnno
* @param rolesAllowed * @param rolesAllowed
* @param permitOrDeny * @param permitOrDeny
* @param transport * @param transport
* @return
*/ */
protected Constraint makeConstraint (Class servlet, String[] rolesAllowed, EmptyRoleSemantic permitOrDeny, TransportGuarantee transport) protected Constraint makeConstraint (Class servlet, String[] rolesAllowed, EmptyRoleSemantic permitOrDeny, TransportGuarantee transport)
{ {
@ -138,7 +137,6 @@ public class ServletSecurityAnnotationHandler extends AbstractIntrospectableAnno
/** /**
* Get the ServletMappings for the servlet's class. * Get the ServletMappings for the servlet's class.
* @param className * @param className
* @return
*/ */
protected List<ServletMapping> getServletMappings(String className) protected List<ServletMapping> getServletMappings(String className)
{ {
@ -160,7 +158,6 @@ public class ServletSecurityAnnotationHandler extends AbstractIntrospectableAnno
* Check if there are already <security-constraint> elements defined that match the url-patterns for * Check if there are already <security-constraint> elements defined that match the url-patterns for
* the servlet. * the servlet.
* @param servletMappings * @param servletMappings
* @return
*/ */
protected boolean constraintsExist (List<ServletMapping> servletMappings, List<ConstraintMapping> constraintMappings) protected boolean constraintsExist (List<ServletMapping> servletMappings, List<ConstraintMapping> constraintMappings)
{ {

View File

@ -61,7 +61,7 @@ public class WebFilterAnnotation extends DiscoveredAnnotation
} }
/** /**
* @see org.eclipse.jetty.annotations.ClassAnnotation#apply() * @see DiscoveredAnnotation#apply()
*/ */
public void apply() public void apply()
{ {

View File

@ -58,7 +58,7 @@ public class WebListenerAnnotation extends DiscoveredAnnotation
} }
/** /**
* @see org.eclipse.jetty.annotations.ClassAnnotation#apply() * @see DiscoveredAnnotation#apply()
*/ */
public void apply() public void apply()
{ {

View File

@ -57,7 +57,7 @@ public class WebServletAnnotation extends DiscoveredAnnotation
} }
/** /**
* @see org.eclipse.jetty.annotations.ClassAnnotation#apply() * @see DiscoveredAnnotation#apply()
*/ */
public void apply() public void apply()
{ {