Skip to content

Commit a45733f

Browse files
c-clearyChrisHegarty
authored andcommitted
8264779: Fix doclint warnings in java/nio
Reviewed-by: chegar, iris, alanb, naoto
1 parent 3e57924 commit a45733f

9 files changed

+48
-10
lines changed

make/scripts/genExceptions.sh

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#! /bin/sh
22
#
3-
# Copyright (c) 2000, 2019, Oracle and/or its affiliates. All rights reserved.
3+
# Copyright (c) 2000, 2021, Oracle and/or its affiliates. All rights reserved.
44
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
55
#
66
# This code is free software; you can redistribute it and/or modify it
@@ -68,6 +68,9 @@ __END__
6868

6969
cat >>$out <<__END__
7070
71+
/**
72+
* The $ARG_PHRASE.
73+
*/
7174
private $ARG_TYPE $ARG_ID;
7275
7376
/**

src/java.base/share/classes/java/nio/charset/MalformedInputException.java

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2000, 2019, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2000, 2021, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -41,6 +41,9 @@ public class MalformedInputException
4141
@java.io.Serial
4242
private static final long serialVersionUID = -3438823399834806194L;
4343

44+
/**
45+
* The length of the input.
46+
*/
4447
private int inputLength;
4548

4649
/**

src/java.base/share/classes/java/nio/charset/UnmappableCharacterException.java

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2001, 2019, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2001, 2021, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -41,6 +41,9 @@ public class UnmappableCharacterException
4141
@java.io.Serial
4242
private static final long serialVersionUID = -7026962371537706123L;
4343

44+
/**
45+
* The length of the input character (or byte) sequence.
46+
*/
4447
private int inputLength;
4548

4649
/**

src/java.base/share/classes/java/nio/charset/exceptions

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#
2-
# Copyright (c) 2000, 2007, Oracle and/or its affiliates. All rights reserved.
2+
# Copyright (c) 2000, 2021, Oracle and/or its affiliates. All rights reserved.
33
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
#
55
# This code is free software; you can redistribute it and/or modify it
@@ -28,7 +28,7 @@
2828
SINCE=1.4
2929
PACKAGE=java.nio.charset
3030
# This year should only change if the generated source is modified.
31-
COPYRIGHT_YEARS="2000, 2007,"
31+
COPYRIGHT_YEARS="2000, 2021,"
3232

3333
SUPER=java.io.IOException
3434

src/java.base/share/classes/java/nio/exceptions

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#
2-
# Copyright (c) 2000, 2007, Oracle and/or its affiliates. All rights reserved.
2+
# Copyright (c) 2000, 2021, Oracle and/or its affiliates. All rights reserved.
33
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
#
55
# This code is free software; you can redistribute it and/or modify it
@@ -28,7 +28,7 @@
2828
SINCE=1.4
2929
PACKAGE=java.nio
3030
# This year should only change if the generated source is modified.
31-
COPYRIGHT_YEARS="2000, 2007,"
31+
COPYRIGHT_YEARS="2000, 2021,"
3232

3333

3434
SUPER=RuntimeException

src/java.base/share/classes/java/nio/file/DirectoryIteratorException.java

+11-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2010, 2019, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2010, 2021, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -73,9 +73,19 @@ public IOException getCause() {
7373
/**
7474
* Called to read the object from a stream.
7575
*
76+
* @param s
77+
* the {@code ObjectInputStream} to read
78+
*
7679
* @throws InvalidObjectException
7780
* if the object is invalid or has a cause that is not
7881
* an {@code IOException}
82+
*
83+
* @throws IOException
84+
* if an I/O error occurs
85+
*
86+
* @throws ClassNotFoundException
87+
* if the class of a serialized object could not be
88+
* found
7989
*/
8090
@java.io.Serial
8191
private void readObject(ObjectInputStream s)

src/java.base/share/classes/java/nio/file/FileSystemException.java

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2007, 2019, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2007, 2021, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -40,7 +40,15 @@ public class FileSystemException
4040
@java.io.Serial
4141
static final long serialVersionUID = -3055425747967319812L;
4242

43+
/**
44+
* String identifying the file or {@code null} if not known.
45+
*/
4346
private final String file;
47+
48+
/**
49+
* String identifying the other file or {@code null} if there isn't
50+
* another file or if not known.
51+
*/
4452
private final String other;
4553

4654
/**

src/java.base/share/classes/java/nio/file/InvalidPathException.java

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2007, 2019, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2007, 2021, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -39,7 +39,15 @@ public class InvalidPathException
3939
@java.io.Serial
4040
static final long serialVersionUID = 4355821422286746137L;
4141

42+
/**
43+
* The input string.
44+
*/
4245
private String input;
46+
47+
/**
48+
* The index of the input string at which the error occurred or
49+
* {@code -1} if not known.
50+
*/
4351
private int index;
4452

4553
/**

src/java.base/share/classes/java/nio/file/attribute/UserPrincipalNotFoundException.java

+3
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ public class UserPrincipalNotFoundException
4040
@java.io.Serial
4141
static final long serialVersionUID = -5369283889045833024L;
4242

43+
/**
44+
* The user principal name.
45+
*/
4346
private final String name;
4447

4548
/**

0 commit comments

Comments
 (0)