Skip to content
This repository has been archived by the owner on Dec 27, 2023. It is now read-only.

Commit

Permalink
Fixed other JavaDoc issues
Browse files Browse the repository at this point in the history
Ignoring parts during building
  • Loading branch information
khmarbaise committed Jan 28, 2019
1 parent d49aaae commit 68b678b
Show file tree
Hide file tree
Showing 11 changed files with 62 additions and 25 deletions.
9 changes: 9 additions & 0 deletions plexus-component-metadata/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,13 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-plugin-plugin</artifactId>
</plugin>
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<additionalparam>-Xdoclint:none</additionalparam>
<failOnError>false</failOnError>
</configuration>
</plugin>
</plugins>
</reporting>

Expand Down Expand Up @@ -119,4 +126,6 @@
</build>
</profile>
</profiles>


</project>
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@

/**
* ???
*
* @plexus.component role="foo"
*
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ public void testComponentsMerge()
* nested elements within a component.</em><p>
* <em>Keeping this around for testing MergeStrategy implmentation.</em>
*
* @throws Exception
* @throws Exception in case of an error.
*/
public void testDeepComponentsMerge()
throws Exception
Expand Down
11 changes: 11 additions & 0 deletions plexus-container-default/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,15 @@
</plugin>
</plugins>
</build>
<reporting>
<plugins>
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<additionalparam>-Xdoclint:none</additionalparam>
<failOnError>false</failOnError>
</configuration>
</plugin>
</plugins>
</reporting>
</project>
Original file line number Diff line number Diff line change
Expand Up @@ -31,32 +31,47 @@ public class DyanamicComponentKungFuTest
/**
* Component additions during container operation.
*
* 1. Add a component at runtime
* -> Additions could be made by specifying an URL which will be compatible with Wagon
* and specifically Maven's way of using Wagon.
* <ol>
* <li>Add a component at runtime
* <ul>
* <li>Additions could be made by specifying an URL which will be compatible with Wagon
* and specifically Maven's way of using Wagon.</li>
* </ul>
* </li>
*
* 2. Configure the dynamically added component
* -> We need to be able to deal with different flavours of components but we can focus
* <li>Configure the dynamically added component
* <ul>
* <li>We need to be able to deal with different flavours of components but we can focus
* on Plexus components to start with. But some components may have meta information
* and some may not like pico components. But one of the first flavours I want to
* support is phoenix components because I specifically need the FTP server.
* support is phoenix components because I specifically need the FTP server.</li>
* </ul>
* </li>
*
* 3. Let the component perform its role
* <li>Let the component perform its role</li>
* <li>Suspend the component
* <ol type="a">
* <li>Define the criteria for which we can suspend a component
* <ul>
* <li>When there are no client connections?</li>
* <li>Even when there are no connections and a client tries to obtain a connection what do we do?</li>
* <li>If we are in desperate need to suspend the component, say for urgent security requirement, and
* clients simply won't bugger off what do we do?</li>
* </ul>
* </li>
* </ol>
* </li>
*
* 4. Suspend the component
* a) Define the criteria for which we can suspend a component
* -> When there are no client connections?
* -> Even when there are no connections and a client tries to obtain a connection what do we do?
* -> If we are in desperate need to suspend the component, say for urgent security requirement, and
* clients simply won't bugger off what do we do?
* <li>Reconfigure the component</li>
*
* 5. Reconfigure the component
* <li>Resume the component</li>
*
* 6. Resume the component
* <li>Let the component perform its role</li>
*
* 7. Let the component perform its role
*
* 8. Release the component
* <li>Release the component</li>
* </ol>
*
* @throws Exception in case of a failure.
*/
public void testAdditionOfComponentDuringContainerOperation()
throws Exception
Expand All @@ -80,6 +95,8 @@ public void testAdditionOfComponentDuringContainerOperation()
* and error but until much field testing has occurred I'm sure there will be
* instances where miscalculations happen simply due to lack of experience and
* usage with dynamic component replacement.
*
* @throws Exception in case of a failure.
*/
public void testComponentReplacementDuringContainerOperation()
throws Exception
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public abstract class AbstractCompositionResolverTest

/**
*
* @return
* @return {@link CompositionResolver}
*/
protected abstract CompositionResolver getCompositionResolver();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ public void testThreads1()

/**
* Tests that multiple concurrent threads don't acquire different components.
* @throws Exception in case of an error.
*/
public void testThreads1000()
throws Exception
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ public void testSetThreshold()

/**
* There is only one logger instance pr component even if looked up more that once.
* @throws Exception in case of an error.
*/
public void testActiveLoggerCount()
throws Exception
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@

/**
*
* @author <a href="mailto:peter at realityforge.org">Peter Donald</a>
* @version $Revision$ $Date$
* @author peter at realityforge.org Peter Donald
*/
public class LogEnabledTest
extends TestCase
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
/**
* Component counts number of created instances of it.
*
* @author <a href="mailto: ptab@newitech.com">Piotr Tabor</a>
* @author ptab at newitech.com Piotr Tabor
*/
public class CountInstancesComponent
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
*/

/**
* @component.version 2.0
* 2.0
*/
public class DefaultComponentB
implements ComponentB
Expand Down

0 comments on commit 68b678b

Please sign in to comment.