Skip to content

Commit 9f40037

Browse files
mthmuldersmthmulders
committed
[NOJIRA] Javadoc cleanup in preparation of release
Closes #85.
1 parent 4e93c56 commit 9f40037

32 files changed

+253
-248
lines changed

‎src/main/java/org/apache/maven/shared/utils/Os.java

+1-3
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,10 @@
2626

2727
/**
2828
* <p>Condition that tests the OS type.</p>
29-
* <p/>
3029
* <p>This class got copied over from Apache ANT.
3130
* Even the version from plexus-utils was
32-
* only an ANT fork!<br/>
31+
* only an ANT fork!
3332
* The last time it got copied was on 2011-08-12</p>
34-
* <p/>
3533
* <p>When merging changes please take care of the special
3634
* OS_FAMILY handling in this version of Os.java!</p>
3735
*

‎src/main/java/org/apache/maven/shared/utils/PathTool.java

+7-7
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,13 @@
2626
import javax.annotation.Nullable;
2727

2828
/**
29-
* Path tool contains static methods to assist in determining path-related
30-
* information such as relative paths.
31-
* <p/>
29+
* <p>Path tool contains static methods to assist in determining path-related
30+
* information such as relative paths.</p>
31+
* <p>
3232
* This class originally got developed at Apache Anakia and later maintained
3333
* in maven-utils of Apache Maven-1.
3434
* Some external fixes by Apache Committers have been applied later.
35+
* </p>
3536
*/
3637
public class PathTool
3738
{
@@ -55,9 +56,9 @@ public PathTool()
5556
* file separators. The relative path returned is formed using
5657
* forward slashes as it is expected this path is to be used as a
5758
* link in a web page (again mimicking Anakia's behavior).
58-
* <p/>
59+
* <p>
5960
* This method is thread-safe.
60-
* <br/>
61+
* </p>
6162
* <pre>
6263
* PathTool.getRelativePath( null, null ) = ""
6364
* PathTool.getRelativePath( null, "/usr/local/java/bin" ) = ""
@@ -111,8 +112,7 @@ public static String getRelativePath( @Nullable String basedir, @Nullable String
111112
}
112113

113114
/**
114-
* This method can calculate the relative path between two pathes on a file system.
115-
* <br/>
115+
* <p>This method can calculate the relative path between two paths on a file system.</p>
116116
* <pre>
117117
* PathTool.getRelativeFilePath( null, null ) = ""
118118
* PathTool.getRelativeFilePath( null, "/usr/local/java/bin" ) = ""

‎src/main/java/org/apache/maven/shared/utils/StringUtils.java

+15-19
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,6 @@ public static String trim( String str )
104104
*
105105
* @param str String target to delete whitespace from
106106
* @return the String without whitespace
107-
* @throws NullPointerException
108107
*/
109108
@Nonnull public static String deleteWhitespace( @Nonnull String str )
110109
{
@@ -122,7 +121,7 @@ public static String trim( String str )
122121

123122
/**
124123
* <p>Checks if a String is non <code>null</code> and is
125-
* not empty (<code>length > 0</code>).</p>
124+
* not empty (<code>length &gt; 0</code>).</p>
126125
*
127126
* @param str the String to check
128127
* @return true if the String is non-null, and not length zero
@@ -816,7 +815,7 @@ public static String replace( @Nullable String text, @Nullable String repl, @Nul
816815
//--------------------------------------------------------------------------
817816

818817
/**
819-
* <p>Center a String in a larger String of size <code>n</code>.<p>
818+
* <p>Center a String in a larger String of size <code>n</code>.</p>
820819
*
821820
* <p>Uses spaces as the value to buffer the String with.
822821
* Equivalent to <code>center(str, size, " ")</code>.</p>
@@ -1174,7 +1173,7 @@ else if ( ch < 32 )
11741173
* @param str String to repeat
11751174
* @param repeat number of times to repeat str
11761175
* @return String with repeated String
1177-
* @throws NegativeArraySizeException if <code>repeat < 0</code>
1176+
* @throws NegativeArraySizeException if <code>repeat &lt; 0</code>
11781177
* @throws NullPointerException if str is <code>null</code>
11791178
*/
11801179
@Nonnull public static String repeat( @Nonnull String str, int repeat )
@@ -1979,14 +1978,12 @@ private static void reverseArray( @Nonnull String... array )
19791978
//--------------------------------------------------------------------------
19801979

19811980
/**
1982-
* Turn "Now is the time for all good men" into "Now is the time for..."
1983-
* <p/>
1984-
* Specifically:
1985-
* <p/>
1986-
* If str is less than max characters long, return it.
1981+
* <p>Turn "Now is the time for all good men" into "Now is the time for..."</p>
1982+
* <p>Specifically:</p>
1983+
* <p>If str is less than max characters long, return it.
19871984
* Else abbreviate it to (substring(str, 0, max-3) + "...").
19881985
* If maxWidth is less than 3, throw an IllegalArgumentException.
1989-
* In no case will it return a string of length greater than maxWidth.
1986+
* In no case will it return a string of length greater than maxWidth.</p>
19901987
*
19911988
* @param s The string to be abbreviated.
19921989
* @param maxWidth maximum length of result string
@@ -1999,12 +1996,13 @@ private static void reverseArray( @Nonnull String... array )
19991996

20001997
/**
20011998
* Turn "Now is the time for all good men" into "...is the time for..."
2002-
* <p/>
1999+
* <p>
20032000
* Works like abbreviate(String, int), but allows you to specify a "left edge"
20042001
* offset. Note that this left edge is not necessarily going to be the leftmost
20052002
* character in the result, or the first
20062003
* character following the ellipses, but it will appear somewhere in the result.
20072004
* In no case will it return a string of length greater than maxWidth.
2005+
* </p>
20082006
*
20092007
* @param s String to abbreviate.
20102008
* @param offset left edge of source string
@@ -2051,8 +2049,9 @@ private static void reverseArray( @Nonnull String... array )
20512049
* Compare two strings, and return the portion where they differ.
20522050
* (More precisely, return the remainder of the second string,
20532051
* starting from where it's different from the first.)
2054-
* <p/>
2055-
* E.g. strdiff("i am a machine", "i am a robot") -> "robot"
2052+
* <p>
2053+
* E.g. strdiff("i am a machine", "i am a robot") &rarr; "robot"
2054+
* </p>
20562055
*
20572056
* @param s1 The first string.
20582057
* @param s2 The second string.
@@ -2071,7 +2070,7 @@ public static String difference( @Nonnull String s1, @Nonnull String s2 )
20712070
/**
20722071
* Compare two strings, and return the index at which the strings begin to differ.
20732072
* <p>
2074-
* E.g. strdiff("i am a machine", "i am a robot") -> 7
2073+
* E.g. strdiff("i am a machine", "i am a robot") &rarr; 7
20752074
* </p>
20762075
*
20772076
* @param s1 The first string.
@@ -2188,7 +2187,6 @@ public static String interpolate( String text, @Nonnull Map<?, ?> namespace )
21882187
/**
21892188
* Converts the first character of the given String to lowercase.
21902189
* This method does <i>not</i> trim spaces!
2191-
* <p/>
21922190
*
21932191
* @param data the String to get it's first character lower-cased.
21942192
* @return data string with the first character transformed to lowercase
@@ -2205,9 +2203,8 @@ public static String interpolate( String text, @Nonnull Map<?, ?> namespace )
22052203
}
22062204

22072205
/**
2208-
* Take the input string and un-camel-case it.
2209-
* <p/>
2210-
* 'ThisIsIt' will become 'this-is-it'.
2206+
* <p>Take the input string and un-camel-case it.</p>
2207+
* <p>'ThisIsIt' will become 'this-is-it'.</p>
22112208
*
22122209
* @param view the view
22132210
* @return deHumped String
@@ -2519,7 +2516,6 @@ public static boolean contains( @Nullable String str, @Nullable String searchStr
25192516

25202517
/**
25212518
* <p>Checks if String ends with a search String, handling <code>null</code>.</p>
2522-
* <p/>
25232519
* <p>A <code>null</code> String will return <code>false</code>.</p>
25242520
*
25252521
* <pre>

‎src/main/java/org/apache/maven/shared/utils/cli/Arg.java

+1
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ public interface Arg
3333

3434
/**
3535
* @param line the line of arguments
36+
* @throws CommandLineException in case of unbalanced quotes.
3637
*/
3738
void setLine( String line ) throws CommandLineException;
3839

‎src/main/java/org/apache/maven/shared/utils/cli/Commandline.java

+4-5
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,14 @@
3737
import org.apache.maven.shared.utils.cli.shell.Shell;
3838

3939
/**
40-
* <p/>
40+
* <p>
4141
* Commandline objects help handling command lines specifying processes to
4242
* execute.
4343
* </p>
44-
* <p/>
44+
* <p>
4545
* The class can be used to define a command line as nested elements or as a
4646
* helper to define a command line by an application.
4747
* </p>
48-
* <p/>
4948
* <code>
5049
* &lt;someelement&gt;<br>
5150
* &nbsp;&nbsp;&lt;acommandline executable="/executable/to/run"&gt;<br>
@@ -55,8 +54,7 @@
5554
* &nbsp;&nbsp;&lt;/acommandline&gt;<br>
5655
* &lt;/someelement&gt;<br>
5756
* </code>
58-
* </p>
59-
* <p/>
57+
* <p>
6058
* The element <code>someelement</code> must provide a method
6159
* <code>createAcommandline</code> which returns an instance of this class.
6260
* </p>
@@ -89,6 +87,7 @@ public Commandline( Shell shell )
8987
* Shell is autodetected from operating system.
9088
*
9189
* @param toProcess the command to process
90+
* @throws CommandLineException in case of unbalanced quotes.
9291
*/
9392
public Commandline( String toProcess ) throws CommandLineException
9493
{

‎src/main/java/org/apache/maven/shared/utils/cli/StreamConsumer.java

+4-5
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,11 @@
2222
import java.io.IOException;
2323

2424
/**
25-
* Works in concert with the StreamPumper class to
25+
* <p>Works in concert with the StreamPumper class to
2626
* allow implementations to gain access to the lines being
27-
* "Pumped".
28-
* <p/>
29-
* Please note that implementations of this interface can be expected to be
30-
* called from arbitrary threads and must therefore be threadsafe.
27+
* "Pumped".</p>
28+
* <p>Please note that implementations of this interface can be expected to be
29+
* called from arbitrary threads and must therefore be threadsafe.</p>
3130
*
3231
* @author <a href="mailto:[email protected]">Florin Vancea</a>
3332
* @author <a href="mailto:[email protected]">Paul Julius</a>

‎src/main/java/org/apache/maven/shared/utils/cli/javatool/AbstractJavaTool.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@
3636
/**
3737
* Abstract implementation of a {@link JavaTool}.
3838
*
39-
* @author Tony Chemit <[email protected]>
39+
* @author <a href="mailto:[email protected]">Tony Chemit</a>
4040
* @since 0.5
41-
* @param <Request>
41+
* @param <Request> Tool-specific request type
4242
*/
4343
public abstract class AbstractJavaTool<Request extends JavaToolRequest>
4444
extends AbstractLogEnabled

‎src/main/java/org/apache/maven/shared/utils/cli/javatool/AbstractJavaToolRequest.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
/**
2525
* Abstract implementation of a {@link JavaToolRequest}.
2626
*
27-
* @author Tony Chemit <[email protected]>
27+
* @author <a href="mailto:[email protected]">Tony Chemit</a>
2828
* @since 0.5
2929
*/
3030
public class AbstractJavaToolRequest

‎src/main/java/org/apache/maven/shared/utils/cli/javatool/JavaTool.java

+14-19
Original file line numberDiff line numberDiff line change
@@ -20,26 +20,23 @@
2020
*/
2121

2222
/**
23-
* Describes a java tool, means a executable available in the jdk.
24-
* <p/>
25-
* The name of the tool ({@link #getJavaToolName()}) reflects the name of the executable that should exists as an
26-
* executable in the jdk, like {@code jarsigner, keytool, javadoc, ...}.
27-
* <p/>
28-
* An abstract implementation of the {@link JavaTool} named {@link AbstractJavaTool} use the command line API to execute
29-
* any user requests of this tool.
23+
* <p>Describes a java tool, means a executable available in the jdk.</p>
24+
* <p>The name of the tool ({@link #getJavaToolName()}) reflects the name of the executable that should exists as an
25+
* executable in the jdk, like {@code jarsigner, keytool, javadoc, ...}.</p>
26+
* <p>An abstract implementation of the {@link JavaTool} named {@link AbstractJavaTool} use the command line API to
27+
* execute any user requests of this tool.</p>
3028
*
31-
* @author Tony Chemit <[email protected]>
29+
* @author <a href="mailto:[email protected]">Tony Chemit</a>
3230
* @since 0.5
33-
* @param <Request>
31+
* @param <Request> Tool-specific request type
3432
*/
3533
public interface JavaTool<Request extends JavaToolRequest>
3634
{
3735

3836
/**
39-
* Return the name of the java tool. This is exactly the name (without his extension) of the executable to
40-
* find in the {@code jdk/bin} directory.
41-
* <p/>
42-
* For example: {@code jarsigner, keytool, javadoc, ...}
37+
* <p>Return the name of the java tool. This is exactly the name (without his extension) of the executable to
38+
* find in the {@code jdk/bin} directory.</p>
39+
* <p>For example: {@code jarsigner, keytool, javadoc, ...}</p>
4340
*
4441
* @return the name of the java tool.
4542
*/
@@ -55,13 +52,11 @@ public interface JavaTool<Request extends JavaToolRequest>
5552
void setToolchain( Object toolchain );
5653

5754
/**
58-
* Execute the input request and then returns the result of the execution.
59-
* <p/>
60-
* If could not create the java tool invocation, a {@link JavaToolException} will be thrown.
61-
* <p/>
62-
* If execution fails, then the result will have a none-zero {@link JavaToolResult#getExitCode()} and his
55+
* <p>Execute the input request and then returns the result of the execution.</p>
56+
* <p>If could not create the java tool invocation, a {@link JavaToolException} will be thrown.</p>
57+
* <p>If execution fails, then the result will have a none-zero {@link JavaToolResult#getExitCode()} and his
6358
* {@link JavaToolResult#getExecutionException()} will be filled with the error, otherwise the exist code will be
64-
* zero.
59+
* zero.</p>
6560
*
6661
* @param request the request to perform
6762
* @return the result of the tool execution

‎src/main/java/org/apache/maven/shared/utils/cli/javatool/JavaToolException.java

+5-6
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,12 @@
2020
*/
2121

2222
/**
23-
* Signals an error during the construction of the command line used to invoke java tool, e.g. illegal invocation
24-
* arguments.
25-
* <p/>
26-
* This should not be confused with a failure of the invoked java tool build itself which will be reported by means of a
27-
* non-zero exit code.
23+
* <p>Signals an error during the construction of the command line used to invoke java tool, e.g. illegal invocation
24+
* arguments.</p>
25+
* <p>This should not be confused with a failure of the invoked java tool build itself which will be reported by means
26+
* of a non-zero exit code.</p>
2827
*
29-
* @author Tony Chemit <[email protected]>
28+
* @author <a href="mailto:[email protected]">Tony Chemit</a>
3029
*
3130
* @see JavaToolResult#getExitCode()
3231
* @since 0.5

‎src/main/java/org/apache/maven/shared/utils/cli/javatool/JavaToolRequest.java

+7-9
Original file line numberDiff line numberDiff line change
@@ -24,27 +24,25 @@
2424
/**
2525
* Specifies the minimum parameters used to control a {@link JavaTool} invocation.
2626
*
27-
* @author Tony Chemit <[email protected]>
27+
* @author <a href="mailto:[email protected]">Tony Chemit</a>
2828
* @since 0.5
2929
*/
3030
public interface JavaToolRequest
3131
{
3232

3333
/**
34-
* Gets the value of the {@code systemOutStreamConsumer} field.
35-
* <p/>
36-
* This option field if filled is used by the commandline tool to consume system ouput stream of the jarsigner
37-
* command.
34+
* <p>Gets the value of the {@code systemOutStreamConsumer} field.</p>
35+
* <p>This option field if filled is used by the commandline tool to consume system ouput stream of the jarsigner
36+
* command.</p>
3837
*
3938
* @return the value of the {@code systemOutStreamConsumer} field.
4039
*/
4140
StreamConsumer getSystemOutStreamConsumer();
4241

4342
/**
44-
* Gets the value of the {@code systemErrorStreamConsumer} field.
45-
* <p/>
46-
* This option field if filled is used by the commandline tool to consume system error stream of the jarsigner
47-
* command.
43+
* <p>Gets the value of the {@code systemErrorStreamConsumer} field.</p>
44+
* <p>This option field if filled is used by the commandline tool to consume system error stream of the jarsigner
45+
* command.</p>
4846
*
4947
* @return the value of the {@code systemErrorStreamConsumer} field.
5048
*/

‎src/main/java/org/apache/maven/shared/utils/cli/javatool/JavaToolResult.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
/**
2626
* Describes the result of a {@link JavaTool} invocation.
2727
*
28-
* @author Tony Chemit <[email protected]>
28+
* @author <a href="mailto:[email protected]">Tony Chemit</a>
2929
* @since 0.5
3030
*/
3131
public class JavaToolResult

‎src/main/java/org/apache/maven/shared/utils/cli/shell/BourneShell.java

-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,6 @@ protected String getExecutionPreamble()
111111

112112
/**
113113
* <p>Unify quotes in a path for the Bourne Shell.</p>
114-
* <p/>
115114
* <pre>
116115
* BourneShell.quoteOneItem(null) = null
117116
* BourneShell.quoteOneItem("") = ''

‎src/main/java/org/apache/maven/shared/utils/cli/shell/CmdShell.java

-2
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@ public CmdShell()
5151
* <p>
5252
* From cmd.exe /? output:
5353
* </p>
54-
* <p/>
5554
* <pre>
5655
* If /C or /K is specified, then the remainder of the command line after
5756
* the switch is processed as a command line, where the following logic is
@@ -74,7 +73,6 @@ public CmdShell()
7473
* remove the last quote character on the command line, preserving
7574
* any text after the last quote character.
7675
* </pre>
77-
* <p/>
7876
* <p>
7977
* Always quoting the entire command line, regardless of these conditions
8078
* appears to make Windows processes invoke successfully.

0 commit comments

Comments
 (0)