Fix various javadoc warnings

This commit is contained in:
Phillip Webb
2013-11-26 13:24:19 -08:00
parent c7c395d0d0
commit a31ac882c5
52 changed files with 112 additions and 162 deletions

View File

@@ -29,21 +29,19 @@ public interface StreamingHttpOutputMessage extends HttpOutputMessage {
/**
* Sets the streaming body for this message.
*
* @param body the streaming body
*/
void setBody(Body body);
/**
* Defines the contract for bodies that can be written directly to a
* {@link OuputStream}. It is useful with HTTP client libraries that provide indirect
* {@link OutputStream}. It is useful with HTTP client libraries that provide indirect
* access to an {@link OutputStream} via a callback mechanism.
*/
public interface Body {
/**
* Writes this body to the given {@link OuputStream}.
*
* Writes this body to the given {@link OutputStream}.
* @param outputStream the output stream to write to
* @throws IOException in case of errors
*/

View File

@@ -63,7 +63,7 @@ import org.springframework.util.StringUtils;
* LinkedMultiValueMap<String, Object>(); parts.add("field 1", "value 1"); parts.add("file", new
* ClassPathResource("myFile.jpg")); template.postForLocation("http://example.com/myFileUpload", parts); </pre>
*
* <p>Some methods in this class were inspired by {@link org.apache.commons.httpclient.methods.multipart.MultipartRequestEntity}.
* <p>Some methods in this class were inspired by {@code org.apache.commons.httpclient.methods.multipart.MultipartRequestEntity}.
*
* @author Arjen Poutsma
* @see MultiValueMap

View File

@@ -64,7 +64,7 @@ public class HttpComponentsHttpInvokerRequestExecutor extends AbstractHttpInvoke
/**
* Create a new instance of the HttpComponentsHttpInvokerRequestExecutor with a default
* {@link HttpClient} that uses a default {@link org.apache.http.impl.conn.PoolingClientConnectionManager}.
* {@link HttpClient} that uses a default {@code org.apache.http.impl.conn.PoolingClientConnectionManager}.
*/
public HttpComponentsHttpInvokerRequestExecutor() {
org.apache.http.conn.scheme.SchemeRegistry schemeRegistry = new org.apache.http.conn.scheme.SchemeRegistry();

View File

@@ -100,10 +100,10 @@ public class HttpInvokerClientInterceptor extends RemoteInvocationBasedAccessor
* Set the HttpInvokerRequestExecutor implementation to use for executing
* remote invocations.
* <p>Default is {@link SimpleHttpInvokerRequestExecutor}. Alternatively,
* consider using {@link CommonsHttpInvokerRequestExecutor} for more
* consider using {@link HttpComponentsHttpInvokerRequestExecutor} for more
* sophisticated needs.
* @see SimpleHttpInvokerRequestExecutor
* @see CommonsHttpInvokerRequestExecutor
* @see HttpComponentsHttpInvokerRequestExecutor
*/
public void setHttpInvokerRequestExecutor(HttpInvokerRequestExecutor httpInvokerRequestExecutor) {
this.httpInvokerRequestExecutor = httpInvokerRequestExecutor;

View File

@@ -31,10 +31,6 @@ import org.springframework.web.util.WebUtils;
* which include specifying allowed/required fields, and registering custom
* property editors.
*
* <p>Used by Spring Web MVC's BaseCommandController and MultiActionController.
* Note that BaseCommandController and its subclasses allow for easy customization
* of the binder instances that they use through overriding {@code initBinder}.
*
* <p>Can also be used for manual data binding in custom web controllers:
* for example, in a plain Controller implementation or in a MultiActionController
* handler method. Simply instantiate a ServletRequestDataBinder for each binding
@@ -59,7 +55,6 @@ import org.springframework.web.util.WebUtils;
* @see #setAllowedFields
* @see #setRequiredFields
* @see #setFieldMarkerPrefix
* @see org.springframework.web.servlet.mvc.BaseCommandController#initBinder
*/
public class ServletRequestDataBinder extends WebDataBinder {
@@ -99,7 +94,6 @@ public class ServletRequestDataBinder extends WebDataBinder {
* @param request request with parameters to bind (can be multipart)
* @see org.springframework.web.multipart.MultipartHttpServletRequest
* @see org.springframework.web.multipart.MultipartFile
* @see #bindMultipartFiles
* @see #bind(org.springframework.beans.PropertyValues)
*/
public void bind(ServletRequest request) {

View File

@@ -161,7 +161,7 @@ import java.util.concurrent.Callable;
*
* <p>The following return types are supported for handler methods:
* <ul>
* <li>A {@link ModelAndView} object (Servlet MVC or Portlet MVC),
* <li>A {@code ModelAndView} object (Servlet MVC or Portlet MVC),
* with the model implicitly enriched with command objects and the results
* of {@link ModelAttribute @ModelAttribute} annotated reference data accessor methods.
* <li>A {@link org.springframework.ui.Model Model} object, with the view name

View File

@@ -63,7 +63,6 @@ import org.springframework.web.context.request.WebRequest;
* @see org.springframework.web.servlet.FrameworkServlet
* @see org.springframework.web.servlet.DispatcherServlet
* @see org.springframework.web.jsf.FacesContextUtils
* @see org.springframework.web.jsf.SpringBeanVariableResolver
* @see org.springframework.web.jsf.el.SpringBeanFacesELResolver
*/
public abstract class WebApplicationContextUtils {