Skip to content

Commit 348e2fa

Browse files
committed
Fixed javadoc comments for release
1 parent c63e59c commit 348e2fa

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

aws-serverless-java-container-spring/src/main/java/com/amazonaws/serverless/proxy/spring/LambdaSpringApplicationInitializer.java

+5-5
Original file line numberDiff line numberDiff line change
@@ -88,10 +88,10 @@ public void setRefreshContext(boolean refreshContext) {
8888

8989
/**
9090
* Given a request and response objects, triggers the filters set in the servlet context and
91-
* @param request
92-
* @param response
93-
* @throws ServletException
94-
* @throws IOException
91+
* @param request The incoming request
92+
* @param response The response object Spring should write to.
93+
* @throws ServletException When an error occurs during processing or of the request
94+
* @throws IOException When an error occurs while writing the response
9595
*/
9696
public void dispatch(HttpServletRequest request, HttpServletResponse response)
9797
throws ServletException, IOException {
@@ -102,7 +102,7 @@ public void dispatch(HttpServletRequest request, HttpServletResponse response)
102102

103103
/**
104104
* Gets the initialized Spring dispatcher servlet instance.
105-
* @return
105+
* @return The Spring dispatcher servlet
106106
*/
107107
public Servlet getDispatcherServlet() {
108108
return dispatcherServlet;

aws-serverless-java-container-spring/src/main/java/com/amazonaws/serverless/proxy/spring/SpringBootLambdaContainerHandler.java

+4-3
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
* object behind the scenes to proxy requests. The default implementation leverages the `AwsProxyHttpServletRequest` and
3737
* `AwsHttpServletResponse` implemented in the `aws-serverless-java-container-core` package.
3838
*
39-
* Important: Make sure to add {@link LambdaFlushResponseListener} in your SpringBootServletInitializer subclass configure().
39+
* Important: Make sure to add <code>LambdaFlushResponseListener</code> in your SpringBootServletInitializer subclass configure().
4040
*
4141
* @param <RequestType> The incoming event type
4242
* @param <ResponseType> The expected return type
@@ -53,7 +53,7 @@ public class SpringBootLambdaContainerHandler<RequestType, ResponseType> extends
5353
* Creates a default SpringLambdaContainerHandler initialized with the `AwsProxyRequest` and `AwsProxyResponse` objects
5454
* @param springBootInitializer {@code SpringBootServletInitializer} class
5555
* @return An initialized instance of the `SpringLambdaContainerHandler`
56-
* @throws ContainerInitializationException
56+
* @throws ContainerInitializationException If an error occurs while initializing the Spring framework
5757
*/
5858
public static SpringBootLambdaContainerHandler<AwsProxyRequest, AwsProxyResponse> getAwsProxyHandler(Class<? extends WebApplicationInitializer> springBootInitializer)
5959
throws ContainerInitializationException {
@@ -73,7 +73,8 @@ public static SpringBootLambdaContainerHandler<AwsProxyRequest, AwsProxyResponse
7373
* @param responseWriter An implementation of `ResponseWriter`
7474
* @param securityContextWriter An implementation of `SecurityContextWriter`
7575
* @param exceptionHandler An implementation of `ExceptionHandler`
76-
* @throws ContainerInitializationException
76+
* @param springBootInitializer {@code SpringBootServletInitializer} class
77+
* @throws ContainerInitializationException If an error occurs while initializing the Spring framework
7778
*/
7879
public SpringBootLambdaContainerHandler(RequestReader<RequestType, AwsProxyHttpServletRequest> requestReader,
7980
ResponseWriter<AwsHttpServletResponse, ResponseType> responseWriter,

0 commit comments

Comments
 (0)