Skip to content

Commit

Permalink
Fix Javadoc warnings
Browse files Browse the repository at this point in the history
Closes: #783
  • Loading branch information
sbrannen committed Apr 8, 2017
1 parent 6164e68 commit 401b627
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
Expand Up @@ -22,7 +22,7 @@


/** /**
* {@code @CsvSource} is a special {@link ArgumentsSource} which reads * {@code @CsvSource} is a special {@link ArgumentsSource} which reads
* comma-separated values (CSV) from its {@link value} attribute. * comma-separated values (CSV) from its {@link #value} attribute.
* *
* <p>These values are then provided as arguments to {@code @ParameterizedTest} * <p>These values are then provided as arguments to {@code @ParameterizedTest}
* methods using a {@code CsvArgumentsProvider}. * methods using a {@code CsvArgumentsProvider}.
Expand Down
Expand Up @@ -24,6 +24,7 @@
import org.junit.platform.commons.util.Preconditions; import org.junit.platform.commons.util.Preconditions;
import org.junit.platform.commons.util.ToStringBuilder; import org.junit.platform.commons.util.ToStringBuilder;
import org.junit.platform.engine.TestDescriptor; import org.junit.platform.engine.TestDescriptor;
import org.junit.platform.engine.TestDescriptor.Type;
import org.junit.platform.engine.TestSource; import org.junit.platform.engine.TestSource;
import org.junit.platform.engine.TestTag; import org.junit.platform.engine.TestTag;


Expand All @@ -45,7 +46,7 @@ public final class TestIdentifier implements Serializable {
private final String legacyReportingName; private final String legacyReportingName;
private final TestSource source; private final TestSource source;
private final Set<TestTag> tags; private final Set<TestTag> tags;
private final TestDescriptor.Type type; private final Type type;


/** /**
* Factory for creating a new {@link TestIdentifier} from a {@link TestDescriptor}. * Factory for creating a new {@link TestIdentifier} from a {@link TestDescriptor}.
Expand All @@ -57,14 +58,14 @@ public static TestIdentifier from(TestDescriptor testDescriptor) {
String displayName = testDescriptor.getDisplayName(); String displayName = testDescriptor.getDisplayName();
TestSource source = testDescriptor.getSource().orElse(null); TestSource source = testDescriptor.getSource().orElse(null);
Set<TestTag> tags = testDescriptor.getTags(); Set<TestTag> tags = testDescriptor.getTags();
TestDescriptor.Type type = testDescriptor.getType(); Type type = testDescriptor.getType();
String parentId = testDescriptor.getParent().map( String parentId = testDescriptor.getParent().map(
parentDescriptor -> parentDescriptor.getUniqueId().toString()).orElse(null); parentDescriptor -> parentDescriptor.getUniqueId().toString()).orElse(null);
String legacyReportingName = testDescriptor.getLegacyReportingName(); String legacyReportingName = testDescriptor.getLegacyReportingName();
return new TestIdentifier(uniqueId, displayName, source, tags, type, parentId, legacyReportingName); return new TestIdentifier(uniqueId, displayName, source, tags, type, parentId, legacyReportingName);
} }


TestIdentifier(String uniqueId, String displayName, TestSource source, Set<TestTag> tags, TestDescriptor.Type type, TestIdentifier(String uniqueId, String displayName, TestSource source, Set<TestTag> tags, Type type,
String parentId, String legacyReportingName) { String parentId, String legacyReportingName) {
Preconditions.notNull(type, "TestDescriptor.Type must not be null"); Preconditions.notNull(type, "TestDescriptor.Type must not be null");
this.uniqueId = uniqueId; this.uniqueId = uniqueId;
Expand Down Expand Up @@ -139,7 +140,7 @@ public String getLegacyReportingName() {
* *
* @return the underlying descriptor type; never {@code null} * @return the underlying descriptor type; never {@code null}
*/ */
public TestDescriptor.Type getType() { public Type getType() {
return type; return type;
} }


Expand All @@ -148,7 +149,7 @@ public TestDescriptor.Type getType() {
* *
* @return {@code true} if the underlying descriptor type represents a test, * @return {@code true} if the underlying descriptor type represents a test,
* {@code false} otherwise * {@code false} otherwise
* @see TestDescriptor.Type#isTest() * @see Type#isTest()
*/ */
public boolean isTest() { public boolean isTest() {
return getType().isTest(); return getType().isTest();
Expand All @@ -159,7 +160,7 @@ public boolean isTest() {
* *
* @return {@code true} if the underlying descriptor type represents a container, * @return {@code true} if the underlying descriptor type represents a container,
* {@code false} otherwise * {@code false} otherwise
* @see TestDescriptor.Type#isContainer() * @see Type#isContainer()
*/ */
public boolean isContainer() { public boolean isContainer() {
return getType().isContainer(); return getType().isContainer();
Expand Down

1 comment on commit 401b627

@marcphilipp
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Please sign in to comment.