You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by kr...@apache.org on 2014/10/17 18:34:57 UTC
svn commit: r1632629 - in
/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering:
AbstractMavenFilteringRequest.java BaseFilter.java DefaultFilterInfo.java
MavenFileFilter.java MavenFilteringException.java
Author: krosenvold
Date: Fri Oct 17 16:34:57 2014
New Revision: 1632629
URL: http://svn.apache.org/r1632629
Log:
Fixed some javadoc
Modified:
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/BaseFilter.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultFilterInfo.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java
maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFilteringException.java
Modified: maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java?rev=1632629&r1=1632628&r2=1632629&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java (original)
+++ maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/AbstractMavenFilteringRequest.java Fri Oct 17 16:34:57 2014
@@ -230,7 +230,7 @@ public class AbstractMavenFilteringReque
}
/**
- * @param escapeString
+ * @param escapeString The escape string to use
* @since 1.0-beta-2
*/
public void setEscapeString( String escapeString )
@@ -247,7 +247,7 @@ public class AbstractMavenFilteringReque
}
/**
- * @param projectStartExpressions
+ * @param projectStartExpressions The start expressions
* @since 1.0-beta-2
*/
public void setProjectStartExpressions( List<String> projectStartExpressions )
Modified: maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/BaseFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/BaseFilter.java?rev=1632629&r1=1632628&r2=1632629&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/BaseFilter.java (original)
+++ maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/BaseFilter.java Fri Oct 17 16:34:57 2014
@@ -56,7 +56,7 @@ class BaseFilter
* java.util.List, boolean, org.apache.maven.execution.MavenSession)
* @deprecated
*/
- public List<FileUtils.FilterWrapper> getDefaultFilterWrappers( final MavenProject mavenProject,
+ @Nonnull public List<FileUtils.FilterWrapper> getDefaultFilterWrappers( final MavenProject mavenProject,
List<String> filters,
final boolean escapedBackslashesInFilePath,
MavenSession mavenSession )
Modified: maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultFilterInfo.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultFilterInfo.java?rev=1632629&r1=1632628&r2=1632629&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultFilterInfo.java (original)
+++ maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultFilterInfo.java Fri Oct 17 16:34:57 2014
@@ -40,7 +40,7 @@ public interface DefaultFilterInfo
* </ul>
* <b>This method is now deprecated and no escape mechanism will be used.</b>
*
- * @param mavenProject
+ * @param mavenProject The maven project
* @param filters {@link java.util.List} of properties file
* @return {@link java.util.List} of FileUtils.FilterWrapper
* @deprecated use
@@ -53,11 +53,11 @@ public interface DefaultFilterInfo
throws MavenFilteringException;
/**
- * @param mavenProject
- * @param filters
- * @param escapedBackslashesInFilePath
- * @param mavenSession
- * @param mavenResourcesExecution
+ * @param mavenProject The maven project
+ * @param filters The filters to get
+ * @param escapedBackslashesInFilePath escape backslashes ?
+ * @param mavenSession The maven session
+ * @param mavenResourcesExecution The filtering configuration
* @return {@link java.util.List} of FileUtils.FilterWrapper
* @throws org.apache.maven.shared.filtering.MavenFilteringException
* @since 1.0-beta-2
@@ -70,7 +70,7 @@ public interface DefaultFilterInfo
throws MavenFilteringException;
/**
- * @param request
+ * @param request The filtering request
* @return {@link java.util.List} of FileUtils.FilterWrapper
* @throws org.apache.maven.shared.filtering.MavenFilteringException
* @since 1.0-beta-3
Modified: maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java?rev=1632629&r1=1632628&r2=1632629&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java (original)
+++ maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java Fri Oct 17 16:34:57 2014
@@ -49,7 +49,7 @@ public interface MavenFileFilter
throws MavenFilteringException;
/**
- * @param mavenFileFilterRequest
+ * @param mavenFileFilterRequest the request
* @throws MavenFilteringException
* @since 1.0-beta-3
*/
@@ -57,9 +57,9 @@ public interface MavenFileFilter
throws MavenFilteringException;
/**
- * @param from
- * @param to
- * @param filtering
+ * @param from The source file
+ * @param to The target file
+ * @param filtering true to apply filtering
* @param filterWrappers {@link List} of FileUtils.FilterWrapper
* @throws MavenFilteringException
*/
@@ -68,12 +68,12 @@ public interface MavenFileFilter
throws MavenFilteringException;
/**
- * @param from
- * @param to
- * @param filtering
- * @param filterWrappers
- * @param encoding
- * @param overwrite
+ * @param from The source file
+ * @param to The destination file
+ * @param filtering true to apply filtering
+ * @param filterWrappers The filters to applt
+ * @param encoding The encoding to use
+ * @param overwrite Overwrite to file ?
* @throws MavenFilteringException
* @since 1.0-beta-2
*/
Modified: maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFilteringException.java
URL: http://svn.apache.org/viewvc/maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFilteringException.java?rev=1632629&r1=1632628&r2=1632629&view=diff
==============================================================================
--- maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFilteringException.java (original)
+++ maven/shared/trunk/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFilteringException.java Fri Oct 17 16:34:57 2014
@@ -35,7 +35,7 @@ public class MavenFilteringException
}
/**
- * @param message
+ * @param message the message
*/
public MavenFilteringException( String message )
{
@@ -43,7 +43,7 @@ public class MavenFilteringException
}
/**
- * @param cause
+ * @param cause the cause of the exception
*/
public MavenFilteringException( Throwable cause )
{
@@ -51,8 +51,8 @@ public class MavenFilteringException
}
/**
- * @param message
- * @param cause
+ * @param message a message
+ * @param cause a worthy cause
*/
public MavenFilteringException( String message, Throwable cause )
{