8264779: Fix doclint warnings in java/nio

Reviewed-by: chegar, iris, alanb, naoto
This commit is contained in:
Conor Cleary 2021-04-09 08:50:33 +00:00 committed by Chris Hegarty
parent 3e57924a6e
commit a45733f840
9 changed files with 48 additions and 10 deletions

View File

@ -1,6 +1,6 @@
#! /bin/sh #! /bin/sh
# #
# Copyright (c) 2000, 2019, Oracle and/or its affiliates. All rights reserved. # Copyright (c) 2000, 2021, Oracle and/or its affiliates. All rights reserved.
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
# #
# This code is free software; you can redistribute it and/or modify it # This code is free software; you can redistribute it and/or modify it
@ -68,6 +68,9 @@ __END__
cat >>$out <<__END__ cat >>$out <<__END__
/**
* The $ARG_PHRASE.
*/
private $ARG_TYPE $ARG_ID; private $ARG_TYPE $ARG_ID;
/** /**

View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2000, 2019, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2000, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -41,6 +41,9 @@ public class MalformedInputException
@java.io.Serial @java.io.Serial
private static final long serialVersionUID = -3438823399834806194L; private static final long serialVersionUID = -3438823399834806194L;
/**
* The length of the input.
*/
private int inputLength; private int inputLength;
/** /**

View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2001, 2019, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2001, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -41,6 +41,9 @@ public class UnmappableCharacterException
@java.io.Serial @java.io.Serial
private static final long serialVersionUID = -7026962371537706123L; private static final long serialVersionUID = -7026962371537706123L;
/**
* The length of the input character (or byte) sequence.
*/
private int inputLength; private int inputLength;
/** /**

View File

@ -1,5 +1,5 @@
# #
# Copyright (c) 2000, 2007, Oracle and/or its affiliates. All rights reserved. # Copyright (c) 2000, 2021, Oracle and/or its affiliates. All rights reserved.
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
# #
# This code is free software; you can redistribute it and/or modify it # This code is free software; you can redistribute it and/or modify it
@ -28,7 +28,7 @@
SINCE=1.4 SINCE=1.4
PACKAGE=java.nio.charset PACKAGE=java.nio.charset
# This year should only change if the generated source is modified. # This year should only change if the generated source is modified.
COPYRIGHT_YEARS="2000, 2007," COPYRIGHT_YEARS="2000, 2021,"
SUPER=java.io.IOException SUPER=java.io.IOException

View File

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

View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2010, 2019, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2010, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -73,9 +73,19 @@ public final class DirectoryIteratorException
/** /**
* Called to read the object from a stream. * Called to read the object from a stream.
* *
* @param s
* the {@code ObjectInputStream} to read
*
* @throws InvalidObjectException * @throws InvalidObjectException
* if the object is invalid or has a cause that is not * if the object is invalid or has a cause that is not
* an {@code IOException} * an {@code IOException}
*
* @throws IOException
* if an I/O error occurs
*
* @throws ClassNotFoundException
* if the class of a serialized object could not be
* found
*/ */
@java.io.Serial @java.io.Serial
private void readObject(ObjectInputStream s) private void readObject(ObjectInputStream s)

View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2007, 2019, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2007, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -40,7 +40,15 @@ public class FileSystemException
@java.io.Serial @java.io.Serial
static final long serialVersionUID = -3055425747967319812L; static final long serialVersionUID = -3055425747967319812L;
/**
* String identifying the file or {@code null} if not known.
*/
private final String file; private final String file;
/**
* String identifying the other file or {@code null} if there isn't
* another file or if not known.
*/
private final String other; private final String other;
/** /**

View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2007, 2019, Oracle and/or its affiliates. All rights reserved. * Copyright (c) 2007, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* *
* This code is free software; you can redistribute it and/or modify it * This code is free software; you can redistribute it and/or modify it
@ -39,7 +39,15 @@ public class InvalidPathException
@java.io.Serial @java.io.Serial
static final long serialVersionUID = 4355821422286746137L; static final long serialVersionUID = 4355821422286746137L;
/**
* The input string.
*/
private String input; private String input;
/**
* The index of the input string at which the error occurred or
* {@code -1} if not known.
*/
private int index; private int index;
/** /**

View File

@ -40,6 +40,9 @@ public class UserPrincipalNotFoundException
@java.io.Serial @java.io.Serial
static final long serialVersionUID = -5369283889045833024L; static final long serialVersionUID = -5369283889045833024L;
/**
* The user principal name.
*/
private final String name; private final String name;
/** /**