Skip to content

Commit 7d26d04

Browse files
committed
fix javadoc issues
1 parent 17ed658 commit 7d26d04

File tree

53 files changed

+1958
-172
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+1958
-172
lines changed

src/test/java/org/codehaus/plexus/util/AbstractTestThread.java

+35-12
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,16 @@
2424
* </p>
2525
*
2626
* @author <a href="mailto:bert@tuaworks.co.nz">Bert van Brakel</a>
27-
*
27+
* @version $Id: $Id
28+
* @since 3.4.0
2829
*/
2930
public abstract class AbstractTestThread
3031
implements Runnable
3132
{
3233
// ~ Instance fields ----------------------------------------------------------------------------
3334
private String name;
3435

36+
/** Constant <code>DEBUG=true</code> */
3537
public static final boolean DEBUG = true;
3638

3739
private boolean isRunning = false;
@@ -68,6 +70,11 @@ public AbstractTestThread()
6870
super();
6971
}
7072

73+
/**
74+
* <p>Constructor for AbstractTestThread.</p>
75+
*
76+
* @param registry a {@link org.codehaus.plexus.util.TestThreadManager} object.
77+
*/
7178
public AbstractTestThread( TestThreadManager registry )
7279
{
7380
super();
@@ -77,7 +84,9 @@ public AbstractTestThread( TestThreadManager registry )
7784
// ~ Methods ------------------------------------------------------------------------------------
7885

7986
/**
80-
* @return
87+
* <p>Getter for the field <code>error</code>.</p>
88+
*
89+
* @return a {@link java.lang.Throwable} object.
8190
*/
8291
public Throwable getError()
8392
{
@@ -129,15 +138,19 @@ public final void start()
129138
}
130139

131140
/**
132-
* @return
141+
* <p>Getter for the field <code>errorMsg</code>.</p>
142+
*
143+
* @return a {@link java.lang.String} object.
133144
*/
134145
public String getErrorMsg()
135146
{
136147
return errorMsg;
137148
}
138149

139150
/**
140-
* @return
151+
* <p>hasFailed.</p>
152+
*
153+
* @return a boolean.
141154
*/
142155
public boolean hasFailed()
143156
{
@@ -189,15 +202,15 @@ public final void run()
189202
/**
190203
* Override this to run your custom test
191204
*
192-
* @throws Throwable
205+
* @throws java.lang.Throwable
193206
*/
194207
public abstract void doRun()
195208
throws Throwable;
196209

197210
/**
198211
* Set the registry this thread should notify when it has completed running
199212
*
200-
* @param registry
213+
* @param registry a {@link org.codehaus.plexus.util.TestThreadManager} object.
201214
*/
202215
public void setThreadRegistry( TestThreadManager registry )
203216

@@ -208,47 +221,57 @@ public void setThreadRegistry( TestThreadManager registry )
208221
/**
209222
* Test if the test has run
210223
*
211-
* @return
224+
* @return a boolean.
212225
*/
213226
public boolean hasRun()
214227
{
215228
return hasRun;
216229
}
217230

218231
/**
219-
* @param throwable
232+
* <p>Setter for the field <code>error</code>.</p>
233+
*
234+
* @param throwable a {@link java.lang.Throwable} object.
220235
*/
221236
public void setError( Throwable throwable )
222237
{
223238
error = throwable;
224239
}
225240

226241
/**
227-
* @param string
242+
* <p>Setter for the field <code>errorMsg</code>.</p>
243+
*
244+
* @param string a {@link java.lang.String} object.
228245
*/
229246
public void setErrorMsg( String string )
230247
{
231248
errorMsg = string;
232249
}
233250

234251
/**
235-
* @param b
252+
* <p>Setter for the field <code>passed</code>.</p>
253+
*
254+
* @param b a boolean.
236255
*/
237256
public void setPassed( boolean b )
238257
{
239258
passed = b;
240259
}
241260

242261
/**
243-
* @return
262+
* <p>Getter for the field <code>name</code>.</p>
263+
*
264+
* @return a {@link java.lang.String} object.
244265
*/
245266
public String getName()
246267
{
247268
return name;
248269
}
249270

250271
/**
251-
* @param string
272+
* <p>Setter for the field <code>name</code>.</p>
273+
*
274+
* @param string a {@link java.lang.String} object.
252275
*/
253276
public void setName( String string )
254277
{

src/test/java/org/codehaus/plexus/util/CollectionUtilsTest.java

+22
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,18 @@
2828

2929
import org.junit.Test;
3030

31+
/**
32+
* <p>CollectionUtilsTest class.</p>
33+
*
34+
* @author herve
35+
* @version $Id: $Id
36+
* @since 3.4.0
37+
*/
3138
public class CollectionUtilsTest
3239
{
40+
/**
41+
* <p>testMergeMaps.</p>
42+
*/
3343
@Test
3444
public void testMergeMaps()
3545
{
@@ -66,6 +76,9 @@ public void testMergeMaps()
6676
assertEquals( "z", result.get( "z" ) );
6777
}
6878

79+
/**
80+
* <p>testMergeMapArray.</p>
81+
*/
6982
@SuppressWarnings( "unchecked" )
7083
@Test
7184
public void testMergeMapArray()
@@ -119,6 +132,9 @@ public void testMergeMapArray()
119132
assertEquals( "ccc", result5.get( "c" ) );
120133
}
121134

135+
/**
136+
* <p>testMavenPropertiesLoading.</p>
137+
*/
122138
@Test
123139
public void testMavenPropertiesLoading()
124140
{
@@ -176,6 +192,9 @@ public void testMavenPropertiesLoading()
176192
assertEquals( mavenRepoRemote, (String) result.get( "maven.repo.remote" ) );
177193
}
178194

195+
/**
196+
* <p>testIteratorToListWithAPopulatedList.</p>
197+
*/
179198
@Test
180199
public void testIteratorToListWithAPopulatedList()
181200
{
@@ -196,6 +215,9 @@ public void testIteratorToListWithAPopulatedList()
196215
assertEquals( "tre", copy.get( 2 ) );
197216
}
198217

218+
/**
219+
* <p>testIteratorToListWithAEmptyList.</p>
220+
*/
199221
@Test
200222
public void testIteratorToListWithAEmptyList()
201223
{

0 commit comments

Comments
 (0)