Skip to content
This repository was archived by the owner on Dec 4, 2024. It is now read-only.

Commit 68b678b

Browse files
committed
Fixed other JavaDoc issues
Ignoring parts during building
1 parent d49aaae commit 68b678b

File tree

11 files changed

+62
-25
lines changed

11 files changed

+62
-25
lines changed

plexus-component-metadata/pom.xml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,13 @@
8080
<groupId>org.apache.maven.plugins</groupId>
8181
<artifactId>maven-plugin-plugin</artifactId>
8282
</plugin>
83+
<plugin>
84+
<artifactId>maven-javadoc-plugin</artifactId>
85+
<configuration>
86+
<additionalparam>-Xdoclint:none</additionalparam>
87+
<failOnError>false</failOnError>
88+
</configuration>
89+
</plugin>
8390
</plugins>
8491
</reporting>
8592

@@ -119,4 +126,6 @@
119126
</build>
120127
</profile>
121128
</profiles>
129+
130+
122131
</project>

plexus-component-metadata/src/test/java/org/codehaus/plexus/metadata/gleaner/AbstractWithAnnoClass.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@
1818

1919
/**
2020
* ???
21-
*
2221
* @plexus.component role="foo"
2322
*
2423
*/

plexus-component-metadata/src/test/java/org/codehaus/plexus/metadata/merge/ComponentsXmlMergerTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ public void testComponentsMerge()
198198
* nested elements within a component.</em><p>
199199
* <em>Keeping this around for testing MergeStrategy implmentation.</em>
200200
*
201-
* @throws Exception
201+
* @throws Exception in case of an error.
202202
*/
203203
public void testDeepComponentsMerge()
204204
throws Exception

plexus-container-default/pom.xml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,4 +85,15 @@
8585
</plugin>
8686
</plugins>
8787
</build>
88+
<reporting>
89+
<plugins>
90+
<plugin>
91+
<artifactId>maven-javadoc-plugin</artifactId>
92+
<configuration>
93+
<additionalparam>-Xdoclint:none</additionalparam>
94+
<failOnError>false</failOnError>
95+
</configuration>
96+
</plugin>
97+
</plugins>
98+
</reporting>
8899
</project>

plexus-container-default/src/test/java/org/codehaus/plexus/DyanamicComponentKungFuTest.java

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -31,32 +31,47 @@ public class DyanamicComponentKungFuTest
3131
/**
3232
* Component additions during container operation.
3333
*
34-
* 1. Add a component at runtime
35-
* -> Additions could be made by specifying an URL which will be compatible with Wagon
36-
* and specifically Maven's way of using Wagon.
34+
* <ol>
35+
* <li>Add a component at runtime
36+
* <ul>
37+
* <li>Additions could be made by specifying an URL which will be compatible with Wagon
38+
* and specifically Maven's way of using Wagon.</li>
39+
* </ul>
40+
* </li>
3741
*
38-
* 2. Configure the dynamically added component
39-
* -> We need to be able to deal with different flavours of components but we can focus
42+
* <li>Configure the dynamically added component
43+
* <ul>
44+
* <li>We need to be able to deal with different flavours of components but we can focus
4045
* on Plexus components to start with. But some components may have meta information
4146
* and some may not like pico components. But one of the first flavours I want to
42-
* support is phoenix components because I specifically need the FTP server.
47+
* support is phoenix components because I specifically need the FTP server.</li>
48+
* </ul>
49+
* </li>
4350
*
44-
* 3. Let the component perform its role
51+
* <li>Let the component perform its role</li>
52+
* <li>Suspend the component
53+
* <ol type="a">
54+
* <li>Define the criteria for which we can suspend a component
55+
* <ul>
56+
* <li>When there are no client connections?</li>
57+
* <li>Even when there are no connections and a client tries to obtain a connection what do we do?</li>
58+
* <li>If we are in desperate need to suspend the component, say for urgent security requirement, and
59+
* clients simply won't bugger off what do we do?</li>
60+
* </ul>
61+
* </li>
62+
* </ol>
63+
* </li>
4564
*
46-
* 4. Suspend the component
47-
* a) Define the criteria for which we can suspend a component
48-
* -> When there are no client connections?
49-
* -> Even when there are no connections and a client tries to obtain a connection what do we do?
50-
* -> If we are in desperate need to suspend the component, say for urgent security requirement, and
51-
* clients simply won't bugger off what do we do?
65+
* <li>Reconfigure the component</li>
5266
*
53-
* 5. Reconfigure the component
67+
* <li>Resume the component</li>
5468
*
55-
* 6. Resume the component
69+
* <li>Let the component perform its role</li>
5670
*
57-
* 7. Let the component perform its role
58-
*
59-
* 8. Release the component
71+
* <li>Release the component</li>
72+
* </ol>
73+
*
74+
* @throws Exception in case of a failure.
6075
*/
6176
public void testAdditionOfComponentDuringContainerOperation()
6277
throws Exception
@@ -80,6 +95,8 @@ public void testAdditionOfComponentDuringContainerOperation()
8095
* and error but until much field testing has occurred I'm sure there will be
8196
* instances where miscalculations happen simply due to lack of experience and
8297
* usage with dynamic component replacement.
98+
*
99+
* @throws Exception in case of a failure.
83100
*/
84101
public void testComponentReplacementDuringContainerOperation()
85102
throws Exception

plexus-container-default/src/test/java/org/codehaus/plexus/component/composition/AbstractCompositionResolverTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ public abstract class AbstractCompositionResolverTest
3636

3737
/**
3838
*
39-
* @return
39+
* @return {@link CompositionResolver}
4040
*/
4141
protected abstract CompositionResolver getCompositionResolver();
4242

plexus-container-default/src/test/java/org/codehaus/plexus/component/manager/SlowComponentClassicSingletonComponentManagerTest.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ public void testThreads1()
3333

3434
/**
3535
* Tests that multiple concurrent threads don't acquire different components.
36+
* @throws Exception in case of an error.
3637
*/
3738
public void testThreads1000()
3839
throws Exception

plexus-container-default/src/test/java/org/codehaus/plexus/logging/AbstractLoggerManagerTest.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ public void testSetThreshold()
5252

5353
/**
5454
* There is only one logger instance pr component even if looked up more that once.
55+
* @throws Exception in case of an error.
5556
*/
5657
public void testActiveLoggerCount()
5758
throws Exception

plexus-container-default/src/test/java/org/codehaus/plexus/logging/LogEnabledTest.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,7 @@
2020

2121
/**
2222
*
23-
* @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
24-
* @version $Revision$ $Date$
23+
* @author peter at realityforge.org Peter Donald
2524
*/
2625
public class LogEnabledTest
2726
extends TestCase

plexus-container-default/src/test/java/org/codehaus/plexus/test/CountInstancesComponent.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
/**
2020
* Component counts number of created instances of it.
2121
*
22-
* @author <a href="mailto: ptab@newitech.com">Piotr Tabor</a>
22+
* @author ptab at newitech.com Piotr Tabor
2323
*/
2424
public class CountInstancesComponent
2525
{

0 commit comments

Comments
 (0)