Skip to content

Commit 05aae55

Browse files
scarytomscarytom
committed
bashing javadoc warnings
1 parent 9a0472c commit 05aae55

File tree

10 files changed

+30
-27
lines changed

10 files changed

+30
-27
lines changed

‎build.xml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,11 @@
137137
<javadoc packagenames="org.hamcrest.*" sourcepath="build/temp/@{modulename}-sources.jar.contents" defaultexcludes="yes"
138138
destdir="build/temp/hamcrest-all-${version}-javadoc.jar.contents" author="true" version="true" use="true"
139139
windowtitle="Hamcrest" source="1.6" failonerror="yes" overview="overview.html">
140+
<classpath>
141+
<fileset dir="lib/integration">
142+
<include name="*.jar"/>
143+
</fileset>
144+
</classpath>
140145
<packageset dir="build/temp/hamcrest-core-${version}-sources.jar.contents"/>
141146
<packageset dir="build/temp/hamcrest-library-${version}-sources.jar.contents" excludes="org/hamcrest/internal"/>
142147
<packageset dir="build/temp/hamcrest-integration-${version}-sources.jar.contents"/>
@@ -194,7 +199,7 @@
194199
<attribute name="classpath" description="Anything additional to add on the classpath" default=""/>
195200
<sequential>
196201
<mkdir dir="build/temp/@{modulename}.jar.contents"/>
197-
<javac srcdir="@{srcdir}" destdir="build/temp/@{modulename}.jar.contents" debug="${debug}" target="1.5">
202+
<javac srcdir="@{srcdir}" destdir="build/temp/@{modulename}.jar.contents" debug="${debug}" target="1.5" includeantruntime="false">
198203
<classpath>
199204
<fileset dir="lib/integration">
200205
<include name="*.jar"/>

