You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ol...@apache.org on 2018/05/26 06:39:33 UTC

[maven-invoker] branch master updated: fix javadoc

This is an automated email from the ASF dual-hosted git repository.

olamy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-invoker.git


The following commit(s) were added to refs/heads/master by this push:
     new ff6aa06  fix javadoc
ff6aa06 is described below

commit ff6aa06bf2d908791bdb59616fbec6915021bcfd
Author: olivier lamy <ol...@apache.org>
AuthorDate: Sat May 26 16:39:24 2018 +1000

    fix javadoc
    
    Signed-off-by: olivier lamy <ol...@apache.org>
---
 .../maven/shared/invoker/DefaultInvocationRequest.java      |  4 +++-
 .../org/apache/maven/shared/invoker/InvocationRequest.java  | 13 +++++++++----
 src/main/java/org/apache/maven/shared/invoker/Invoker.java  |  2 +-
 3 files changed, 13 insertions(+), 6 deletions(-)

diff --git a/src/main/java/org/apache/maven/shared/invoker/DefaultInvocationRequest.java b/src/main/java/org/apache/maven/shared/invoker/DefaultInvocationRequest.java
index ea0e402..b602609 100644
--- a/src/main/java/org/apache/maven/shared/invoker/DefaultInvocationRequest.java
+++ b/src/main/java/org/apache/maven/shared/invoker/DefaultInvocationRequest.java
@@ -19,6 +19,8 @@ package org.apache.maven.shared.invoker;
  * under the License.
  */
 
+import org.apache.maven.shared.utils.cli.Commandline;
+
 import java.io.File;
 import java.io.InputStream;
 import java.util.Collections;
@@ -276,7 +278,7 @@ public class DefaultInvocationRequest
     }
 
     /**
-     * @see MavenCommandLineBuilder#setShellEnvironment(InvocationRequest, org.codehaus.plexus.util.cli.Commandline)
+     * @see MavenCommandLineBuilder#setShellEnvironment(InvocationRequest, Commandline)
      */
     public boolean isShellEnvironmentInherited()
     {
diff --git a/src/main/java/org/apache/maven/shared/invoker/InvocationRequest.java b/src/main/java/org/apache/maven/shared/invoker/InvocationRequest.java
index fdba3c2..d867331 100644
--- a/src/main/java/org/apache/maven/shared/invoker/InvocationRequest.java
+++ b/src/main/java/org/apache/maven/shared/invoker/InvocationRequest.java
@@ -151,21 +151,24 @@ public interface InvocationRequest
     /**
      * Gets the input stream used to provide input for the invoked Maven build. This is in particular useful when
      * invoking Maven in interactive mode.
-     * 
+     *
+     * @param defaultStream the default {@link InputStream} to use
      * @return The input stream used to provide input for the invoked Maven build or <code>null</code> if not set.
      */
     InputStream getInputStream( InputStream defaultStream );
 
     /**
      * Gets the handler used to capture the standard output from the Maven build.
-     * 
+     *
+     * @param defaultHandler the default {@link InvocationOutputHandler} to use
      * @return The output handler or <code>null</code> if not set.
      */
     InvocationOutputHandler getOutputHandler( InvocationOutputHandler defaultHandler );
 
     /**
      * Gets the handler used to capture the error output from the Maven build.
-     * 
+     *
+     * @param defaultHandler the default {@link InvocationOutputHandler} to use
      * @return The error handler or <code>null</code> if not set.
      */
     InvocationOutputHandler getErrorHandler( InvocationOutputHandler defaultHandler );
@@ -609,7 +612,9 @@ public interface InvocationRequest
     /**
      * Specifies whether Maven should check for plugin updates.
      * <p>
-     * Equivalent of {@code -npu} or {@code --no-plugin-updates}<br/>
+     * Equivalent of {@code -npu} or {@code --no-plugin-updates}
+     * </p>
+     * <p>
      * <strong>note: </strong>Ineffective with Maven3, only kept for backward compatibility
      * </p>
      * 
diff --git a/src/main/java/org/apache/maven/shared/invoker/Invoker.java b/src/main/java/org/apache/maven/shared/invoker/Invoker.java
index 31b1799..369be70 100644
--- a/src/main/java/org/apache/maven/shared/invoker/Invoker.java
+++ b/src/main/java/org/apache/maven/shared/invoker/Invoker.java
@@ -41,7 +41,7 @@ public interface Invoker
      * 
      * @param request The invocation request to execute, must not be <code>null</code>.
      * @return The result of the Maven invocation, never <code>null</code>.
-     * @throws MavenInvocationException
+     * @throws MavenInvocationException if cannot configure correctly execution parameters
      */
     InvocationResult execute( InvocationRequest request )
         throws MavenInvocationException;

-- 
To stop receiving notification emails like this one, please contact
olamy@apache.org.