Skip to content

Commit 861188f

Browse files
committed
Javadoc: Add missing comments
1 parent 758474e commit 861188f

File tree

9 files changed

+92
-2
lines changed

9 files changed

+92
-2
lines changed

commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/AbstractSyncTask.java

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,21 @@
5151
* </ul>
5252
*/
5353
public abstract class AbstractSyncTask extends VfsTask {
54+
5455
/**
5556
* Information about a source file.
5657
*/
5758
public static class SourceInfo {
59+
5860
private String file;
5961

62+
/**
63+
* Constructs a new instance.
64+
*/
65+
public SourceInfo() {
66+
// empty
67+
}
68+
6069
/**
6170
* Sets the file.
6271
*
@@ -75,6 +84,13 @@ public void setFile(final String file) {
7584

7685
private String filesList;
7786

87+
/**
88+
* Constructs a new instance.
89+
*/
90+
public AbstractSyncTask() {
91+
// empty
92+
}
93+
7894
/**
7995
* Adds a nested &lt;src&gt; element.
8096
*

commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/CopyTask.java

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,13 @@ public class CopyTask extends AbstractSyncTask {
3232
private boolean overwrite;
3333
private boolean preserveLastModified = true;
3434

35+
/**
36+
* Constructs a new instance.
37+
*/
38+
public CopyTask() {
39+
// empty
40+
}
41+
3542
/**
3643
* Handles an out-of-date file.
3744
*
@@ -64,13 +71,17 @@ protected void handleUpToDateFile(final FileObject srcFile, final FileObject des
6471
}
6572

6673
/**
74+
* Tests whether overwrite is enabled.
75+
*
6776
* @return the current value of overwrite
6877
*/
6978
public boolean isOverwrite() {
7079
return overwrite;
7180
}
7281

7382
/**
83+
* Tests whether preserve last modified is enabled.
84+
*
7485
* @return the current value of preserveLastModified
7586
*/
7687
public boolean isPreserveLastModified() {
@@ -87,7 +98,7 @@ public void setOverwrite(final boolean overwrite) {
8798
}
8899

89100
/**
90-
* Enable/disable preserving last modified time of copied files.
101+
* Sets preserving last modified time of copied files.
91102
*
92103
* @param preserveLastModified true if the last modified time should be preserved.
93104
*/

commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/DeleteTask.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,18 @@
2929
* </p>
3030
*/
3131
public class DeleteTask extends VfsTask {
32+
3233
private String file;
3334
private String srcDirUrl;
3435
private String filesList;
3536

37+
/**
38+
* Constructs a new instance.
39+
*/
40+
public DeleteTask() {
41+
// empty
42+
}
43+
3644
/**
3745
* Executes this task.
3846
*

commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/MkdirTask.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,13 @@ public class MkdirTask extends VfsTask {
2828

2929
private String dirName;
3030

31+
/**
32+
* Constructs a new instance.
33+
*/
34+
public MkdirTask() {
35+
// empty
36+
}
37+
3138
/**
3239
* Executes the task.
3340
*

commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/MoveTask.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,16 @@
2828
* </p>
2929
*/
3030
public class MoveTask extends CopyTask {
31+
3132
private boolean tryRename;
3233

34+
/**
35+
* Constructs a new instance.
36+
*/
37+
public MoveTask() {
38+
// empty
39+
}
40+
3341
/**
3442
* Handles a single source file.
3543
*/

commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/ShowFileTask.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,13 @@ public class ShowFileTask extends VfsTask {
3737
private boolean showContent;
3838
private boolean recursive;
3939

40+
/**
41+
* Constructs a new instance.
42+
*/
43+
public ShowFileTask() {
44+
// empty
45+
}
46+
4047
/**
4148
* Executes the task.
4249
*

commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/SyncTask.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,13 @@
2323
*/
2424
public class SyncTask extends CopyTask {
2525

26+
/**
27+
* Constructs a new instance.
28+
*/
29+
public SyncTask() {
30+
// empty
31+
}
32+
2633
/**
2734
* Check if this task cares about destination files with a missing source file.
2835
*/

commons-vfs2-ant/src/main/java/org/apache/commons/vfs2/tasks/VfsTask.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,13 @@
3131
*/
3232
public class VfsTask extends Task {
3333

34+
/**
35+
* Constructs a new instance.
36+
*/
37+
public VfsTask() {
38+
// empty
39+
}
40+
3441
/**
3542
* A commons-logging wrapper for Ant logging.
3643
*/

pom.xml

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -314,8 +314,27 @@
314314
<head>To Do:</head>
315315
</tag>
316316
</tags>
317-
<aggregate>true</aggregate>
318317
</configuration>
318+
<reportSets>
319+
<reportSet>
320+
<id>non-aggregate</id>
321+
<configuration>
322+
<!-- Specific configuration for the non aggregate report -->
323+
</configuration>
324+
<reports>
325+
<report>javadoc</report>
326+
</reports>
327+
</reportSet>
328+
<reportSet>
329+
<id>aggregate</id>
330+
<configuration>
331+
<!-- Specific configuration for the aggregate report -->
332+
</configuration>
333+
<reports>
334+
<report>aggregate</report>
335+
</reports>
336+
</reportSet>
337+
</reportSets>
319338
</plugin>
320339
<plugin>
321340
<groupId>com.github.spotbugs</groupId>

0 commit comments

Comments
 (0)