‎hamcrest-core/src/main/java/org/hamcrest/CustomTypeSafeMatcher.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
* };
1616
* </pre>
1717
* This is a variant of {@link CustomMatcher} that first type checks
18-
* the argument being matched. By the time {@link #matchesSafely(T)} is
18+
* the argument being matched. By the time {@link TypeSafeMatcher#matchesSafely} is
1919
* is called the argument is guaranteed to be non-null and of the correct
2020
* type.
2121
*

‎hamcrest-core/src/main/java/org/hamcrest/core/DescribedAs.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ public void describeMismatch(Object item, Description description) {
6262
*
6363
* @param description
6464
* the new description for the wrapped matcher
65-
* @param
65+
* @param matcher
6666
* the matcher to wrap
67-
* @param
67+
* @param values
6868
* optional values to insert into the tokenised description
6969
*/
7070
@Factory

‎hamcrest-generator/src/main/java/org/hamcrest/generator/FactoryMethod.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,6 @@ public void addGenericTypeParameter(String genericTypeParameter) {
9797
/**
9898
* List of generic type parameters for factory method definition.
9999
* ie. 'public &lt;THIS,THAT&gt; Matcher&lt;...&gt; blah(...)'
100-
*
101-
* @return
102100
*/
103101
public List<String> getGenericTypeParameters() {
104102
return unmodifiableList(genericTypeParameters);

‎hamcrest-library/src/main/java/org/hamcrest/collection/IsCollectionWithSize.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,29 +22,29 @@ protected Integer featureValueOf(Collection<? extends E> actual) {
2222
}
2323

2424
/**
25-
* Creates a matcher for {@link Collection}s that matches when the <code>size()</code> method returns
25+
* Creates a matcher for {@link java.util.Collection}s that matches when the <code>size()</code> method returns
2626
* a value that satisfies the specified matcher.
2727
* <p/>
2828
* For example:
2929
* <pre>assertThat(Arrays.asList("foo", "bar"), hasSize(equalTo(2)))</pre>
3030
*
3131
* @param sizeMatcher
32-
* a matcher for the size of an examined {@link Collection}
32+
* a matcher for the size of an examined {@link java.util.Collection}
3333
*/
3434
@Factory
3535
public static <E> Matcher<Collection<? extends E>> hasSize(Matcher<? super Integer> sizeMatcher) {
3636
return new IsCollectionWithSize<E>(sizeMatcher);
3737
}
3838

3939
/**
40-
* Creates a matcher for {@link Collection}s that matches when the <code>size()</code> method returns
40+
* Creates a matcher for {@link java.util.Collection}s that matches when the <code>size()</code> method returns
4141
* a value equal to the specified <code>size</code>.
4242
* <p/>
4343
* For example:
4444
* <pre>assertThat(Arrays.asList("foo", "bar"), hasSize(2))</pre>
4545
*
4646
* @param size
47-
* the expected size of an examined {@link Collection}
47+
* the expected size of an examined {@link java.util.Collection}
4848
*/
4949
@Factory
5050
public static <E> Matcher<Collection<? extends E>> hasSize(int size) {

‎hamcrest-library/src/main/java/org/hamcrest/collection/IsEmptyCollection.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public void describeTo(Description description) {
2828
}
2929

3030
/**
31-
* Creates a matcher for {@link Collection}s matching examined collections whose <code>isEmpty</code>
31+
* Creates a matcher for {@link java.util.Collection}s matching examined collections whose <code>isEmpty</code>
3232
* method returns <code>true</code>.
3333
* <p/>
3434
* For example:

‎hamcrest-library/src/main/java/org/hamcrest/collection/IsMapContaining.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ public void describeTo(Description description) {
4545
}
4646

4747
/**
48-
* Creates a matcher for {@link Map}s matching when the examined {@link Map} contains
48+
* Creates a matcher for {@link java.util.Map}s matching when the examined {@link java.util.Map} contains
4949
* at least one entry whose key satisfies the specified <code>keyMatcher</code> <b>and</b> whose
5050
* value satisfies the specified <code>valueMatcher</code>.
5151
* <p/>
@@ -63,9 +63,9 @@ public static <K,V> Matcher<Map<? extends K,? extends V>> hasEntry(Matcher<? sup
6363
}
6464

6565
/**
66-
* Creates a matcher for {@link Map}s matching when the examined {@link Map} contains
67-
* at least one entry whose key equals the specified <code>key</code> <b>and</b> whose
68-
* value equals the specified <code>value</code>.
66+
* Creates a matcher for {@link java.util.Map}s matching when the examined {@link java.util.Map} contains
67+
* at least one entry whose key equals the specified <code>key</code> <b>and</b> whose value equals the
68+
* specified <code>value</code>.
6969
* <p/>
7070
* For example:
7171
* <pre>assertThat(myMap, hasEntry("bar", "foo"))</pre>
@@ -81,7 +81,7 @@ public static <K,V> Matcher<Map<? extends K,? extends V>> hasEntry(K key, V valu
8181
}
8282

8383
/**
84-
* Creates a matcher for {@link Map}s matching when the examined {@link Map} contains
84+
* Creates a matcher for {@link java.util.Map}s matching when the examined {@link java.util.Map} contains
8585
* at least one key that satisfies the specified matcher.
8686
* <p/>
8787
* For example:
@@ -96,7 +96,7 @@ public static <K,V> Matcher<Map<? extends K,? extends V>> hasEntry(K key, V valu
9696
}
9797

9898
/**
99-
* Creates a matcher for {@link Map}s matching when the examined {@link Map} contains
99+
* Creates a matcher for {@link java.util.Map}s matching when the examined {@link java.util.Map} contains
100100
* at least one key that is equal to the specified key.
101101
* <p/>
102102
* For example:
@@ -111,7 +111,7 @@ public static <K,V> Matcher<Map<? extends K,? extends V>> hasEntry(K key, V valu
111111
}
112112

113113
/**
114-
* Creates a matcher for {@link Map}s matching when the examined {@link Map} contains
114+
* Creates a matcher for {@link java.util.Map}s matching when the examined {@link java.util.Map} contains
115115
* at least one value that satisfies the specified valueMatcher.
116116
* <p/>
117117
* For example:
@@ -126,7 +126,7 @@ public static <K,V> Matcher<Map<? extends K,? extends V>> hasEntry(K key, V valu
126126
}
127127

128128
/**
129-
* Creates a matcher for {@link Map}s matching when the examined {@link Map} contains
129+
* Creates a matcher for {@link java.util.Map}s matching when the examined {@link java.util.Map} contains
130130
* at least one value that is equal to the specified value.
131131
* <p/>
132132
* For example:

‎hamcrest-library/src/main/java/org/hamcrest/number/BigDecimalCloseTo.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ private BigDecimal actualDelta(BigDecimal item) {
4343
}
4444

4545
/**
46-
* Creates a matcher of {@link BigDecimal}s that matches when an examined BigDecimal is equal
46+
* Creates a matcher of {@link java.math.BigDecimal}s that matches when an examined BigDecimal is equal
4747
* to the specified <code>operand</code>, within a range of +/- <code>error</code>. The comparison for equality
48-
* is done by BigDecimals {@link BigDecimal#compareTo(BigDecimal))} method.
48+
* is done by BigDecimals {@link java.math.BigDecimal#compareTo(java.math.BigDecimal)} method.
4949
* <p/>
5050
* For example:
5151
* <pre>assertThat(new BigDecimal("1.03"), is(closeTo(new BigDecimal("1.0"), new BigDecimal("0.03"))))</pre>

‎hamcrest-library/src/main/java/org/hamcrest/object/IsEventFrom.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ public void describeTo(Description description) {
5050
}
5151

5252
/**
53-
* Creates a matcher of {@link EventObject} that matches any object
53+
* Creates a matcher of {@link java.util.EventObject} that matches any object
5454
* derived from <var>eventClass</var> announced by <var>source</var>.
5555
* </p>
5656
* For example:
@@ -67,7 +67,7 @@ public static Matcher<EventObject> eventFrom(Class<? extends EventObject> eventC
6767
}
6868

6969
/**
70-
* Creates a matcher of {@link EventObject} that matches any EventObject
70+
* Creates a matcher of {@link java.util.EventObject} that matches any EventObject
7171
* announced by <var>source</var>.
7272
* </p>
7373
* For example:

‎hamcrest-library/src/main/java/org/hamcrest/xml/HasXPath.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ private static XPathExpression compiledXPath(String xPathExpression, NamespaceCo
104104

105105

106106
/**
107-
* Creates a matcher of {@link Node}s that matches when the examined node has a value at the
107+
* Creates a matcher of {@link org.w3c.dom.Node}s that matches when the examined node has a value at the
108108
* specified <code>xPath</code> that satisfies the specified <code>valueMatcher</code>.
109109
* <p/>
110110
* For example:
@@ -121,7 +121,7 @@ public static Matcher<Node> hasXPath(String xPath, Matcher<String> valueMatcher)
121121
}
122122

123123
/**
124-
* Creates a matcher of {@link Node}s that matches when the examined node has a value at the
124+
* Creates a matcher of {@link org.w3c.dom.Node}s that matches when the examined node has a value at the
125125
* specified <code>xPath</code>, within the specified <code>namespaceContext</code>, that satisfies
126126
* the specified <code>valueMatcher</code>.
127127
* <p/>
@@ -141,7 +141,7 @@ public static Matcher<Node> hasXPath(String xPath, NamespaceContext namespaceCon
141141
}
142142

143143
/**
144-
* Creates a matcher of {@link Node}s that matches when the examined node contains a node
144+
* Creates a matcher of {@link org.w3c.dom.Node}s that matches when the examined node contains a node
145145
* at the specified <code>xPath</code>, with any content.
146146
* <p/>
147147
* For example:
@@ -156,7 +156,7 @@ public static Matcher<Node> hasXPath(String xPath) {
156156
}
157157

158158
/**
159-
* Creates a matcher of {@link Node}s that matches when the examined node contains a node
159+
* Creates a matcher of {@link org.w3c.dom.Node}s that matches when the examined node contains a node
160160
* at the specified <code>xPath</code> within the specified namespace context, with any content.
161161
* <p/>
162162
* For example:

0 commit comments

Comments
 (0)