From 1343dbaa40f37717a0ecc7570e57db2d1d4e3d6c Mon Sep 17 00:00:00 2001 From: darcy Date: Thu, 27 Jun 2013 14:11:25 -0700 Subject: [PATCH] 8019320: Fix doclint issues in javax.script Reviewed-by: lancea --- src/share/classes/javax/script/Invocable.java | 5 ++++- src/share/classes/javax/script/ScriptContext.java | 3 ++- src/share/classes/javax/script/ScriptEngineFactory.java | 3 ++- src/share/classes/javax/script/SimpleScriptContext.java | 6 ++++-- 4 files changed, 12 insertions(+), 5 deletions(-) diff --git a/src/share/classes/javax/script/Invocable.java b/src/share/classes/javax/script/Invocable.java index e0b1bc780..81d363c01 100644 --- a/src/share/classes/javax/script/Invocable.java +++ b/src/share/classes/javax/script/Invocable.java @@ -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 @@ public interface Invocable { /** * 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 @@ public interface Invocable { * the interpreter. The methods of the interface * may be implemented using the invokeFunction method. * + * @param the type of the interface to return * @param clasz The Class object of the interface to return. * * @return An instance of requested interface - null if the requested interface is unavailable, @@ -95,6 +97,7 @@ public interface Invocable { * a scripting object compiled in the interpreter. The methods of the * interface may be implemented using the invokeMethod method. * + * @param 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 Class object of the interface to return. * diff --git a/src/share/classes/javax/script/ScriptContext.java b/src/share/classes/javax/script/ScriptContext.java index 78247bb74..8d1076b6d 100644 --- a/src/share/classes/javax/script/ScriptContext.java +++ b/src/share/classes/javax/script/ScriptContext.java @@ -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 @@ public interface ScriptContext { * @return The associated Bindings. Returns null if it has not * been set. * + * @param scope The scope * @throws IllegalArgumentException If no Bindings is defined for the * specified scope value in ScriptContext of this type. */ diff --git a/src/share/classes/javax/script/ScriptEngineFactory.java b/src/share/classes/javax/script/ScriptEngineFactory.java index ca22d1635..298b4ad7b 100644 --- a/src/share/classes/javax/script/ScriptEngineFactory.java +++ b/src/share/classes/javax/script/ScriptEngineFactory.java @@ -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 @@ public interface ScriptEngineFactory { * identify the ScriptEngine by the ScriptEngineManager. * 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 getNames(); diff --git a/src/share/classes/javax/script/SimpleScriptContext.java b/src/share/classes/javax/script/SimpleScriptContext.java index 98f8c81d5..a5bf12f9a 100644 --- a/src/share/classes/javax/script/SimpleScriptContext.java +++ b/src/share/classes/javax/script/SimpleScriptContext.java @@ -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 @@ public class SimpleScriptContext implements ScriptContext { */ protected Bindings globalScope; - + /** + * Create a {@code SimpleScriptContext}. + */ public SimpleScriptContext() { engineScope = new SimpleBindings(); globalScope = null; -- GitLab