Skip to content

Commit ff3f026

Browse files
aherbertaherbert
committed
Fix javadoc errors in test classes.
1 parent 242d3fe commit ff3f026

9 files changed

Lines changed: 47 additions & 52 deletions

‎src/test/java/org/apache/commons/codec/binary/Base32InputStreamTest.java‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,7 @@ public void testCodec105() throws IOException {
144144
* Tests skipping past the end of a stream.
145145
*
146146
* @throws Throwable
147+
* for some failure scenarios.
147148
*/
148149
@Test
149150
public void testAvailable() throws Throwable {
@@ -380,6 +381,7 @@ private void testByteByByte(final byte[] encoded, final byte[] decoded, final in
380381
* Tests markSupported.
381382
*
382383
* @throws Exception
384+
* for some failure scenarios.
383385
*/
384386
@Test
385387
public void testMarkSupported() throws Exception {
@@ -395,6 +397,7 @@ public void testMarkSupported() throws Exception {
395397
* Tests read returning 0
396398
*
397399
* @throws Exception
400+
* for some failure scenarios.
398401
*/
399402
@Test
400403
public void testRead0() throws Exception {
@@ -430,6 +433,7 @@ public void testReadNull() throws Exception {
430433
* Tests read throwing IndexOutOfBoundsException
431434
*
432435
* @throws Exception
436+
* for some failure scenarios.
433437
*/
434438
@Test
435439
public void testReadOutOfBounds() throws Exception {
@@ -472,6 +476,7 @@ public void testReadOutOfBounds() throws Exception {
472476
* Tests skipping as a noop
473477
*
474478
* @throws Throwable
479+
* for some failure scenarios.
475480
*/
476481
@Test
477482
public void testSkipNone() throws Throwable {
@@ -490,6 +495,7 @@ public void testSkipNone() throws Throwable {
490495
* Tests skipping number of characters larger than the internal buffer.
491496
*
492497
* @throws Throwable
498+
* for some failure scenarios.
493499
*/
494500
@Test
495501
public void testSkipBig() throws Throwable {
@@ -506,6 +512,7 @@ public void testSkipBig() throws Throwable {
506512
* Tests skipping past the end of a stream.
507513
*
508514
* @throws Throwable
515+
* for some failure scenarios.
509516
*/
510517
@Test
511518
public void testSkipPastEnd() throws Throwable {
@@ -523,6 +530,7 @@ public void testSkipPastEnd() throws Throwable {
523530
* Tests skipping to the end of a stream.
524531
*
525532
* @throws Throwable
533+
* for some failure scenarios.
526534
*/
527535
@Test
528536
public void testSkipToEnd() throws Throwable {
@@ -540,6 +548,7 @@ public void testSkipToEnd() throws Throwable {
540548
* Tests if negative arguments to skip are handled correctly.
541549
*
542550
* @throws Throwable
551+
* for some failure scenarios.
543552
*/
544553
@Test(expected=IllegalArgumentException.class)
545554
public void testSkipWrongArgument() throws Throwable {

‎src/test/java/org/apache/commons/codec/binary/Base64InputStreamTest.java‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@ public void testCodec98NPE() throws Exception {
153153
* Tests skipping past the end of a stream.
154154
*
155155
* @throws Throwable
156+
* for some failure scenarios.
156157
*/
157158
@Test
158159
public void testAvailable() throws Throwable {
@@ -393,6 +394,7 @@ private void testByteByByte(final byte[] encoded, final byte[] decoded, final in
393394
* Tests markSupported.
394395
*
395396
* @throws Exception
397+
* for some failure scenarios.
396398
*/
397399
@Test
398400
public void testMarkSupported() throws Exception {
@@ -408,6 +410,7 @@ public void testMarkSupported() throws Exception {
408410
* Tests read returning 0
409411
*
410412
* @throws Exception
413+
* for some failure scenarios.
411414
*/
412415
@Test
413416
public void testRead0() throws Exception {
@@ -443,6 +446,7 @@ public void testReadNull() throws Exception {
443446
* Tests read throwing IndexOutOfBoundsException
444447
*
445448
* @throws Exception
449+
* for some failure scenarios.
446450
*/
447451
@Test
448452
public void testReadOutOfBounds() throws Exception {
@@ -485,6 +489,7 @@ public void testReadOutOfBounds() throws Exception {
485489
* Tests skipping number of characters larger than the internal buffer.
486490
*
487491
* @throws Throwable
492+
* for some failure scenarios.
488493
*/
489494
@Test
490495
public void testSkipBig() throws Throwable {
@@ -501,6 +506,7 @@ public void testSkipBig() throws Throwable {
501506
* Tests skipping as a noop
502507
*
503508
* @throws Throwable
509+
* for some failure scenarios.
504510
*/
505511
@Test
506512
public void testSkipNone() throws Throwable {
@@ -519,6 +525,7 @@ public void testSkipNone() throws Throwable {
519525
* Tests skipping past the end of a stream.
520526
*
521527
* @throws Throwable
528+
* for some failure scenarios.
522529
*/
523530
@Test
524531
public void testSkipPastEnd() throws Throwable {
@@ -536,6 +543,7 @@ public void testSkipPastEnd() throws Throwable {
536543
* Tests skipping to the end of a stream.
537544
*
538545
* @throws Throwable
546+
* for some failure scenarios.
539547
*/
540548
@Test
541549
public void testSkipToEnd() throws Throwable {
@@ -553,6 +561,7 @@ public void testSkipToEnd() throws Throwable {
553561
* Tests if negative arguments to skip are handled correctly.
554562
*
555563
* @throws Throwable
564+
* for some failure scenarios.
556565
*/
557566
@Test(expected=IllegalArgumentException.class)
558567
public void testSkipWrongArgument() throws Throwable {

‎src/test/java/org/apache/commons/codec/language/Caverphone1Test.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ protected Caverphone1 createStringEncoder() {
3939
*
4040
* AT1111 words: add, aid, at, art, eat, earth, head, hit, hot, hold, hard, heart, it, out, old
4141
*
42-
* @throws EncoderException
42+
* @throws EncoderException for some failure scenarios.
4343
*/
4444
@Test
4545
public void testCaverphoneRevisitedCommonCodeAT1111() throws EncoderException {
@@ -70,7 +70,7 @@ public void testEndMb() throws EncoderException {
7070
/**
7171
* Tests some examples from version 2.0 http://caversham.otago.ac.nz/files/working/ctp150804.pdf
7272
*
73-
* @throws EncoderException
73+
* @throws EncoderException for some failure scenarios.
7474
*/
7575
@Test
7676
public void testIsCaverphoneEquals() throws EncoderException {
@@ -82,7 +82,7 @@ public void testIsCaverphoneEquals() throws EncoderException {
8282
/**
8383
* Tests example from http://caversham.otago.ac.nz/files/working/ctp060902.pdf
8484
*
85-
* @throws EncoderException
85+
* @throws EncoderException for some failure scenarios.
8686
*/
8787
@Test
8888
public void testSpecificationV1Examples() throws EncoderException {
@@ -93,7 +93,7 @@ public void testSpecificationV1Examples() throws EncoderException {
9393
/**
9494
* Tests examples from http://en.wikipedia.org/wiki/Caverphone
9595
*
96-
* @throws EncoderException
96+
* @throws EncoderException for some failure scenarios.
9797
*/
9898
@Test
9999
public void testWikipediaExamples() throws EncoderException {

‎src/test/java/org/apache/commons/codec/language/Caverphone2Test.java‎

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,7 @@ protected Caverphone2 createStringEncoder() {
3939
*
4040
* AT11111111 words: add, aid, at, art, eat, earth, head, hit, hot, hold, hard, heart, it, out, old
4141
*
42-
* @throws EncoderException
43-
*/
42+
* @throws EncoderException for some failure scenarios */
4443
@Test
4544
public void testCaverphoneRevisitedCommonCodeAT11111111() throws EncoderException {
4645
this.checkEncodingVariations("AT11111111", new String[]{
@@ -64,8 +63,7 @@ public void testCaverphoneRevisitedCommonCodeAT11111111() throws EncoderExceptio
6463
/**
6564
* See http://caversham.otago.ac.nz/files/working/ctp150804.pdf
6665
*
67-
* @throws EncoderException
68-
*/
66+
* @throws EncoderException for some failure scenarios */
6967
@Test
7068
public void testCaverphoneRevisitedExamples() throws EncoderException {
7169
final String[][] data = {{"Stevenson", "STFNSN1111"}, {"Peter", "PTA1111111"}};
@@ -75,8 +73,7 @@ public void testCaverphoneRevisitedExamples() throws EncoderException {
7573
/**
7674
* See http://caversham.otago.ac.nz/files/working/ctp150804.pdf
7775
*
78-
* @throws EncoderException
79-
*/
76+
* @throws EncoderException for some failure scenarios */
8077
@Test
8178
public void testCaverphoneRevisitedRandomNameKLN1111111() throws EncoderException {
8279
this.checkEncodingVariations("KLN1111111", new String[]{
@@ -167,8 +164,7 @@ public void testCaverphoneRevisitedRandomNameKLN1111111() throws EncoderExceptio
167164
/**
168165
* See http://caversham.otago.ac.nz/files/working/ctp150804.pdf
169166
*
170-
* @throws EncoderException
171-
*/
167+
* @throws EncoderException for some failure scenarios */
172168
@Test
173169
public void testCaverphoneRevisitedRandomNameTN11111111() throws EncoderException {
174170
this.checkEncodingVariations("TN11111111", new String[]{
@@ -246,8 +242,7 @@ public void testCaverphoneRevisitedRandomNameTN11111111() throws EncoderExceptio
246242
/**
247243
* See http://caversham.otago.ac.nz/files/working/ctp150804.pdf
248244
*
249-
* @throws EncoderException
250-
*/
245+
* @throws EncoderException for some failure scenarios */
251246
@Test
252247
public void testCaverphoneRevisitedRandomNameTTA1111111() throws EncoderException {
253248
this.checkEncodingVariations("TTA1111111", new String[]{
@@ -324,8 +319,7 @@ public void testCaverphoneRevisitedRandomNameTTA1111111() throws EncoderExceptio
324319
/**
325320
* See http://caversham.otago.ac.nz/files/working/ctp150804.pdf
326321
*
327-
* @throws EncoderException
328-
*/
322+
* @throws EncoderException for some failure scenarios */
329323
@Test
330324
public void testCaverphoneRevisitedRandomWords() throws EncoderException {
331325
this.checkEncodingVariations("RTA1111111", new String[]{"rather", "ready", "writer"});

‎src/test/java/org/apache/commons/codec/language/ColognePhoneticTest.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,7 @@ public void testAaclan() throws EncoderException {
115115
/**
116116
* Tests [CODEC-122]
117117
*
118-
* @throws EncoderException
119-
*/
118+
* @throws EncoderException for some failure scenarios */
120119
@Test
121120
public void testAychlmajrForCodec122() throws EncoderException {
122121
this.checkEncoding("04567", "Aychlmajr");

‎src/test/java/org/apache/commons/codec/language/DaitchMokotoffSoundexTest.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,7 @@ public void testEncodeIgnoreApostrophes() throws EncoderException {
8989
/**
9090
* Test data from http://www.myatt.demon.co.uk/sxalg.htm
9191
*
92-
* @throws EncoderException
93-
*/
92+
* @throws EncoderException for some failure scenarios */
9493
@Test
9594
public void testEncodeIgnoreHyphens() throws EncoderException {
9695
this.checkEncodingVariations("565463", new String[] { "KINGSMITH", "-KINGSMITH", "K-INGSMITH", "KI-NGSMITH",

‎src/test/java/org/apache/commons/codec/language/NysiisTest.java‎

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,7 @@ public class NysiisTest extends StringEncoderAbstractTest<Nysiis> {
3838
* @param testValues
3939
* an array of String pairs where each pair's first element is the input and the second element the
4040
* expected encoding.
41-
* @throws EncoderException
42-
*/
41+
* @throws EncoderException for some failure scenarios */
4342
private void assertEncodings(final String[]... testValues) throws EncoderException {
4443
for (final String[] arr : testValues) {
4544
Assert.assertEquals("Problem with " + arr[0], arr[1], this.fullNysiis.encode(arr[0]));
@@ -83,8 +82,7 @@ public void testDan() {
8382
* Tests data gathered from around the internet.
8483
*
8584
* @see <a href="http://www.dropby.com/NYSIISTextStrings.html">http://www.dropby.com/NYSIISTextStrings.html</a>
86-
* @throws EncoderException
87-
*/
85+
* @throws EncoderException for some failure scenarios */
8886
@Test
8987
public void testDropBy() throws EncoderException {
9088
// Explanation of differences between this implementation and the one at dropby.com is
@@ -151,8 +149,7 @@ public void testFal() {
151149
/**
152150
* Tests data gathered from around the internets.
153151
*
154-
* @throws EncoderException
155-
*/
152+
* @throws EncoderException for some failure scenarios */
156153
@Test
157154
public void testOthers() throws EncoderException {
158155
this.assertEncodings(
@@ -168,8 +165,7 @@ public void testOthers() throws EncoderException {
168165
/**
169166
* Tests rule 1: Translate first characters of name: MAC → MCC, KN → N, K → C, PH, PF → FF, SCH → SSS
170167
*
171-
* @throws EncoderException
172-
*/
168+
* @throws EncoderException for some failure scenarios */
173169
@Test
174170
public void testRule1() throws EncoderException {
175171
this.assertEncodings(
@@ -184,8 +180,7 @@ public void testRule1() throws EncoderException {
184180
/**
185181
* Tests rule 2: Translate last characters of name: EE → Y, IE → Y, DT, RT, RD, NT, ND → D
186182
*
187-
* @throws EncoderException
188-
*/
183+
* @throws EncoderException for some failure scenarios */
189184
@Test
190185
public void testRule2() throws EncoderException {
191186
this.assertEncodings(
@@ -201,8 +196,7 @@ public void testRule2() throws EncoderException {
201196
/**
202197
* Tests rule 4.1: EV → AF else A, E, I, O, U → A
203198
*
204-
* @throws EncoderException
205-
*/
199+
* @throws EncoderException for some failure scenarios */
206200
@Test
207201
public void testRule4Dot1() throws EncoderException {
208202
this.assertEncodings(
@@ -217,8 +211,7 @@ public void testRule4Dot1() throws EncoderException {
217211
/**
218212
* Tests rule 4.2: Q → G, Z → S, M → N
219213
*
220-
* @throws EncoderException
221-
*/
214+
* @throws EncoderException for some failure scenarios */
222215
@Test
223216
public void testRule4Dot2() throws EncoderException {
224217
this.assertEncodings(
@@ -230,8 +223,7 @@ public void testRule4Dot2() throws EncoderException {
230223
/**
231224
* Tests rule 5: If last character is S, remove it.
232225
*
233-
* @throws EncoderException
234-
*/
226+
* @throws EncoderException for some failure scenarios */
235227
@Test
236228
public void testRule5() throws EncoderException {
237229
this.assertEncodings(
@@ -242,8 +234,7 @@ public void testRule5() throws EncoderException {
242234
/**
243235
* Tests rule 6: If last characters are AY, replace with Y.
244236
*
245-
* @throws EncoderException
246-
*/
237+
* @throws EncoderException for some failure scenarios */
247238
@Test
248239
public void testRule6() throws EncoderException {
249240
this.assertEncodings(
@@ -254,8 +245,7 @@ public void testRule6() throws EncoderException {
254245
/**
255246
* Tests rule 7: If last character is A, remove it.
256247
*
257-
* @throws EncoderException
258-
*/
248+
* @throws EncoderException for some failure scenarios */
259249
@Test
260250
public void testRule7() throws EncoderException {
261251
this.assertEncodings(

‎src/test/java/org/apache/commons/codec/language/SoundexTest.java‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -193,8 +193,7 @@ public void testEncodeIgnoreApostrophes() throws EncoderException {
193193
/**
194194
* Test data from http://www.myatt.demon.co.uk/sxalg.htm
195195
*
196-
* @throws EncoderException
197-
*/
196+
* @throws EncoderException for some failure scenarios */
198197
@Test
199198
public void testEncodeIgnoreHyphens() throws EncoderException {
200199
this.checkEncodingVariations("K525", new String[]{
@@ -245,8 +244,7 @@ public void testHWRuleEx2() {
245244
/**
246245
* Consonants from the same code group separated by W or H are treated as one.
247246
*
248-
* @throws EncoderException
249-
*/
247+
* @throws EncoderException for some failure scenarios */
250248
@Test
251249
public void testHWRuleEx3() throws EncoderException {
252250
Assert.assertEquals("S460", this.getStringEncoder().encode("Sgler"));
@@ -286,8 +284,7 @@ public void testMsSqlServer1() {
286284
* http://support.microsoft.com/default.aspx?scid=http://support.microsoft.com:80/support
287285
* /kb/articles/Q100/3/65.asp&NoWebContent=1
288286
*
289-
* @throws EncoderException
290-
*/
287+
* @throws EncoderException for some failure scenarios */
291288
@Test
292289
public void testMsSqlServer2() throws EncoderException {
293290
this.checkEncodingVariations("E625", new String[]{"Erickson", "Erickson", "Erikson", "Ericson", "Ericksen", "Ericsen"});

0 commit comments

Comments
 (0)