8019320: Fix doclint issues in javax.script
authordarcy
Thu, 27 Jun 2013 14:11:25 -0700
changeset 18567 35b36d452864
parent 18566 6a998d63b405
child 18568 59fcf0320687
8019320: Fix doclint issues in javax.script Reviewed-by: lancea
jdk/src/share/classes/javax/script/Invocable.java
jdk/src/share/classes/javax/script/ScriptContext.java
jdk/src/share/classes/javax/script/ScriptEngineFactory.java
jdk/src/share/classes/javax/script/SimpleScriptContext.java
--- a/jdk/src/share/classes/javax/script/Invocable.java	Thu Jun 27 13:35:01 2013 -0700
+++ b/jdk/src/share/classes/javax/script/Invocable.java	Thu Jun 27 14:11:25 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.
      *
--- a/jdk/src/share/classes/javax/script/ScriptContext.java	Thu Jun 27 13:35:01 2013 -0700
+++ b/jdk/src/share/classes/javax/script/ScriptContext.java	Thu Jun 27 14:11:25 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.
      */
--- a/jdk/src/share/classes/javax/script/ScriptEngineFactory.java	Thu Jun 27 13:35:01 2013 -0700
+++ b/jdk/src/share/classes/javax/script/ScriptEngineFactory.java	Thu Jun 27 14:11:25 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 {&quot;javascript&quot;, &quot;rhino&quot;}.
+     * @return an immutable list of short names
      */
     public List<String> getNames();
 
--- a/jdk/src/share/classes/javax/script/SimpleScriptContext.java	Thu Jun 27 13:35:01 2013 -0700
+++ b/jdk/src/share/classes/javax/script/SimpleScriptContext.java	Thu Jun 27 14:11:25 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;