Skip to content

Commit

Permalink
Improve Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
essobedo committed May 2, 2024
1 parent 75f4c1d commit d5c6550
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@

/**
* A fork of {@link PaxExam} that supports external resources which can be created and destroyed outside Karaf.
* <p>
* This runner is intended to be used with {@link UseExternalResourceProvider} annotation in order to create the
* external resources that are needed by the test. Please note that due to the way PaxExam works, the class cannot be
* the same as the test class, but it can be a static inner class of it otherwise the class will need to be resolved
* within Karaf which is what we want to avoid.
*/
public class PaxExamWithExternalResource extends Runner implements Filterable, Sortable {
private static final Logger LOG = LoggerFactory.getLogger(PaxExamWithExternalResource.class);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
* Annotation to specify the class that provides the methods to create all the external resources required by the test.
* In the provider class, each public static method that returns an instance of a subtype of {@link ExternalResource}
* with no parameters is considered as an {@link ExternalResource} supplier, so it will be invoked before executing
* the test and {@code PaxExamWithExternalResource} will ensure that t.
* the test and {@code PaxExamWithExternalResource} will take care of its lifecycle making sure that it is created and
* destroyed outside Karaf.
*
* @see PaxExamWithExternalResource
*/
Expand Down

0 comments on commit d5c6550

Please sign in to comment.