JDK 8 core review request for doclint warnings in javax.script

Joe Darcy joe.darcy at oracle.com
Thu Jun 27 19:47:42 UTC 2013


Hello,

Please review the next patch in a series of patches to resolve doclint 
warnings in the JDK; this time in javax.script.

Thanks,

-Joe

diff -r b8f16cb2d95b src/share/classes/javax/script/Invocable.java
--- a/src/share/classes/javax/script/Invocable.java    Thu Jun 27 
12:24:26 2013 -0700
+++ b/src/share/classes/javax/script/Invocable.java    Thu Jun 27 
12:45:29 2013 -0700
@@ -1,5 +1,5 @@
  /*
- * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights 
reserved.
+ * Copyright (c) 2005, 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
@@ -63,6 +63,7 @@
      /**
       * Used to call top-level procedures and functions defined in scripts.
       *
+     * @param name of the procedure or function to call
       * @param args Arguments to pass to the procedure or function
       * @return The value returned by the procedure or function
       *
@@ -79,6 +80,7 @@
       * the interpreter. The methods of the interface
       * may be implemented using the <code>invokeFunction</code> method.
       *
+     * @param <T> the type of the interface to return
       * @param clasz The <code>Class</code> object of the interface to 
return.
       *
       * @return An instance of requested interface - null if the 
requested interface is unavailable,
@@ -95,6 +97,7 @@
       * a scripting object compiled in the interpreter. The methods of the
       * interface may be implemented using the 
<code>invokeMethod</code> method.
       *
+     * @param <T> the type of the interface to return
       * @param thiz The scripting object whose member functions are 
used to implement the methods of the interface.
       * @param clasz The <code>Class</code> object of the interface to 
return.
       *
diff -r b8f16cb2d95b src/share/classes/javax/script/ScriptContext.java
--- a/src/share/classes/javax/script/ScriptContext.java    Thu Jun 27 
12:24:26 2013 -0700
+++ b/src/share/classes/javax/script/ScriptContext.java    Thu Jun 27 
12:45:29 2013 -0700
@@ -1,5 +1,5 @@
  /*
- * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 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
@@ -78,6 +78,7 @@
       * @return The associated <code>Bindings</code>. Returns 
<code>null</code> if it has not
       * been set.
       *
+     * @param scope The scope
       * @throws IllegalArgumentException If no <code>Bindings</code> is 
defined for the
       * specified scope value in <code>ScriptContext</code> of this type.
       */
diff -r b8f16cb2d95b src/share/classes/javax/script/ScriptEngineFactory.java
--- a/src/share/classes/javax/script/ScriptEngineFactory.java    Thu Jun 
27 12:24:26 2013 -0700
+++ b/src/share/classes/javax/script/ScriptEngineFactory.java    Thu Jun 
27 12:45:29 2013 -0700
@@ -1,5 +1,5 @@
  /*
- * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights 
reserved.
+ * Copyright (c) 2005, 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
@@ -80,6 +80,7 @@
       * identify the <code>ScriptEngine</code> by the 
<code>ScriptEngineManager</code>.
       * For instance, an implementation based on the Mozilla Rhino 
Javascript engine might
       * return list containing {"javascript", "rhino"}.
+     * @return an immutable list of short names
       */
      public List<String> getNames();

diff -r b8f16cb2d95b src/share/classes/javax/script/SimpleScriptContext.java
--- a/src/share/classes/javax/script/SimpleScriptContext.java    Thu Jun 
27 12:24:26 2013 -0700
+++ b/src/share/classes/javax/script/SimpleScriptContext.java    Thu Jun 
27 12:45:29 2013 -0700
@@ -1,5 +1,5 @@
  /*
- * Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights 
reserved.
+ * Copyright (c) 2005, 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
@@ -82,7 +82,9 @@
       */
      protected Bindings globalScope;

-
+    /**
+     * Create a {@code SimpleScriptContext}.
+     */
      public SimpleScriptContext() {
          engineScope = new SimpleBindings();
          globalScope = null;




More information about the core-libs-dev mailing list