Skip to content

Commit f6149bf

Browse files
committed
Fix JavaDocs comments
Fix self closing tags, invalid taglets, parameters typos, etc
1 parent e190ba3 commit f6149bf

File tree

11 files changed

+26
-28
lines changed

11 files changed

+26
-28
lines changed

src/main/java/org/codehaus/plexus/archiver/AbstractUnArchiver.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,10 @@
3535
import org.codehaus.plexus.util.IOUtil;
3636
import org.codehaus.plexus.util.StringUtils;
3737

38+
// TODO there should really be constructors which take the source file.
39+
3840
/**
3941
* @author <a href="mailto:[email protected]">Emmanuel Venisse</a>
40-
* @todo there should really be constructors which take the source file.
4142
*/
4243
public abstract class AbstractUnArchiver
4344
extends AbstractLogEnabled

src/main/java/org/codehaus/plexus/archiver/ArchiveFileFilter.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
package org.codehaus.plexus.archiver;
22

3+
import org.codehaus.plexus.components.io.fileselectors.FileSelector;
4+
35
import java.io.InputStream;
46

57
/**

src/main/java/org/codehaus/plexus/archiver/Archiver.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -353,13 +353,13 @@ ResourceIterator getResources()
353353
String getDuplicateBehavior();
354354

355355
/**
356-
* Set the behavior of this archiver when duplicate files are detected. One of: <br/>
356+
* Set the behavior of this archiver when duplicate files are detected. One of: <br>
357357
* <ul>
358358
* <li>add - Add the duplicates to the archive as duplicate entries</li>
359359
* <li>skip/preserve - Leave the first entry encountered in the archive, skip the new one</li>
360360
* <li>fail - throw an {@link ArchiverException}</li>
361361
* </ul>
362-
* <br/>
362+
* <br>
363363
* See {@link Archiver#DUPLICATES_ADD}, {@link Archiver#DUPLICATES_SKIP}, {@link Archiver#DUPLICATES_PRESERVE},
364364
* {@link Archiver#DUPLICATES_FAIL}.
365365
*/

