JDK 8 code review request: doclint cleanup of java.util.logging

[Lance Andersen - Oracle]

+1
On Jun 27, 2013, at 2:58 PM, Joe Darcy wrote:

> Hello,
> 
> Please review the patch below which resolves doclint warnings in java.util.logging.
> 
> Thanks,
> 
> -Joe
> 
> diff -r 1c31082f0a51 src/share/classes/java/util/logging/Handler.java
> --- a/src/share/classes/java/util/logging/Handler.java    Thu Jun 27 11:06:46 2013 -0700
> +++ b/src/share/classes/java/util/logging/Handler.java    Thu Jun 27 11:56:23 2013 -0700
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 2000, 2012, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 2000, 2013, 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
> @@ -209,6 +209,7 @@
>     /**
>      * Retrieves the ErrorManager for this Handler.
>      *
> +     * @return the ErrorManager for this Handler
>      * @exception  SecurityException  if a security manager exists and if
>      *             the caller does not have <tt>LoggingPermission("control")</tt>.
>      */
> diff -r 1c31082f0a51 src/share/classes/java/util/logging/LogManager.java
> --- a/src/share/classes/java/util/logging/LogManager.java    Thu Jun 27 11:06:46 2013 -0700
> +++ b/src/share/classes/java/util/logging/LogManager.java    Thu Jun 27 11:56:23 2013 -0700
> @@ -257,7 +257,8 @@
>     }
> 
>     /**
> -     * Return the global LogManager object.
> +     * Returns the global LogManager object.
> +     * @return the global LogManager object
>      */
>     public static LogManager getLogManager() {
>         if (manager != null) {
> diff -r 1c31082f0a51 src/share/classes/java/util/logging/LogRecord.java
> --- a/src/share/classes/java/util/logging/LogRecord.java    Thu Jun 27 11:06:46 2013 -0700
> +++ b/src/share/classes/java/util/logging/LogRecord.java    Thu Jun 27 11:56:23 2013 -0700
> @@ -1,5 +1,5 @@
> /*
> - * Copyright (c) 2000, 2010, Oracle and/or its affiliates. All rights reserved.
> + * Copyright (c) 2000, 2013, 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
> @@ -211,6 +211,7 @@
>      * the message string before formatting it.  The result may
>      * be null if the message is not localizable, or if no suitable
>      * ResourceBundle is available.
> +     * @return the localization resource bundle
>      */
>     public ResourceBundle getResourceBundle() {
>         return resourceBundle;
> @@ -231,6 +232,7 @@
>      * This is the name for the ResourceBundle that should be
>      * used to localize the message string before formatting it.
>      * The result may be null if the message is not localizable.
> +     * @return the localization resource bundle name
>      */
>     public String getResourceBundleName() {
>         return resourceBundleName;
> @@ -281,6 +283,7 @@
>      * <p>
>      * Sequence numbers are normally assigned in the LogRecord constructor,
>      * so it should not normally be necessary to use this method.
> +     * @param seq the sequence number
>      */
>     public void setSequenceNumber(long seq) {
>         sequenceNumber = seq;
> 

-------------- next part --------------

Lance Andersen| Principal Member of Technical Staff | +1.781.442.2037
Oracle Java Engineering 
1 Network Drive 
Burlington, MA 01803
Lance.Andersen at oracle.com