JDK 8 request for review: doclint cleanup of java.util.prefs (original) (raw)

Lance Andersen Lance.Andersen at oracle.com
Thu Jun 27 18:01:44 UTC 2013

+1 On Jun 27, 2013, at 1:59 PM, Joe Darcy <joe.darcy at oracle.com> wrote:

Hello,

Please review the patch below which resolves doclint warnings in java.util.prefs. Thanks, -Joe diff -r 4e69a7dfbeac src/share/classes/java/util/prefs/AbstractPreferences.java --- a/src/share/classes/java/util/prefs/AbstractPreferences.java Thu Jun 27 10:21:22 2013 +0100 +++ b/src/share/classes/java/util/prefs/AbstractPreferences.java Thu Jun 27 10:57:21 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 @@ -1121,6 +1121,8 @@ * removed. (The implementor needn't check for any of these things.) * *

This method is invoked with the lock on this node held.

+ * @param key the key + * @param value the value */ protected abstract void putSpi(String key, String value); @@ -1139,6 +1141,7 @@ * *

This method is invoked with the lock on this node held.

 * + * @param key the key * @return the value associated with the specified key at this preference * node, or null if there is no association for this * key, or the association cannot be determined at this time. @@ -1152,6 +1155,7 @@ * (The implementor needn't check for either of these things.) * *

This method is invoked with the lock on this node held.

 + * @param key the key */ protected abstract void removeSpi(String key); diff -r 4e69a7dfbeac src/share/classes/java/util/prefs/PreferencesFactory.java --- a/src/share/classes/java/util/prefs/PreferencesFactory.java Thu Jun 27 10:21:22 2013 +0100 +++ b/src/share/classes/java/util/prefs/PreferencesFactory.java Thu Jun 27 10:57:21 2013 -0700 @@ -1,5 +1,5 @@ /* - * Copyright (c) 2000, 2005, 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 @@ -45,6 +45,7 @@ /** * Returns the system root preference node. (Multiple calls on this * method will return the same object reference.) + * @return the system root preference node */ Preferences systemRoot(); @@ -52,6 +53,8 @@ * Returns the user root preference node corresponding to the calling * user. In a server, the returned value will typically depend on * some implicit client-context. + * @return the user root preference node corresponding to the calling + * user */ Preferences userRoot(); }

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

More information about the core-libs-dev mailing list