Skip to content

Commit a5f60fd

Browse files
committed
Fix Javadoc errors/warnings
1 parent 50db603 commit a5f60fd

File tree

9 files changed

+30
-48
lines changed

9 files changed

+30
-48
lines changed

src/main/java/org/codehaus/classworlds/BytesURLConnection.java

-4
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,6 @@
2222
import java.io.ByteArrayInputStream;
2323

2424
/**
25-
* @author Hani Suleiman ([email protected])
26-
* <p/>
27-
* Date: Oct 20, 2003
28-
* Time: 12:46:01 AM
2925
*/
3026
@Deprecated
3127
public class BytesURLConnection extends URLConnection

src/main/java/org/codehaus/classworlds/ClassRealm.java

+4-6
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,11 @@ STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
5151
import java.util.Enumeration;
5252

5353
/**
54-
* Autonomous sub-portion of a <code>ClassWorld</code>.
55-
* <p/>
56-
* <p/>
57-
* This class most closed maps to the <code>ClassLoader</code>
54+
* <p>Autonomous sub-portion of a <code>ClassWorld</code>.</p>
55+
*
56+
* <p>This class most closed maps to the <code>ClassLoader</code>
5857
* role from Java and in facts can provide a <code>ClassLoader</code>
59-
* view of itself using {@link #getClassLoader}.
60-
* </p>
58+
* view of itself using {@link #getClassLoader}.</p>
6159
*
6260
* @author <a href="mailto:[email protected]">bob mcwhirter</a>
6361
* @author <a href="mailto:[email protected]">Jason van Zyl</a>

src/main/java/org/codehaus/classworlds/ConfiguratorAdapter.java

-4
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,6 @@
2121
import java.net.MalformedURLException;
2222

2323
/**
24-
* Created by IntelliJ IDEA.
25-
*
26-
* @uthor: Andrew Williams
27-
* @since: Nov 25, 2006
2824
*/
2925
@Deprecated
3026
public class ConfiguratorAdapter

src/main/java/org/codehaus/classworlds/DefaultClassRealm.java

+1
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ public void addConstituent( URL constituent )
9292
*
9393
* @param constituent class name
9494
* @param b the class definition as a byte[]
95+
* @throws ClassNotFoundException when class couldn't be loaded
9596
*/
9697
public void addConstituent(String constituent,
9798
byte[] b) throws ClassNotFoundException

src/main/java/org/codehaus/plexus/classworlds/launcher/ConfigurationHandler.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -40,18 +40,18 @@ public interface ConfigurationHandler
4040
/**
4141
* Define a new realm
4242
* @param realmName the new realm name
43-
* @throws DuplicateRealmException
43+
* @throws DuplicateRealmException when realm with name already exists
4444
*/
4545
void addRealm( String realmName )
4646
throws DuplicateRealmException;
4747

4848
/**
4949
* Add an import specification from a realm
50-
* @param relamName the realm name
50+
* @param realmName the realm name
5151
* @param importSpec the import specification
52-
* @throws NoSuchRealmException
52+
* @throws NoSuchRealmException if realm doesn't exist
5353
*/
54-
void addImportFrom( String relamName, String importSpec )
54+
void addImportFrom( String realmName, String importSpec )
5555
throws NoSuchRealmException;
5656

5757
/**

src/main/java/org/codehaus/plexus/classworlds/launcher/ConfigurationParser.java

+7-1
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,12 @@ public ConfigurationParser( ConfigurationHandler handler, Properties systemPrope
6666

6767
/**
6868
* Parse launcher configuration file and send events to the handler.
69+
*
70+
* @param is the inputstream
71+
* @throws IOException when IOException occurs
72+
* @throws ConfigurationException when ConfigurationException occurs
73+
* @throws DuplicateRealmException when realm already exists
74+
* @throws NoSuchRealmException when realm doesn't exist
6975
*/
7076
public void parse( InputStream is )
7177
throws IOException, ConfigurationException, DuplicateRealmException, NoSuchRealmException
@@ -315,7 +321,7 @@ else if ( line.startsWith( OPTIONALLY_PREFIX ) )
315321
* a valid path element.
316322
* @throws FileNotFoundException If the line does not represent
317323
* a valid path element in the filesystem.
318-
* @throws ConfigurationException
324+
* @throws ConfigurationException will never occur (thrown for backwards compatibility)
319325
*/
320326
protected void loadGlob( String line,
321327
boolean optionally )

src/main/java/org/codehaus/plexus/classworlds/launcher/Launcher.java

+14-23
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,15 @@
3131
import org.codehaus.plexus.classworlds.realm.NoSuchRealmException;
3232

3333
/**
34-
* Command-line invokable application launcher.
35-
* <p/>
36-
* <p/>
37-
* This launcher class assists in the creation of classloaders and <code>ClassRealm</code>s
34+
* <p>Command-line invokable application launcher.</p>
35+
*
36+
* <p>This launcher class assists in the creation of classloaders and <code>ClassRealm</code>s
3837
* from a configuration file and the launching of the application's <code>main</code>
39-
* method from the correct class loaded through the correct classloader.
40-
* </p>
41-
* <p/>
42-
* <p/>
43-
* The path to the configuration file is specified using the <code>classworlds.conf</code>
38+
* method from the correct class loaded through the correct classloader.</p>
39+
*
40+
* <p> The path to the configuration file is specified using the <code>classworlds.conf</code>
4441
* system property, typically specified using the <code>-D</code> switch to
45-
* <code>java</code>.
46-
* </p>
42+
* <code>java</code>.</p>
4743
*
4844
* @author <a href="mailto:[email protected]">bob mcwhirter</a>
4945
*/
@@ -239,12 +235,9 @@ public void launch( String[] args )
239235
}
240236

241237
/**
242-
* Attempt to launch the application through the enhanced main method.
243-
* <p/>
244-
* <p/>
245-
* This will seek a method with the exact signature of:
246-
* </p>
247-
* <p/>
238+
* <p>Attempt to launch the application through the enhanced main method.</p>
239+
*
240+
* <p>This will seek a method with the exact signature of:</p>
248241
* <pre>
249242
* public static void main(String[] args, ClassWorld world)
250243
* </pre>
@@ -297,12 +290,10 @@ protected void launchEnhanced( String[] args )
297290
}
298291

299292
/**
300-
* Attempt to launch the application through the standard main method.
301-
* <p/>
302-
* <p/>
303-
* This will seek a method with the exact signature of:
304-
* </p>
305-
* <p/>
293+
* <p>Attempt to launch the application through the standard main method.</p>
294+
*
295+
* <p>This will seek a method with the exact signature of:</p>
296+
306297
* <pre>
307298
* public static void main(String[] args)
308299
* </pre>

src/main/java/org/codehaus/plexus/classworlds/strategy/Strategy.java

-3
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,6 @@
2525
/**
2626
* A strategy is a class for defining how classes and resources are located
2727
* in classworlds.
28-
*
29-
* @uthor: Andrew Williams
30-
* @since: Nov 19, 2006
3128
*/
3229
public interface Strategy
3330
{

src/main/java/org/codehaus/plexus/classworlds/strategy/StrategyFactory.java

-3
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,6 @@
2020

2121
/**
2222
* StrategyFactory loads a strategy, either default or from a given hint.
23-
*
24-
* @uthor: Andrew Williams
25-
* @since: Nov 19, 2006
2623
*/
2724
public class StrategyFactory
2825
{

0 commit comments

Comments
 (0)