src/main/java/org/codehaus/plexus/archiver/jar/JarArchiver.java

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -264,9 +264,9 @@ private Manifest getManifest( InputStream is )
264264
* other specified manifests.
265265
* "mergewithoutmain" merges everything but the Main section of the manifests.
266266
* Default value is "skip".
267-
* <p/>
267+
* <p>
268268
* Note: if this attribute's value is not "skip", the created jar will not
269-
* be readable by using java.util.jar.JarInputStream
269+
* be readable by using java.util.jar.JarInputStream</p>
270270
*
271271
* @param config setting for found manifest behavior.
272272
*/
@@ -692,18 +692,15 @@ protected final void writeIndexLikeList( List<String> dirs, List<String> files,
692692

693693
/**
694694
* try to guess the name of the given file.
695-
* <p/>
696695
* <p>
697696
* If this jar has a classpath attribute in its manifest, we
698697
* can assume that it will only require an index of jars listed
699698
* there. try to find which classpath entry is most likely the
700699
* one the given file name points to.</p>
701-
* <p/>
702700
* <p>
703701
* In the absence of a classpath attribute, assume the other
704702
* files will be placed inside the same directory as this jar and
705703
* use their basename.</p>
706-
* <p/>
707704
* <p>
708705
* if there is a classpath and the given file doesn't match any
709706
* of its entries, return null.</p>

src/main/java/org/codehaus/plexus/archiver/jar/Manifest.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,16 +36,16 @@
3636

3737
/**
3838
* Holds the data of a jar manifest.
39-
* <p/>
39+
* <p>
4040
* Manifests are processed according to the
41-
* {@link <a href="http://java.sun.com/j2se/1.4/docs/guide/jar/jar.html">Jar
42-
* file specification.</a>}.
41+
* <a href="http://java.sun.com/j2se/1.4/docs/guide/jar/jar.html">Jar
42+
* file specification.</a>
4343
* Specifically, a manifest element consists of
4444
* a set of attributes and sections. These sections in turn may contain
4545
* attributes. Note in particular that this may result in manifest lines
4646
* greater than 72 bytes (including line break) being wrapped and continued
4747
* on the next line. If an application can not handle the continuation
48-
* mechanism, it is a defect in the application, not this task.
48+
* mechanism, it is a defect in the application, not this task.</p>
4949
*
5050
* @since Ant 1.4
5151
*/

src/main/java/org/codehaus/plexus/archiver/tar/TarArchiver.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ public class TarArchiver
6464
/**
6565
* Set how to handle long files, those with a path&gt;100 chars.
6666
* Optional, default=warn.
67-
* <p/>
67+
* <p>
6868
* Allowable values are
6969
* <ul>
7070
* <li> truncate - paths are truncated to the maximum length
@@ -75,6 +75,7 @@ public class TarArchiver
7575
* <li> posixwarn - posix extensions are used (with warning) for any paths greater than the maximum.
7676
* <li> omit - paths greater than the maximum are omitted from the archive
7777
* </ul>
78+
* </p>
7879
*
7980
* @param mode the mode to handle long file names.
8081
*/

src/main/java/org/codehaus/plexus/archiver/tar/TarUnArchiver.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ public TarUnArchiver( File sourceFile )
5656

5757
/**
5858
* Set decompression algorithm to use; default=none.
59-
* <p/>
59+
* <p>
6060
* Allowable values are
6161
* <ul>
6262
* <li>none - no compression</li>
@@ -65,6 +65,7 @@ public TarUnArchiver( File sourceFile )
6565
* <li>snappy - Snappy compression</li>
6666
* <li>xz - Xz compression</li>
6767
* </ul>
68+
* </p>
6869
*
6970
* @param method compression method
7071
*/

src/main/java/org/codehaus/plexus/archiver/war/WarArchiver.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
* An extension of &lt;jar&gt; to create a WAR archive.
2929
* Contains special treatment for files that should end up in the
3030
* <code>WEB-INF/lib</code>, <code>WEB-INF/classes</code> or
31-
* <code>WEB-INF</code> directories of the Web Application Archive.</p>
31+
* <code>WEB-INF</code> directories of the Web Application Archive.
3232
* <p>
3333
* (The War task is a shortcut for specifying the particular layout of a WAR file.
3434
* The same thing can be accomplished by using the <i>prefix</i> and <i>fullpath</i>
@@ -72,7 +72,7 @@ public void setIgnoreWebxml( boolean excpectWebXml )
7272
/**
7373
* Indicates if the client is required to supply web.xml
7474
*
75-
* @param excpectWebXml true if web xml is *expected* from the client
75+
* @param expectWebXml true if web xml is *expected* from the client
7676
*/
7777
public void setExpectWebXml( boolean expectWebXml )
7878
{

src/main/java/org/codehaus/plexus/archiver/zip/AbstractZipArchiver.java

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -480,7 +480,6 @@ protected void zipFile( InputStreamSupplier in, ConcurrentJarCreator zOut, Strin
480480

481481
/**
482482
* Method that gets called when adding from java.io.File instances.
483-
* <p/>
484483
* <p>
485484
* This implementation delegates to the six-arg version.</p>
486485
*
@@ -694,11 +693,9 @@ protected boolean createEmptyZip( File zipFile )
694693

695694
/**
696695
* Do any clean up necessary to allow this instance to be used again.
697-
* <p/>
698696
* <p>
699697
* When we get here, the Zip file has been closed and all we
700698
* need to do is to reset some globals.</p>
701-
* <p/>
702699
* <p>
703700
* This method will only reset globals that have been changed
704701
* during execute(), it will not alter the attributes or nested

src/main/java/org/codehaus/plexus/archiver/zip/AbstractZipUnArchiver.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ public AbstractZipUnArchiver( final File sourceFile )
5555

5656
/**
5757
* Sets the encoding to assume for file names and comments.
58-
* <p/>
5958
* <p>
6059
* Set to <code>native-encoding</code> if you want your platform's native encoding, defaults to UTF8.
6160
* </p>

0 commit comments

Comments
 (0)