You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2008/07/31 22:52:45 UTC
svn commit: r681482 -
/maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/
Author: dennisl
Date: Thu Jul 31 13:52:45 2008
New Revision: 681482
URL: http://svn.apache.org/viewvc?rev=681482&view=rev
Log:
o Remove date based @since tags.
o Fix Javadoc errors.
Modified:
maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/CompositeMap.java
maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenFileFilter.java
maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenResourcesFiltering.java
maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/FilteringUtils.java
maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java
maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFilteringException.java
maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesExecution.java
maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesFiltering.java
maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/PropertiesEscapingBackSlahValueSource.java
Modified: maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/CompositeMap.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/CompositeMap.java?rev=681482&r1=681481&r2=681482&view=diff
==============================================================================
--- maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/CompositeMap.java (original)
+++ maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/CompositeMap.java Thu Jul 31 13:52:45 2008
@@ -30,7 +30,6 @@
* A Map composed with some others (optional adding SystemProperties and envvar)
* The get Method look in the Map list to return the corresponding value
* @author <a href="mailto:olamy@apache.org">olamy</a>
- * @since 15 janv. 08
* @version $Id$
*/
public class CompositeMap
@@ -44,7 +43,7 @@
/**
*
* @param maps
- * @throws IOException if getting envvars failed
+ * @throws java.io.IOException if getting envvars failed
*/
public CompositeMap( List /* Map */maps )
{
Modified: maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenFileFilter.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenFileFilter.java?rev=681482&r1=681481&r2=681482&view=diff
==============================================================================
--- maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenFileFilter.java (original)
+++ maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenFileFilter.java Thu Jul 31 13:52:45 2008
@@ -39,7 +39,6 @@
/**
* @author <a href="mailto:olamy@apache.org">olamy</a>
- * @since 22 janv. 08
* @version $Id$
*
* @plexus.component role="org.apache.maven.shared.filtering.MavenFileFilter"
Modified: maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenResourcesFiltering.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenResourcesFiltering.java?rev=681482&r1=681481&r2=681482&view=diff
==============================================================================
--- maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenResourcesFiltering.java (original)
+++ maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/DefaultMavenResourcesFiltering.java Thu Jul 31 13:52:45 2008
@@ -38,7 +38,6 @@
/**
* @author <a href="mailto:olamy@apache.org">olamy</a>
- * @since 28 janv. 08
* @version $Id$
*
* @plexus.component role="org.apache.maven.shared.filtering.MavenResourcesFiltering"
Modified: maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/FilteringUtils.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/FilteringUtils.java?rev=681482&r1=681481&r2=681482&view=diff
==============================================================================
--- maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/FilteringUtils.java (original)
+++ maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/FilteringUtils.java Thu Jul 31 13:52:45 2008
@@ -23,7 +23,6 @@
/**
* @author <a href="mailto:olamy@apache.org">olamy</a>
- * @since 21 juil. 2008
* @version $Id$
*/
public class FilteringUtils
Modified: maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java?rev=681482&r1=681481&r2=681482&view=diff
==============================================================================
--- maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java (original)
+++ maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFileFilter.java Thu Jul 31 13:52:45 2008
@@ -27,7 +27,6 @@
/**
* @author <a href="mailto:olamy@apache.org">olamy</a>
- * @since 22 janv. 08
* @version $Id$
*/
public interface MavenFileFilter
@@ -35,7 +34,7 @@
/**
* Will copy a file with some filtering using defaultFilterWrappers
- * @see #getDefaultFilterWrappers(MavenProject, List, boolean)
+ * @see #getDefaultFilterWrappers(MavenProject, List, boolean, MavenSession)
*
* @param from file to copy/filter
* @param to destination file
Modified: maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFilteringException.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFilteringException.java?rev=681482&r1=681481&r2=681482&view=diff
==============================================================================
--- maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFilteringException.java (original)
+++ maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenFilteringException.java Thu Jul 31 13:52:45 2008
@@ -21,7 +21,6 @@
/**
* @author <a href="mailto:olamy@apache.org">olamy</a>
- * @since 22 janv. 08
* @version $Id$
*/
public class MavenFilteringException
Modified: maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesExecution.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesExecution.java?rev=681482&r1=681481&r2=681482&view=diff
==============================================================================
--- maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesExecution.java (original)
+++ maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesExecution.java Thu Jul 31 13:52:45 2008
@@ -36,13 +36,12 @@
/**
* A bean to configure a resources filtering execution
* @author <a href="mailto:olamy@apache.org">olamy</a>
- * @since 27 févr. 2008
* @version $Id$
*/
public class MavenResourcesExecution
{
- /** @see Resource */
+ /** @see org.apache.maven.model.Resource */
private List resources;
private File outputDirectory;
@@ -107,7 +106,7 @@
/**
- * @return List of {@link Resource}
+ * @return List of {@link org.apache.maven.model.Resource}
*/
public List getResources()
{
@@ -115,7 +114,7 @@
}
/**
- * @param resources List of {@link Resource}
+ * @param resources List of {@link org.apache.maven.model.Resource}
*/
public void setResources( List resources )
{
@@ -206,7 +205,7 @@
}
/**
- * @param interpolators List of {@link FilterWrapper}
+ * @param filterWrappers List of {@link FilterWrapper}
*/
public void setFilterWrappers( List filterWrappers )
{
Modified: maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesFiltering.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesFiltering.java?rev=681482&r1=681481&r2=681482&view=diff
==============================================================================
--- maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesFiltering.java (original)
+++ maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/MavenResourcesFiltering.java Thu Jul 31 13:52:45 2008
@@ -27,7 +27,6 @@
/**
* @author <a href="mailto:olamy@apache.org">olamy</a>
- * @since 28 janv. 08
* @version $Id$
*/
public interface MavenResourcesFiltering
Modified: maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/PropertiesEscapingBackSlahValueSource.java
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/PropertiesEscapingBackSlahValueSource.java?rev=681482&r1=681481&r2=681482&view=diff
==============================================================================
--- maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/PropertiesEscapingBackSlahValueSource.java (original)
+++ maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/PropertiesEscapingBackSlahValueSource.java Thu Jul 31 13:52:45 2008
@@ -25,7 +25,6 @@
/**
* @author <a href="mailto:olamy@apache.org">olamy</a>
- * @since 21 juil. 2008
* @version $Id$
*/
public class PropertiesEscapingBackSlahValueSource
Re: svn commit: r681482 - /maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/
Posted by Benjamin Bentmann <be...@udo.edu>.
Dennis Lundberg wrote:
>> Also, we need to add some IDE tricks to avoid these errors.
>
> Yes, these errors were caught by IDEA.
Eclipse has likewise options to check javadocs (Window > Preferences >
Java > Compiler > Javadoc).
Benjamin
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: svn commit: r681482 - /maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/
Posted by Dennis Lundberg <de...@apache.org>.
Vincent Siveton wrote:
> Hi Dennis,
>
>
>
> 2008/7/31 <de...@apache.org>:
>> Author: dennisl
>> Date: Thu Jul 31 13:52:45 2008
>> New Revision: 681482
>>
>> URL: http://svn.apache.org/viewvc?rev=681482&view=rev
>> Log:
>> o Remove date based @since tags.
>> o Fix Javadoc errors.
>>
>
> [SNIP]
>
>> public class CompositeMap
>> @@ -44,7 +43,7 @@
>> /**
>> *
>> * @param maps
>> - * @throws IOException if getting envvars failed
>> + * @throws java.io.IOException if getting envvars failed
>> */
>> public CompositeMap( List /* Map */maps )
>> {
>>
>
> I think it will be great to add a Common Javadoc bugs part (similar to
> the Benjamin's common bugs thread) in the Guide To Maven Documentation
> Style.
Useful for sure, but I'm not sure how to create a generic tool that can
help us find such errors. Perhaps some pointers to good IDEs that has
such tools?
> Also, we need to add some IDE tricks to avoid these errors.
Yes, these errors were caught by IDEA.
>
> Cheers,
>
> Vincent
>
> [SNIP]
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
>
--
Dennis Lundberg
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: svn commit: r681482 - /maven/sandbox/trunk/shared/maven-filtering/src/main/java/org/apache/maven/shared/filtering/
Posted by Vincent Siveton <vi...@gmail.com>.
Hi Dennis,
2008/7/31 <de...@apache.org>:
> Author: dennisl
> Date: Thu Jul 31 13:52:45 2008
> New Revision: 681482
>
> URL: http://svn.apache.org/viewvc?rev=681482&view=rev
> Log:
> o Remove date based @since tags.
> o Fix Javadoc errors.
>
[SNIP]
> public class CompositeMap
> @@ -44,7 +43,7 @@
> /**
> *
> * @param maps
> - * @throws IOException if getting envvars failed
> + * @throws java.io.IOException if getting envvars failed
> */
> public CompositeMap( List /* Map */maps )
> {
>
I think it will be great to add a Common Javadoc bugs part (similar to
the Benjamin's common bugs thread) in the Guide To Maven Documentation
Style.
Also, we need to add some IDE tricks to avoid these errors.
Cheers,
Vincent
[SNIP]
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org