Re: RFR: 8150856 - Inconsistent API documentation for @param caller in System.LoggerFinder.getLogger

[Daniel Fuchs]

On 29/02/16 18:54, Martin Buchholz wrote:

You need to delete the orphaned semicolon

Thanks Martin!

-- daniel

On Mon, Feb 29, 2016 at 9:46 AM, Daniel Fuchs <daniel.fu...@oracle.com> wrote:

Hi,

Please find below a trivial fix for:

https://bugs.openjdk.java.net/browse/JDK-8150856
8150856: Inconsistent API documentation for @param caller
          in System.LoggerFinder.getLogger

http://cr.openjdk.java.net/~dfuchs/webrev_8150856/webrev.00

The @param caller clause says that caller can be null, whereas
the @throws clause says that NPE will be thrown.

The @throws clause is correct and @param needs to be fixed.

best regards,

-- daniel

--- old/src/java.base/share/classes/java/lang/System.java       2016-02-29
18:41:30.000000000 +0100
+++ new/src/java.base/share/classes/java/lang/System.java       2016-02-29
18:41:30.000000000 +0100
@@ -1,5 +1,5 @@
  /*
- * Copyright (c) 1994, 2014, Oracle and/or its affiliates. All rights
reserved.
+ * Copyright (c) 1994, 2016, Oracle and/or its affiliates. All rights
reserved.
   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   *
   * This code is free software; you can redistribute it and/or modify it
@@ -1419,7 +1419,6 @@
           *
           * @param name the name of the logger.
           * @param caller the class for which the logger is being requested;
-         *               can be {@code null}.
           *
           * @return a {@link Logger logger} suitable for the given caller's
           *         use.