From 03795652642bc6a9ee7e08fdf5a895912f76f377 Mon Sep 17 00:00:00 2001
From: Artem Bilan <abilan@pivotal.io>
Date: Thu, 25 May 2017 14:34:29 -0400
Subject: [PATCH] Fix JavaDocs for Remote File components

https://build.spring.io/browse/INT-MASTER-684/
---
 .../remote/gateway/AbstractRemoteFileOutboundGateway.java | 2 ++
 .../integration/ftp/dsl/FtpOutboundGatewaySpec.java       | 8 ++++++--
 2 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/gateway/AbstractRemoteFileOutboundGateway.java b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/gateway/AbstractRemoteFileOutboundGateway.java
index 7c072fa6ad..bf436f8faf 100644
--- a/spring-integration-file/src/main/java/org/springframework/integration/file/remote/gateway/AbstractRemoteFileOutboundGateway.java
+++ b/spring-integration-file/src/main/java/org/springframework/integration/file/remote/gateway/AbstractRemoteFileOutboundGateway.java
@@ -750,6 +750,7 @@ public abstract class AbstractRemoteFileOutboundGateway<F> extends AbstractReply
 	 * @param message the request message related to this put command
 	 * @param session the remote protocol session related to this invocation context
 	 * @param subDirectory the target sub directory to put
+	 * @return The remote path, or null if no local file was found.
 	 * @since 5.0
 	 */
 	protected String put(Message<?> message, Session<F> session, String subDirectory) {
@@ -804,6 +805,7 @@ public abstract class AbstractRemoteFileOutboundGateway<F> extends AbstractReply
 	 * @param message the request message related to this mPut command
 	 * @param session the remote protocol session for this invocation context
 	 * @param localDir the local directory to mput to the server
+	 * @return The list of remote paths for sent files
 	 * @since 5.0
 	 */
 	protected List<String> mPut(Message<?> message, Session<F> session, File localDir) {
diff --git a/spring-integration-ftp/src/main/java/org/springframework/integration/ftp/dsl/FtpOutboundGatewaySpec.java b/spring-integration-ftp/src/main/java/org/springframework/integration/ftp/dsl/FtpOutboundGatewaySpec.java
index ed3d7e92f6..a1c6cc36f1 100644
--- a/spring-integration-ftp/src/main/java/org/springframework/integration/ftp/dsl/FtpOutboundGatewaySpec.java
+++ b/spring-integration-ftp/src/main/java/org/springframework/integration/ftp/dsl/FtpOutboundGatewaySpec.java
@@ -61,6 +61,8 @@ public class FtpOutboundGatewaySpec extends RemoteFileOutboundGatewaySpec<FTPFil
 	 * Specify a SpEL {@link Expression} to evaluate FTP client working directory
 	 * against request message.
 	 * @param workingDirExpression the SpEL expression to evaluate working directory
+	 * @return the spec
+	 * @see FtpOutboundGateway#setWorkingDirExpression(Expression)
 	 */
 	public FtpOutboundGatewaySpec workingDirExpression(String workingDirExpression) {
 		((FtpOutboundGateway) this.target).setWorkingDirExpressionString(workingDirExpression);
@@ -71,6 +73,8 @@ public class FtpOutboundGatewaySpec extends RemoteFileOutboundGatewaySpec<FTPFil
 	 * Specify a SpEL {@link Expression} to evaluate FTP client working directory
 	 * against request message.
 	 * @param workingDirExpression the SpEL expression to evaluate working directory
+	 * @return the spec
+	 * @see FtpOutboundGateway#setWorkingDirExpression(Expression)
 	 */
 	public FtpOutboundGatewaySpec workingDirExpression(Expression workingDirExpression) {
 		((FtpOutboundGateway) this.target).setWorkingDirExpression(workingDirExpression);
@@ -81,12 +85,12 @@ public class FtpOutboundGatewaySpec extends RemoteFileOutboundGatewaySpec<FTPFil
 	 * Specify a {@link Function} to evaluate FTP client working directory
 	 * against request message.
 	 * @param workingDirFunction the function to evaluate working directory
+	 * @return the spec
+	 * @see FtpOutboundGateway#setWorkingDirExpression(Expression)
 	 */
 	public FtpOutboundGatewaySpec workingDirFunction(Function<Message<?>, String> workingDirFunction) {
 		((FtpOutboundGateway) this.target).setWorkingDirExpression(new FunctionExpression<>(workingDirFunction));
 		return this;
 	}
 
-
-
 }