diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/JavaScriptCompletionProvider.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/JavaScriptCompletionProvider.java index 7ee01584..12ad8c1c 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/JavaScriptCompletionProvider.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/JavaScriptCompletionProvider.java @@ -97,7 +97,8 @@ public void setShorthandCompletionCache( } /** - * load the comment completions from the shorthand cache + * load the comment completions from the shorthand cache. + * * @param shorthandCache */ private void setCommentCompletions(ShorthandCompletionCache shorthandCache){ diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/JavaScriptHelper.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/JavaScriptHelper.java index 975320b9..f8d3d743 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/JavaScriptHelper.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/JavaScriptHelper.java @@ -119,6 +119,7 @@ public void warning(String message, String sourceName, int line, /** * @param node AstNode to look for function + * @param provider The provider to look it up in. * @return function lookup name from it's AstNode. i.e. concat function name * and parameters. If no function is found, then return null */ @@ -233,6 +234,7 @@ public static TypeDeclaration tokenToNativeTypeDeclaration( * e.g * var a = [1, 2, 3]; * var b = a[1]; //b resolves to Number + * * @param node * @param provider * @return @@ -255,6 +257,7 @@ private static TypeDeclaration findGetElementType(AstNode node, SourceCompletion /** * Create array type from AstNode and try to determine the array type + * * @param typeNode * @param provider * @return @@ -276,6 +279,7 @@ private static TypeDeclaration createArrayType(AstNode typeNode, SourceCompletio /** * Find the array type from ArrayLiteral. Iterates through elements and checks all the types are the same + * * @param arrayLit * @param provider * @return TypeDeclaration if all elements are of the same type else TypeDeclarationFactory.getDefaultTypeDeclaration(); @@ -495,8 +499,9 @@ private static String findNewExpressionString(AstNode node) { * Convenience method to lookup TypeDeclaration through the * TypeDeclarationFactory. * - * @param name - * @return + * @param name The type declaration to look up. + * @param provider The provider to look it up in. + * @return The type declaration. */ public static TypeDeclaration getTypeDeclaration(String name, SourceCompletionProvider provider) { return provider.getTypesFactory().getTypeDeclaration(name); @@ -538,8 +543,8 @@ public static String removeLastDotFromText(String text) { * * String should be trimmed at the 1, not the 2, * - * @param text - * @return + * @param text The text to trim. + * @return The trimmed text. */ public static String trimFromLastParam(String text) { int trim = 0; diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/JavaScriptParser.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/JavaScriptParser.java index bec1cbc3..803dfc38 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/JavaScriptParser.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/JavaScriptParser.java @@ -105,6 +105,7 @@ public void addPropertyChangeListener(String prop, PropertyChangeListener l) { * Creates options for Rhino based off of the user's preferences. * * @param errorHandler The container for errors found while parsing. + * @param langSupport The language support to configure, which may be {@code null}. * @return The properties for the JS compiler to use. */ public static CompilerEnvirons createCompilerEnvironment(ErrorReporter diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/SourceCompletionProvider.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/SourceCompletionProvider.java index a940d277..1849dd5d 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/SourceCompletionProvider.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/SourceCompletionProvider.java @@ -312,7 +312,8 @@ private List resolveCompletions(String text, Set set) { } /** - * Load ECMA JavaScript class completions + * Load ECMA JavaScript class completions. + * * @param set completion set * @param text */ @@ -337,7 +338,8 @@ private void loadECMAClasses(Set set, String text) { /** * returns the Base class for the source completion provider. This is represented by a class name or ECMA lookup name - * e.g. set to 'Global' for server side or 'Window' for client JavaScript support + * e.g. set to 'Global' for server side or 'Window' for client JavaScript support. + * * @return base class for the completion provider */ public String getSelf() { @@ -436,7 +438,8 @@ public JavaScriptVariableDeclaration findDeclaration(String name) { /** * Convenience method to call variable resolver for non-local variables - * i.e. does NOT try to resolve name to any local variables (just pre-processed or system) + * i.e. does NOT try to resolve name to any local variables (just pre-processed or system). + * * @param name * @return JavaScript variable declaration */ @@ -607,7 +610,8 @@ public TypeDeclarationFactory getTypesFactory() { } /** - * Set type declaration options for parser + * Set type declaration options for parser. + * * @param typeDeclarationOptions */ public void setTypeDeclationOptions(TypeDeclarationOptions typeDeclarationOptions) { diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/CodeBlock.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/CodeBlock.java index 6fa83558..4fde4b2e 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/CodeBlock.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/CodeBlock.java @@ -181,6 +181,7 @@ public void setEndOffset(int end) { /** * Sets the start offset of this code block. + * * @param start the start offset * @see #getStartOffset() */ diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/JavaScriptDeclaration.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/JavaScriptDeclaration.java index b153b6fe..827326a5 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/JavaScriptDeclaration.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/JavaScriptDeclaration.java @@ -55,6 +55,7 @@ public void setEndOffset(int end) { /** * Sets the start offset of this declaration. + * * @param start the start offset * @see #getStartOffSet() */ @@ -82,6 +83,7 @@ public CodeBlock getCodeBlock() { /** * Set the JavaScript options associated with this declaration. * These are used to defined whether options are available to + * * @param options */ public void setTypeDeclarationOptions(TypeDeclarationOptions options) { diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/JavaScriptVariableDeclaration.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/JavaScriptVariableDeclaration.java index aadc658b..985a1182 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/JavaScriptVariableDeclaration.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/JavaScriptVariableDeclaration.java @@ -32,6 +32,7 @@ public class JavaScriptVariableDeclaration extends JavaScriptDeclaration { * @param name of the variable * @param offset position within script * @param provider JavaScript source provider + * @param block The code block. */ public JavaScriptVariableDeclaration(String name, int offset, SourceCompletionProvider provider, CodeBlock block) { @@ -51,7 +52,8 @@ public void setTypeDeclaration(AstNode typeNode) { } /** - * Set the TypeDeclaration for the AstNode. Stores the original value so it can be reset + * Set the TypeDeclaration for the AstNode. Stores the original value so it can be reset. + * * @param typeNode * @param overrideOriginal * @see #resetVariableToOriginalType() diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/TypeDeclarationOptions.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/TypeDeclarationOptions.java index 884fa2ae..ef84e4f7 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/TypeDeclarationOptions.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/TypeDeclarationOptions.java @@ -28,6 +28,8 @@ public String getOwnerScriptName() { /** * set the owner script name. + * + * @param ownerScriptName The name of the script that owns this type declaration. */ public void setOwnerScriptName(String ownerScriptName) { this.ownerScriptName = ownerScriptName; @@ -42,6 +44,8 @@ public boolean isSupportsLinks() { /** * set whether the type declaration supports hyperlinks. + * + * @param supportsLinks Whether the type declaration supports hyperlinks. */ public void setSupportsLinks(boolean supportsLinks) { this.supportsLinks = supportsLinks; @@ -55,7 +59,9 @@ public boolean isPreProcessing() { } /** - * set whether the type declaration has been created from a pre-processed script. + * Set whether the type declaration has been created from a pre-processed script. + * + * @param preProcessing Whether the script was pre-processed. */ public void setPreProcessing(boolean preProcessing) { this.preProcessing = preProcessing; diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/jsType/JavaScriptFunctionType.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/jsType/JavaScriptFunctionType.java index d4a2cc0d..01f00688 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/jsType/JavaScriptFunctionType.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/jsType/JavaScriptFunctionType.java @@ -96,6 +96,7 @@ public TypeDeclaration getArgument(int index) { /** * Compare this JavaScriptFunctionType with another and return a weight integer based on the parameters matching or * whether the parameters are compatible. + * * @param compareType method to compare with this * @param provider SourceCompletionProvider * @param isJavaScriptType TODO @@ -135,6 +136,7 @@ public int compare(JavaScriptFunctionType compareType, SourceCompletionProvider /** * Convert parameter into TypeDeclaration. + * * @param type * @param provider * @return @@ -154,6 +156,7 @@ private TypeDeclaration convertParamType(TypeDeclaration type, /** * Converts TypeDeclaration into Java Class and compares whether another parameter is compatible based * on JSR-223. + * * @param param parameter to compare * @param compareParam compare parameter * @param provider SourceCompletionProvider @@ -310,6 +313,7 @@ else if (from.isPrimitive() && to != Boolean.TYPE) { /** * Converts TypeDeclaration qualified name to Java Class. + * * @param name * @return * @throws ClassNotFoundException @@ -377,6 +381,7 @@ else if (cls == JSObjectClass) { /** * Convenience method to parse function string and converts to JavaScriptFunctionType + * * @param function String to parse e.g. convertValue(java.util.String val); * @param provider used for type conversions * @return The function type. @@ -417,6 +422,7 @@ public static JavaScriptFunctionType parseFunction(String function, /** * Converts JavaScript class name to integer code. + * * @param clsName * @return * @throws ClassNotFoundException diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/jsType/JavaScriptType.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/jsType/JavaScriptType.java index d4059b76..5516eb0c 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/jsType/JavaScriptType.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/jsType/JavaScriptType.java @@ -101,6 +101,7 @@ public void removeConstructor(JSCompletion completion) { /** * Set the class type completion e.g. String, Number + * * @param classType Completion to format the class */ public void setClassTypeCompletion(JSCompletion classType) { diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/jsType/JavaScriptTypesFactory.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/jsType/JavaScriptTypesFactory.java index e2ba88d8..a145f305 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/jsType/JavaScriptTypesFactory.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/jsType/JavaScriptTypesFactory.java @@ -254,6 +254,7 @@ private boolean isAccessible(MemberInfo info, boolean staticOnly, boolean isJJTy *
  • !staticsOnly && public return true; //All public methods and fields
    • *
  • Built in JavaScript type and public or protected return true; //All public/protected built in JSType (org.fife.rsta.ac.js.ecma.api.ecma3 package) methods and fields
    • * + * * @param access - access flag to test * @param staticsOnly - whether loading static methods and fields only * @param isJSType - is a built in JavasScript type diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/jsType/RhinoJavaScriptTypesFactory.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/jsType/RhinoJavaScriptTypesFactory.java index 45339773..cd6bae25 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/jsType/RhinoJavaScriptTypesFactory.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/jsType/RhinoJavaScriptTypesFactory.java @@ -79,6 +79,7 @@ private void mergeImports(Set newImports, LinkedHashSet oldImpor /** * Validate whether the newImports and old imports contain the same values + * * @param newImports * @param oldImports * @return @@ -117,6 +118,7 @@ private void clearAllImportTypes() { /** * Remove all TypeDeclarations from the TypeDeclarationFactory from the JavaScriptType and all it's extended classes + * * @param type */ private void removeAllTypes(JavaScriptType type) { @@ -157,6 +159,7 @@ private String removePackagesFromType(String type) { /** * Look for class file using imported classes + * * @param manager * @param name * @return @@ -174,7 +177,8 @@ private ClassFile findFromClasses(JarManager manager, String name) { } /** - * Look for class file using imported packages + * Look for class file using imported packages. + * * @param manager * @param name * @return diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/parser/JavaScriptParser.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/parser/JavaScriptParser.java index af217b6e..96471652 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/parser/JavaScriptParser.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/parser/JavaScriptParser.java @@ -42,6 +42,7 @@ public abstract CodeBlock convertAstNodeToCodeBlock(AstRoot root, /** * If options are null, then it is assumed that the main editor text is being parsed. + * * @return whether options is not null and is in pre-processing mode. * */ diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/parser/RhinoJavaScriptAstParser.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/parser/RhinoJavaScriptAstParser.java index a7729186..b8f79055 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/parser/RhinoJavaScriptAstParser.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/parser/RhinoJavaScriptAstParser.java @@ -33,6 +33,7 @@ public RhinoJavaScriptAstParser(SourceCompletionProvider provider, int dot, /** * Clear the importPackage and importClass cache + * * @param provider SourceCompletionProvider */ public void clearImportCache(SourceCompletionProvider provider) { diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/type/TypeDeclarationFactory.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/type/TypeDeclarationFactory.java index 1c4dce27..67f513e1 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/type/TypeDeclarationFactory.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/type/TypeDeclarationFactory.java @@ -90,6 +90,7 @@ public void removeType(String name) { /** * Returns whether the qualified name is a built-in JavaScript type + * * @param td The type declaration to check. * @return Whether it is a built-in JS type. */ @@ -100,6 +101,7 @@ public boolean isJavaScriptType(TypeDeclaration td) { /** * Returns the type declaration. + * * @param name * @return Lookup type declaration from name. If the * TypeDeclaration cannot be found, then lookup using @@ -123,9 +125,12 @@ private String getJSTypeDeclarationAsString(String name) { /** * The API may have its own types, so these need converting back to - * JavaScript types e.g. JSString == String, JSNumber == Number + * JavaScript types e.g. JSString == String, JSNumber == Number. + * + * @param lookupName The name to look up. + * @param qualified Whether it is fully qualified. + * @return The type. */ - public String convertJavaScriptType(String lookupName, boolean qualified) { if (lookupName != null) { if (TypeDeclarations.NULL_TYPE.equals(lookupName)) { // void has no type @@ -183,8 +188,9 @@ public Set getECMAScriptObjects() { /** * Answers the question whether an object can be instantiated (i.e. has a constructor) - * @param name name of class to test * + * @param name name of class to test + * @return Whether the object can be instantiated. */ public boolean canJavaScriptBeInstantiated(String name) { return ecma.canECMAObjectBeInstantiated(name); diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/type/ecma/TypeDeclarations.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/type/ecma/TypeDeclarations.java index 81d4cde2..ae347d1b 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/type/ecma/TypeDeclarations.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ast/type/ecma/TypeDeclarations.java @@ -183,8 +183,8 @@ public void removeType(String name) { /** * Returns whether the qualified name is a built-in JavaScript type * - * @param td - * @return + * @param td The type declaration, which may be {@code null}. + * @return Whether it is a built-in JS type. */ public boolean isJavaScriptType(TypeDeclaration td) { return td != null && td.getPackageName() != null @@ -255,8 +255,9 @@ public Set getJavaScriptObjects() { /** * Answers the question whether an object can be instantiated (i.e. has a constructor) * Note, only tests ECMA objects - * @param name name of class to test * + * @param name name of class to test + * @return Whether the object can be instantiated. */ public boolean canECMAObjectBeInstantiated(String name) { String tempName = javascriptReverseLookup.get(name); diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/History.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/History.java index d4a8e4ed..35ef3aa2 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/History.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/History.java @@ -9,7 +9,8 @@ public abstract class History implements HistoryFunctions { /** - * Object History() + * Object History(). + * * @super Object * @constructor * @since Common Usage, no standard @@ -39,7 +40,8 @@ public History(){} public History prototype; /** - * Property length + * Property length. + * * @type Number * @memberOf History */ diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/Location.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/Location.java index f34a3305..fb352efc 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/Location.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/Location.java @@ -8,7 +8,8 @@ public abstract class Location implements LocationFunctions { /** - * Object Location() + * Object Location(). + * * @super Object * @constructor * @since Common Usage, no standard @@ -16,7 +17,7 @@ public abstract class Location implements LocationFunctions { public Location(){} /** - * property constructor + * property constructor. * * @type Function * @memberOf Object @@ -27,7 +28,7 @@ public Location(){} protected JSFunction constructor; /** - * property prototype + * property prototype. * * @type Location * @memberOf Location @@ -36,7 +37,7 @@ public Location(){} public Location prototype; /** - * property location + * property location. * * @type Location * @memberOf Location @@ -45,42 +46,48 @@ public Location(){} public Location location; /** - * Property hash + * Property hash. + * * @type String * @memberOf Location */ public JSString hash; /** - * Property host + * Property host. + * * @type String * @memberOf Location */ public JSString host; /** - * Property hostname + * Property hostname. + * * @type String * @memberOf Location */ public JSString hostname; /** - * Property href + * Property href. + * * @type String * @memberOf Location */ public JSString href; /** - * Property pathname + * Property pathname. + * * @type String * @memberOf Location */ public JSString pathname; /** - * Property port + * Property port. + * * @type String * @memberOf Location */ @@ -88,13 +95,15 @@ public Location(){} /** * Property protocol + * * @type String * @memberOf Location */ public JSString protocol; /** - * Property search + * Property search. + * * @type String * @memberOf Location */ diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/Navigator.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/Navigator.java index 5fbc1182..e130ac03 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/Navigator.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/Navigator.java @@ -10,7 +10,8 @@ public abstract class Navigator implements NavigatorFunctions { /** - * Object Navigator() + * Object Navigator(). + * * @super Object * @constructor * @since Common Usage, no standard @@ -38,56 +39,64 @@ public Navigator(){} public Navigator prototype; /** - * Property appCodeName + * Property appCodeName. + * * @type String * @memberOf Navigator */ public JSString appCodeName; /** - * Property appName + * Property appName. + * * @type String * @memberOf Navigator */ public JSString appName; /** - * Property appVersion + * Property appVersion. + * * @type String * @memberOf Navigator */ public JSString appVersion; /** - * Property cookieEnabled + * Property cookieEnabled. + * * @type Boolean * @memberOf Navigator */ public JSBoolean cookieEnabled; /** - * Property mimeTypes + * Property mimeTypes. + * * @type Array * @memberOf Navigator */ public JS5Array mimeTypes; /** - * Property platform + * Property platform. + * * @type String * @memberOf Navigator */ public JSString platform; /** - * Property plugins + * Property plugins. + * * @type Array * @memberOf Navigator */ public JS5Array plugins; /** - * Property userAgent + * Property userAgent. + * * @type String * @memberOf Navigator */ diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/Window.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/Window.java index e1333d7d..fba0464b 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/Window.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/Window.java @@ -13,7 +13,7 @@ public abstract class Window extends JSGlobal implements WindowFunctions { /** - * Object Window() + * Object Window(). * * @constructor * @extends Global @@ -21,7 +21,7 @@ public abstract class Window extends JSGlobal implements WindowFunctions { public Window(){} /** - * property constructor + * property constructor. * * @type Function * @memberOf Object @@ -32,7 +32,7 @@ public Window(){} protected JSFunction constructor; /** - * property prototype + * property prototype. * * @type Window * @memberOf Window @@ -43,63 +43,72 @@ public Window(){} public Window prototype; /** - * Property closed + * Property closed. + * * @type Boolean * @memberOf Window */ public JSBoolean closed; /** - * Property window + * Property window. + * * @type Window * @memberOf Window */ public Window window; /** - * Property frames + * Property frames. + * * @type Array * @memberOf Window */ public JSArray frames; /** - * Property defaultStatus + * Property defaultStatus. + * * @type String * @memberOf Window */ public JSString defaultStatus; /** - * Property document + * Property document. + * * @type Document * @memberOf Window */ public JSHTMLDocument document; /** - * Property history + * Property history. + * * @type History * @memberOf Window */ public History history; /** - * Property location + * Property location. + * * @type Location * @memberOf Window */ public Location location; /** - * Property name + * Property name. + * * @type String * @memberOf Window */ public JSString name; /** - * Property navigator + * Property navigator. + * * @type Navigator * @memberOf Window */ @@ -107,217 +116,248 @@ public Window(){} /** - * Property opener + * Property opener. + * * @type Window * @memberOf Window */ public Window opener; /** - * Property outerWidth + * Property outerWidth. + * * @type Number * @memberOf Window */ public JSNumber outerWidth; /** - * Property outerHeight + * Property outerHeight. + * * @type Number * @memberOf Window */ public JSNumber outerHeight; /** - * Property pageXOffset + * Property pageXOffset. + * * @type Number * @memberOf Window */ public JSNumber pageXOffset; /** - * Property pageYOffset + * Property pageYOffset. + * * @type Number * @memberOf Window */ public JSNumber pageYOffset; /** - * Property parent + * Property parent. + * * @type Window * @memberOf Window */ public Window parent; /** - * Property screen + * Property screen. + * * @type Screen * @memberOf Window */ public Screen screen; /** - * Property status + * Property status. + * * @type String * @memberOf Window */ public JSString status; /** - * Property top + * Property top. + * * @type Window * @memberOf Window */ public Window top; /** - * Property innerWidth + * Property innerWidth. + * * @type Number * @memberOf Window */ public JSNumber innerWidth; /** - * Property innerHeight + * Property innerHeight. + * * @type Number * @memberOf Window */ public JSNumber innerHeight; /** - * Property screenX + * Property screenX. + * * @type Number * @memberOf Window */ public JSNumber screenX; /** - * Property screenY + * Property screenY. + * * @type Number * @memberOf Window */ public JSNumber screenY; /** - * Property screenLeft + * Property screenLeft. + * * @type Number * @memberOf Window */ public JSNumber screenLeft; /** - * Property screenTop + * Property screenTop. + * * @type Number * @memberOf Window */ public JSNumber screenTop; /** - * Property length + * Property length. + * * @type Number * @memberOf Window */ public JSNumber length; /** - * Property scrollbars + * Property scrollbars. + * * @type BarProp * @memberOf Window */ public BarProp scrollbars; /** - * Property scrollX + * Property scrollX. + * * @type Number * @memberOf Window */ public JSNumber scrollX; /** - * Property scrollY + * Property scrollY. + * * @type Number * @memberOf Window */ public JSNumber scrollY; /** - * Property content + * Property content. + * * @type Window * @memberOf Window */ public Window content; /** - * Property menubar + * Property menubar. + * * @type BarProp * @memberOf Window */ public BarProp menubar; /** - * Property toolbar + * Property toolbar. + * * @type BarProp * @memberOf Window */ public BarProp toolbar; /** - * Property locationbar + * Property locationbar. + * * @type BarProp * @memberOf Window */ public BarProp locationbar; /** - * Property personalbar + * Property personalbar. + * * @type BarProp * @memberOf Window */ public BarProp personalbar; /** - * Property statusbar + * Property statusbar. + * * @type BarProp * @memberOf Window */ public BarProp statusbar; /** - * Property directories + * Property directories. + * * @type BarProp * @memberOf Window */ public BarProp directories; /** - * Property scrollMaxX + * Property scrollMaxX. + * * @type Number * @memberOf Window */ public JSNumber scrollMaxX; /** - * Property scrollMaxY + * Property scrollMaxY. + * * @type Number * @memberOf Window */ public JSNumber scrollMaxY; /** - * Property fullScreen + * Property fullScreen. + * * @type String * @memberOf Window */ public JSString fullScreen; /** - * Property frameElement + * Property frameElement. + * * @type String * @memberOf Window */ public JSString frameElement; /** - * Property sessionStorage + * Property sessionStorage. + * * @type String * @memberOf Window */ diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/funtions/HistoryFunctions.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/funtions/HistoryFunctions.java index f90f2d7f..9ca8d64b 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/funtions/HistoryFunctions.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/funtions/HistoryFunctions.java @@ -9,32 +9,36 @@ public interface HistoryFunctions extends JS5ObjectFunctions { /** - * function back - Loads the previous URL in the history list. - * @memberOf History - * @see org.fife.rsta.ac.js.ecma.api.client.History History - */ + * function back - Loads the previous URL in the history list. + * + * @memberOf History + * @see org.fife.rsta.ac.js.ecma.api.client.History History + */ void back(); /** - * function forward - Loads the next URL in the history list. - * @memberOf History - * @see org.fife.rsta.ac.js.ecma.api.client.History History - */ + * function forward - Loads the next URL in the history list. + * + * @memberOf History + * @see org.fife.rsta.ac.js.ecma.api.client.History History + */ void forward(); /** - * function go - Loads a specific URL from the history list. - * @memberOf History - * @param arg goes to the URL within the specific position (-1 goes back one page, 1 goes forward one page) - * @see org.fife.rsta.ac.js.ecma.api.client.History History - */ + * function go - Loads a specific URL from the history list. + * + * @memberOf History + * @param arg goes to the URL within the specific position (-1 goes back one page, 1 goes forward one page) + * @see org.fife.rsta.ac.js.ecma.api.client.History History + */ void go(JSNumber arg); /** - * function go - Loads a specific URL from the history list. - * @memberOf History - * @param arg the string must be a partial or full URL, and the function will go to the first URL that matches the string - * @see org.fife.rsta.ac.js.ecma.api.client.History History - */ + * function go - Loads a specific URL from the history list. + * + * @memberOf History + * @param arg the string must be a partial or full URL, and the function will go to the first URL that matches the string + * @see org.fife.rsta.ac.js.ecma.api.client.History History + */ void go(JSString arg); } diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/funtions/LocationFunctions.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/funtions/LocationFunctions.java index f94fa68e..663a40a7 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/funtions/LocationFunctions.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/funtions/LocationFunctions.java @@ -8,21 +8,24 @@ public interface LocationFunctions extends JS5ObjectFunctions { /** - * function assign(newURL) method loads a new document + * function assign(newURL) method loads a new document. + * * @param newURL * @memberOf Location */ void assign(JSString newURL); /** - * function reload(optionalArg) - Reload the current document + * function reload(optionalArg) - Reload the current document. + * * @param optionalArg - default false which reloads the page from the cache. Set this paramter to true if you want to force the browser to get the page from the server * @memberOf Location */ void reload(JSBoolean optionalArg); /** - * function replace(newURL) - method replaces the current document with a new one + * function replace(newURL) - method replaces the current document with a new one. + * * @param newUrl * @memberOf Location */ diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/funtions/NavigatorFunctions.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/funtions/NavigatorFunctions.java index 0d2e8b03..dba552bc 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/funtions/NavigatorFunctions.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/funtions/NavigatorFunctions.java @@ -7,7 +7,8 @@ public interface NavigatorFunctions extends JS5ObjectFunctions { /** - * function javaEnabled() - Specifies whether the browser has Java enabled + * function javaEnabled() - Specifies whether the browser has Java enabled. + * * @returns true if java is enabled * @memberOf Navigator */ diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/funtions/WindowFunctions.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/funtions/WindowFunctions.java index b07d430e..b9140a0c 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/funtions/WindowFunctions.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/client/funtions/WindowFunctions.java @@ -13,40 +13,46 @@ public interface WindowFunctions extends JS5ObjectFunctions { /** - * function alert() Displays an alert box with a message and an OK button + * function alert() Displays an alert box with a message and an OK button. + * * @param arg * @memberOf Window */ void alert(JSString arg); /** - * function blur() Removes focus from the current window + * function blur() Removes focus from the current window. + * * @memberOf Window */ void blur(); /** - * function clearInterval(arg) Clears a timer set with setInterval() + * function clearInterval(arg) Clears a timer set with setInterval(). + * * @param arg * @memberOf Window */ void clearInterval(JS5Object arg); /** - * function clearTimeout(arg) Clears a timer set with setTimeout() + * function clearTimeout(arg) Clears a timer set with setTimeout(). + * * @param arg * @memberOf Window */ void clearTimeout(JS5Object arg); /** - * function close() Closes the current window + * function close() Closes the current window. + * * @memberOf Window */ void close(); /** - * function confirm() Displays a dialog box with a message and an OK and a Cancel button + * function confirm() Displays a dialog box with a message and an OK and a Cancel button. + * * @param arg * @memberOf Window * @returns Boolean @@ -54,13 +60,15 @@ public interface WindowFunctions extends JS5ObjectFunctions { JSBoolean confirm(JSString arg); /** - * function focus() Sets focus to the current window + * function focus() Sets focus to the current window. + * * @memberOf Window */ void focus(); /** - * function getComputedStyle(arg1, arg2) + * function getComputedStyle(arg1, arg2). + * * @param arg1 * @param arg2 * @memberOf Window @@ -69,7 +77,8 @@ public interface WindowFunctions extends JS5ObjectFunctions { JS5Object getComputedStyle(Element arg1, JSString arg2); /** - * function moveTo(arg1, arg2) Moves a window to the specified position + * function moveTo(arg1, arg2) Moves a window to the specified position. + * * @param arg1 * @param arg2 * @memberOf Window @@ -77,7 +86,8 @@ public interface WindowFunctions extends JS5ObjectFunctions { void moveTo(JSNumber arg1,JSNumber arg2); /** - * function moveBy(arg1, arg2) Moves a window relative to its current position + * function moveBy(arg1, arg2) Moves a window relative to its current position. + * * @param arg1 * @param arg2 * @memberOf Window @@ -97,20 +107,23 @@ public interface WindowFunctions extends JS5ObjectFunctions { Window open(JSString url, JSString name, JSString specs, JSBoolean replace); /** - * function print() Prints the content of the current window + * function print() Prints the content of the current window. + * * @memberOf Window */ void print(); /** - * function prompt(arg1, arg2) Displays a dialog box that prompts the visitor for input + * function prompt(arg1, arg2) Displays a dialog box that prompts the visitor for input. + * * @memberOf Window * @returns String */ JSString prompt(); /** - * function resizeTo(arg1, arg2) Resizes the window to the specified width and height + * function resizeTo(arg1, arg2) Resizes the window to the specified width and height. + * * @param arg1 * @param arg2 * @memberOf Window @@ -118,7 +131,8 @@ public interface WindowFunctions extends JS5ObjectFunctions { void resizeTo(JSNumber arg1, JSNumber arg2); /** - * function resizeBy(arg1, arg2) Resizes the window by the specified pixels + * function resizeBy(arg1, arg2) Resizes the window by the specified pixels. + * * @param arg1 * @param arg2 * @memberOf Window @@ -126,7 +140,8 @@ public interface WindowFunctions extends JS5ObjectFunctions { void resizeBy(JSNumber arg1, JSNumber arg2); /** - * function scrollTo(arg1, arg2) Scrolls the content to the specified coordinates + * function scrollTo(arg1, arg2) Scrolls the content to the specified coordinates. + * * @param arg1 * @param arg2 * @memberOf Window @@ -134,7 +149,8 @@ public interface WindowFunctions extends JS5ObjectFunctions { void scrollTo(JSNumber arg1, JSNumber arg2); /** - * function scrollBy(arg1, arg2) Scrolls the content by the specified number of pixels + * function scrollBy(arg1, arg2) Scrolls the content by the specified number of pixels. + * * @param arg1 * @param arg2 * @memberOf Window @@ -142,7 +158,8 @@ public interface WindowFunctions extends JS5ObjectFunctions { void scrollBy(JSNumber arg1, JSNumber arg2); /** - * function setInterval(arg1, arg2) Calls a function or evaluates an expression at specified intervals (in milliseconds) + * function setInterval(arg1, arg2) Calls a function or evaluates an expression at specified intervals (in milliseconds). + * * @param arg1 * @param arg2 * @memberOf Window @@ -151,7 +168,8 @@ public interface WindowFunctions extends JS5ObjectFunctions { JSNumber setInterval(JSObject arg1, JSNumber arg2); /** - * function setTimeout(arg1, arg2) Calls a function or evaluates an expression after a specified number of milliseconds + * function setTimeout(arg1, arg2) Calls a function or evaluates an expression after a specified number of milliseconds. + * * @param arg1 * @param arg2 * @memberOf Window @@ -161,6 +179,7 @@ public interface WindowFunctions extends JS5ObjectFunctions { /** * function atob(arg) The atob() method of window object decodes a string of data which has been encoded using base-64 encoding. For example, the window.btoa method takes a binary string as a parameter and returns a base-64 encoded string. + * * @param arg * @memberOf Window * @returns String @@ -169,6 +188,7 @@ public interface WindowFunctions extends JS5ObjectFunctions { /** * function btoa(arg) The btoa() method of window object is used to convert a given string to an encoded data (using base-64 encoding) string. + * * @param arg * @memberOf Window * @returns {String} @@ -176,7 +196,8 @@ public interface WindowFunctions extends JS5ObjectFunctions { JSString btoa(JSString arg); /** - * function setResizable(arg) + * function setResizable(arg). + * * @param arg * @memberOf Window */ diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/e4x/E4XQName.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/e4x/E4XQName.java index 260db1f0..1beca3cf 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/e4x/E4XQName.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/e4x/E4XQName.java @@ -35,7 +35,8 @@ public E4XQName(JSString name) { } /** - * Object QName(namespace, name) + * Object QName(namespace, name). + * * @constructor * @param namespace optional namespace part of QName * @param name localname of the QName diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/e4x/E4XXML.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/e4x/E4XXML.java index bdd8cfb5..b2e2a2b6 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/e4x/E4XXML.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/e4x/E4XXML.java @@ -123,6 +123,7 @@ public E4XXML(JSObject xml) { * return comments; * } * + * * @return an object containing the properties of the XML constructor used for storing XML settings. * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/e4x/functions/E4XGlobalFunctions.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/e4x/functions/E4XGlobalFunctions.java index 6ce35c91..57a61ff1 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/e4x/functions/E4XGlobalFunctions.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/e4x/functions/E4XGlobalFunctions.java @@ -9,6 +9,7 @@ public interface E4XGlobalFunctions extends JS5ObjectFunctions { /** * function isXMLName(name) determines whether name is a valid XML name. + * * @param name The name to be tested. * @returns examines the given value and determines whether it is a valid XML {@code name} that can be used as an XML element or attribute name. If so, it returns true, otherwise it returns false. * @memberOf Global diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/e4x/functions/E4XXMLFunctions.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/e4x/functions/E4XXMLFunctions.java index bd900ce7..89a14dd4 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/e4x/functions/E4XXMLFunctions.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/e4x/functions/E4XXMLFunctions.java @@ -16,6 +16,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function addNamespace(namespace) adds a namespace declaration to the in scope namespaces for this XML object and returns this XML object. + * * @param namespace The namespace to be added. * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -35,6 +36,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { * // Add a new child element to the end of Jim's employee element * e.employee.(name == "Jim").appendChild(snorkeling);} * + * * @param xml to be appended. * @returns this XML Object * @memberOf XML @@ -51,6 +53,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { * // get the id of the employee named Jim * e.employee.(name == "Jim").attribute("id"); * + * * @param attributeName name of attribute to find. * @returns an XMLList containing zero or one XML attributes associated with this XML object that have the given attributeName. * @memberOf XML @@ -71,6 +74,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { * } * } * + * * @returns an XMLList containing the XML attributes of this object. * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -87,6 +91,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { * var name = customer.child("name"); // equivalent to: var name = customer.name; * var secondChild = customer.child(1); // equivalent to: var secondChild = customer.*[1] * + * * @param propertyName name of XML element to find. * @returns the list of children in this XML object matching the given propertyName. If propertyName is a numeric index, the child method returns a list containing the child at the ordinal position identified by propertyName. * @memberOf XML @@ -103,6 +108,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { * var name = customer.child("name"); // equivalent to: var name = customer.name; * var secondChild = customer.child(1); // equivalent to: var secondChild = customer.*[1] * + * * @param propertyName name of XML element to find. * @returns the list of children in this XML object matching the given propertyName. If propertyName is a numeric index, the child method returns a list containing the child at the ordinal position identified by propertyName. * @memberOf XML @@ -119,6 +125,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { * // Get the ordinal index of the employee named Joe. * var joeindex = e.employee.(name == "Joe").childIndex(); * + * * @returns a Number representing the ordinal position of this XML object within the context of its parent. * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -135,6 +142,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { * // Jim, 25 and Snorkeling * var employees = e.employee[0].children(); * + * * @returns an XMLList containing all the properties of this XML object in order. * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -144,6 +152,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function comments() returns list of comments for the XML element. + * * @returns an XMLList containing the properties of this XML object that represent XML comments. * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -153,6 +162,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function contains(value) returns the result of comparing this XML object with the given value. + * * @returns the result of comparing this XML object with the given value. This treatment intentionally blurs the distinction between a single XML object and an XMLList containing only one value. * @param value XML object to test. * @memberOf XML @@ -163,6 +173,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function contains(value) returns the result of comparing this XML object with the given value. + * * @returns the result of comparing this XML object with the given value. This treatment intentionally blurs the distinction between a single XML object and an XMLList containing only one value. * @param value XMLList object to test. * @memberOf XML @@ -173,6 +184,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function copy() returns a deep copy of the XML object. + * * @returns the copy method returns a deep copy of this XML object with the internal [[Parent]] property set to null. * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -182,6 +194,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function descendants(name) returns all the XML valued descendants (children, grandchildren, great-grandchildren, etc.) + * * @returns all the XML valued descendants (children, grandchildren, great-grandchildren, etc.) of this XML object with the given name. If the name parameter is omitted, it returns all descendants of this XML object. * @param name optional parameter to identity the decendants. If omitted all decendants are returned. * @memberOf XML @@ -192,6 +205,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function elements(name) returns the child elements. + * * @returns an XMLList containing all the children of this XML object that are XML elements with the given name. When the elements method is called with no parameters, it returns an XMLList containing all the children of this XML object that are XML elements regardless of their name. * @param name optional parameter to identity the element. If omitted all children are returned. * @memberOf XML @@ -202,6 +216,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function hasComplexContent() a Boolean value indicating whether this XML object contains complex content. + * * @returns a Boolean value indicating whether this XML object contains complex content. An XML object is considered to contain complex content if it represents an XML element that has child elements. XML objects representing attributes, comments, processing instructions and text nodes do not have complex content. * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -211,6 +226,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function hasSimpleContent() a Boolean value indicating whether this XML object contains simple content. + * * @returns a Boolean value indicating whether this XML object contains simple content. An XML object is considered to contain simple content if it represents a text node, represents an attribute node or if it represents an XML element that has no child elements. XML objects representing comments and processing instructions do not have simple content. * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -220,6 +236,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function inScopeNamespaces() returns an array of Namespace objects representing the namespaces in scope for this object. + * * @returns an array of Namespace objects representing the namespaces in scope for this object. * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -229,6 +246,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function insertChildAfter( child1 , child2) inserts the given {@code child2} after the given {@code child1} in this XML object and returns this XML object. If {@code child1} is null, the insertChildAfter method inserts {@code child2} before all children of this XML object (i.e., after none of them). If {@code child1} does not exist in this XML object, it returns without modifying this XML object. + * * @returns XML object representing x. * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -248,6 +266,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function length() the length method always returns the integer 1 for XML objects. + * * @returns 1 for XML objects (allowing an XML object to be treated like an XML List with a single item.) * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -257,6 +276,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function localName() returns the localName part of the XML object. + * * @returns the local name of this object. * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -266,6 +286,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function name() returns qualified name for the XML object. + * * @returns the qualified name associated with this XML object. * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -275,6 +296,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function namespace(prefix) returns the namespace associated with this object. + * * @param prefix optional prefix identifier * @returns the namespace associated with this object, or if a prefix is specified, an in-scope namespace with that prefix. * @memberOf XML @@ -285,6 +307,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function namespaceDeclarations() returns a string representing the kind of object this is (e.g. "element"). + * * @returns an Array of Namespace objects representing the namespace declarations associated with this XML object in the context of its parent. * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -294,6 +317,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function nodeKind() return an array of Namespace objects representing the namespace declarations associated with this object. + * * @returns a string representing the Class of this XML object * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -303,6 +327,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function normalize() puts all text nodes in this and all descendant XML objects into a normal form by merging adjacent text nodes and eliminating empty text nodes. + * * @returns this XML object * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -318,6 +343,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { * // Get the parent element of the second name in "e". Returns {@code + * * @returns the parent of this XML object * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -327,6 +353,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function processingInstructions(name) A list of all processing instructions that are children of this element. + * * @param name optional node name filter. * @returns an XMLList containing all the children of this XML object that are processing-instructions with the given name. When the processingInstructions method is called with no parameters, it returns an XMLList containing all the children of this XML object that are processing-instructions regardless of their name. * @memberOf XML @@ -343,6 +370,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { * // Add a new child element to the front of John's employee element * e.employee.(name == "John").prependChild({@code Mr.}); * + * * @returns this XML object * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -352,6 +380,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function removeNamespace(namespace) removes a namespace from the in-scope namespaces of the element. + * * @param namespace to remove * @returns a copy of this XML object. * @memberOf XML @@ -370,6 +399,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { * // Replace all item elements in the order with a single empty item * order.replace("item", );} * + * * @param propertyName name of property to replace. * @param value XML, XMLList or any other object (that can be converted using ToString()) to insert. * @returns this XML object @@ -389,6 +419,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { * // Replace all item elements in the order with a single empty item * order.replace("item", );} * + * * @param propertyName number index to replace. * @param value XML, XMLList or any other object (that can be converted using ToString()) to insert. * @returns this XML object @@ -407,6 +438,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { * employees.replace(0, ); * e.employee.(name == "Jim").setChildren(John + 35);} * + * * @param value new XML to set. * @returns this XML object * @memberOf XML @@ -424,6 +456,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { * employees.replace(0, ); * e.employee.(name == "Jim").setChildren(John + 35);} * + * * @param value new XMLList to set. * @returns this XML object * @memberOf XML @@ -434,6 +467,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function setLocalName(name) replaces the local name of this XML object with a string constructed from the given name. + * * @param name to set for the XML element. * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -443,6 +477,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function setName(name) sets the name of the XML object to the requested value (possibly qualified). + * * @param name qualified name to set. * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -452,6 +487,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function setNamespace(namespace) sets the namespace of the XML object to the requested value. + * * @param namespace to set. * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -461,6 +497,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function text() returns an XMLList containing all XML properties of this XML object that represent XML text nodes. + * * @return concatenation of all text node children as a list. * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML @@ -470,6 +507,7 @@ public interface E4XXMLFunctions extends JSObjectFunctions { /** * function toXMLString() returns the toXMLString() method returns an XML encoded string representation of this XML object. Unlike the toString method, toXMLString provides no special treatment for XML objects that contain only XML text nodes (i.e., primitive values). The toXMLString method always includes the start tag, attributes and end tag of the XML object regardless of its content. It is provided for cases when the default XML to string conversion rules are not desired. + * * @return Serializes this XML object as parseable XML. * @memberOf XML * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XML diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/e4x/functions/E4XXMLListFunctions.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/e4x/functions/E4XXMLListFunctions.java index 7cc8c965..6bc7000b 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/e4x/functions/E4XXMLListFunctions.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/e4x/functions/E4XXMLListFunctions.java @@ -12,6 +12,7 @@ public interface E4XXMLListFunctions extends JSObjectFunctions { /** * function attribute(attributeName) calls the attribute method of each XML object in this XMLList object passing attributeName as a parameter and returns an XMLList containing the results in order. + * * @param attributeName name of attribute to find. * @returns an XMLList containing the results in order * @memberOf XMLList @@ -23,6 +24,7 @@ public interface E4XXMLListFunctions extends JSObjectFunctions { /** * function attributes() calls the attributes() method of each XML object in this XMLList object and returns an XMLList containing the results in order. + * * @returns an XMLList containing the results in order. * @memberOf XMLList * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXMLList XMLList @@ -33,6 +35,7 @@ public interface E4XXMLListFunctions extends JSObjectFunctions { /** * function child(propertyName) calls the child() method of each XML object in this XMLList object and returns an XMLList containing the results in order. + * * @param propertyName name of XML element to find. * @returns an XMLList containing the results in order. * @memberOf XMLList @@ -53,6 +56,7 @@ public interface E4XXMLListFunctions extends JSObjectFunctions { * // get all grandchildren of the order that have the name price * var grandChildren = order.children().price; * + * * @returns an XMLList containing the results concatenated in order. * @memberOf XMLList * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXML XMLList @@ -63,6 +67,7 @@ public interface E4XXMLListFunctions extends JSObjectFunctions { /** * function comments() calls the comments method of each XML object in this XMLList object and returns an XMLList containing the results concatenated in order. + * * @returns an XMLList containing the results concatenated in order. * @memberOf XMLList * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXMLList XMLList @@ -73,6 +78,7 @@ public interface E4XXMLListFunctions extends JSObjectFunctions { /** * function contains(value) returns a boolean value indicating whether this XMLList object contains an XML object that compares equal to the given value. + * * @returns true if XMLList contains XML value, otherwise false. * @param value XML object to test. * @memberOf XMLList @@ -83,6 +89,7 @@ public interface E4XXMLListFunctions extends JSObjectFunctions { /** * function copy() returns a deep copy of the XMLList object. + * * @returns the copy method returns a deep copy of this XMLList object.. * @memberOf XMLList * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXMLList XMLList @@ -92,6 +99,7 @@ public interface E4XXMLListFunctions extends JSObjectFunctions { /** * function descendants(name) calls the descendants method of each XML object in this XMLList object with the optional parameter name (or the string "*" if name is omitted) and returns an XMLList containing the results concatenated in order. + * * @returns all the XML valued descendants (children, grandchildren, great-grandchildren, etc.) of this XMLList object with the given name. If the name parameter is omitted, it returns all descendants of this XMLList object. * @param name optional parameter to identity the descendants. If omitted all descendants are returned. * @memberOf XMLList @@ -103,6 +111,7 @@ public interface E4XXMLListFunctions extends JSObjectFunctions { /** * function elements(name) calls the elements method of each XML object in this XMLList object passing the optional parameter name (or "*" if it is omitted) and returns an XMList containing the results in order. + * * @returns an XMLList containing all the children of this XMLList object that are XML elements with the given name. When the elements method is called with no parameters, it returns an XMLList containing all the children of this XML object that are XML elements regardless of their name. * @param name optional parameter to identity the element. If omitted all children are returned. * @memberOf XMLList @@ -114,6 +123,7 @@ public interface E4XXMLListFunctions extends JSObjectFunctions { /** * function hasComplexContent() returns a Boolean value indicating whether this XMLList object contains complex content. An XMLList object is considered to contain complex content if it is not empty, contains a single XML item with complex content or contains elements. + * * @returns true if XMLList contains complex content, otherwise false. * @memberOf XMLList * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXMLList XMLList @@ -123,6 +133,7 @@ public interface E4XXMLListFunctions extends JSObjectFunctions { /** * function hasSimpleContent() returns a Boolean value indicating whether this XMLList contains simple content. An XMLList object is considered to contain simple content if it is empty, contains a single XML item with simple content or contains no elements. + * * @returns true if XMLList contains simple content, otherwise false. * @memberOf XMLList * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXMLList XMLList @@ -139,6 +150,7 @@ public interface E4XXMLListFunctions extends JSObjectFunctions { * print("Employee name:" + e..name[i]); * } * + * * @returns the number of properties in this XMLList object. * @memberOf XMLList * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXMLList XMLList @@ -148,6 +160,7 @@ public interface E4XXMLListFunctions extends JSObjectFunctions { /** * function normalize() puts all text nodes in this XMLList, all the XML objects it contains and the descendents of all the XML objects it contains into a normal form by merging adjacent text nodes and eliminating empty text nodes. + * * @returns this XMLList object * @memberOf XMLList * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXMLList XMLList @@ -157,6 +170,7 @@ public interface E4XXMLListFunctions extends JSObjectFunctions { /** * function parent() If all items in this XMLList object have the same parent, it is returned. Otherwise, the parent method returns undefined. + * * @returns the parent of this XMLList object * @memberOf XMLList * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXMLList XMLList @@ -166,6 +180,7 @@ public interface E4XXMLListFunctions extends JSObjectFunctions { /** * function processingInstructions(name) calls the processingInstructions method of each XML object in this XMLList object passing the optional parameter name (or "*" if it is omitted) and returns an XMList containing the results in order. + * * @param name optional node name filter. * @returns an XMList containing the results in order. * @memberOf XMLList @@ -177,6 +192,7 @@ public interface E4XXMLListFunctions extends JSObjectFunctions { /** * function text() calls the text method of each XML object contained in this XMLList object and returns an XMLList containing the results concatenated in order. + * * @return an XMLList containing the results concatenated in order. * @memberOf XMLList * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXMLList XMLList @@ -187,6 +203,7 @@ public interface E4XXMLListFunctions extends JSObjectFunctions { /** * function toXMLString() returns the toXMLString() method returns an XML encoded string representation of this XML object. Unlike the toString method, toXMLString provides no special treatment for XML objects that contain only XML text nodes (i.e., primitive values). The toXMLString method always includes the start tag, attributes and end tag of the XML object regardless of its content. It is provided for cases when the default XML to string conversion rules are not desired. + * * @return Serializes this XML object as parseable XML. * @memberOf XMLList * @see org.fife.rsta.ac.js.ecma.api.e4x.E4XXMLList XMLList diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSArray.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSArray.java index 56b2c48a..af0cff09 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSArray.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSArray.java @@ -3,7 +3,8 @@ import org.fife.rsta.ac.js.ecma.api.ecma3.functions.JSArrayFunctions; /** - * Object Array + * Object Array. + * * @since Standard ECMA-262 3rd. Edition */ public abstract class JSArray implements JSArrayFunctions { diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSBoolean.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSBoolean.java index 90807c04..5f21350f 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSBoolean.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSBoolean.java @@ -4,7 +4,8 @@ /** - * Object Boolean + * Object Boolean. + * * @since Standard ECMA-262 3rd. Edition */ public abstract class JSBoolean implements JSObjectFunctions { diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSDate.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSDate.java index 89675d78..c517a7bb 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSDate.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSDate.java @@ -4,7 +4,8 @@ /** - * Object Date + * Object Date. + * * @since Standard ECMA-262 3rd. Edition */ public abstract class JSDate implements JSDateFunctions { diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSError.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSError.java index 82aff85d..7ed667e6 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSError.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSError.java @@ -4,7 +4,8 @@ /** - * Object Error + * Object Error. + * * @since Standard ECMA-262 3rd. Edition */ public abstract class JSError implements JSObjectFunctions { diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSFunction.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSFunction.java index c41db07f..4b38be93 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSFunction.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSFunction.java @@ -4,13 +4,15 @@ /** - * Object Function + * Object Function. + * * @since Standard ECMA-262 3rd. Edition */ public abstract class JSFunction implements JSFunctionFunctions { /** - * Object Function(argument_names..., body) + * Object Function(argument_names..., body). + * * @constructor * @extends Object * @param argumentNames Any number of string arguments, each naming one or more arguments of the Function object to be created. diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSMath.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSMath.java index 77d63f00..ce2b0545 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSMath.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSMath.java @@ -2,7 +2,8 @@ /** - * Object Math + * Object Math. + * * @since Standard ECMA-262 3rd. Edition */ public abstract class JSMath { @@ -173,6 +174,7 @@ public static JSNumber atan2(JSNumber y, JSNumber x) { * c = Math.ceil(1.0) //returns 1.0 * d = Math.ceil(-1.99); //returns -1.0 * + * * @memberOf Math * @param x any number or numeric value. * @type Number @@ -225,6 +227,7 @@ public static JSNumber exp(JSNumber x) { * c = Math.floor(1.0) //returns 1.0 * d = Math.floor(-1.99); //returns -2.0 * + * * @memberOf Math * @param x any number or numeric value. * @type Number diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSNumber.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSNumber.java index 9e721b1b..7a988955 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSNumber.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSNumber.java @@ -4,7 +4,8 @@ /** - * Object Number + * Object Number. + * * @since Standard ECMA-262 3rd. Edition */ public abstract class JSNumber implements JSNumberFunctions { diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSObject.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSObject.java index 2009640d..fb690578 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSObject.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSObject.java @@ -4,7 +4,8 @@ /** - * Base JavaScript Object + * Base JavaScript Object. + * * @since Standard ECMA-262 3rd. Edition * */ diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSRegExp.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSRegExp.java index 0e551226..be32cfed 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSRegExp.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSRegExp.java @@ -4,7 +4,8 @@ /** - * Object RegExp + * Object RegExp. + * * @since Standard ECMA-262 3rd. Edition */ public abstract class JSRegExp implements JSRegExpFunctions { diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSString.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSString.java index deab1800..bc18f54c 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSString.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSString.java @@ -4,7 +4,8 @@ /** - * Object String + * Object String. + * * @since Standard ECMA-262 3rd. Edition */ public abstract class JSString implements JSStringFunctions { @@ -62,6 +63,7 @@ public JSString(JSString s){} * 
          * var s = String.fromCharCode(104,101,108,108,111); //returns the string hello
 	 *
    + * * @memberOf String * @param charCode Zero or more integers that specify Unicode encodings of the characters in the string to be created. * @returns A new string containing characters with the specified encoding. diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSUndefined.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSUndefined.java index c340da73..dee36a26 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSUndefined.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/JSUndefined.java @@ -2,7 +2,8 @@ /** - * Object Undefined + * Object Undefined. + * * @since Standard ECMA-262 3rd. Edition */ public abstract class JSUndefined { diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSArrayFunctions.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSArrayFunctions.java index 253d2c63..e1be1352 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSArrayFunctions.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSArrayFunctions.java @@ -59,6 +59,7 @@ public interface JSArrayFunctions extends JSObjectFunctions { * stack.pop(); // returns 2, stack [1] * stack.pop(); // returns 1, stack [] * + * * @returns The last element of the array. * @memberOf Array * @see org.fife.rsta.ac.js.ecma.api.ecma3.JSArray Array @@ -77,6 +78,7 @@ public interface JSArrayFunctions extends JSObjectFunctions { * var vals = []; * vals.push(1,2,3); // returns new array [1,2,3] * + * * @param array One or more values to be appended to the end of the array. * @memberOf Array * @see org.fife.rsta.ac.js.ecma.api.ecma3.JSArray Array @@ -95,6 +97,7 @@ public interface JSArrayFunctions extends JSObjectFunctions { * var r = [1,2,3]; * r.reverse(); // r is now [3,2,1] * + * * @returns The array after it has been reversed. * @memberOf Array * @see org.fife.rsta.ac.js.ecma.api.ecma3.JSArray Array @@ -113,6 +116,7 @@ public interface JSArrayFunctions extends JSObjectFunctions { * s.shift(); // Returns 1; s = [2,3] * s.shift(); // Returns 2; s = [3] * + * * @returns The former first element of the array * @memberOf Array * @see org.fife.rsta.ac.js.ecma.api.ecma3.JSArray Array @@ -134,6 +138,7 @@ public interface JSArrayFunctions extends JSObjectFunctions { * s.slice(3); // Returns [4,5] * s.slice(1,-1); // Returns [2,3,4] * + * * @param start The array index from where to begin. If negative, this argument specifies a position measured from the end of the array. * @param end The array index immediately after the end of the slice. If not specified then the slice includes all the array elements from the start to the end of the array. * @returns A new array containing elements from the {@code start} up to, but not including the end of the slice. @@ -156,6 +161,7 @@ public interface JSArrayFunctions extends JSObjectFunctions { * s.sort(); //Alphabetical order : 1111,22,33,4,55 * s.sort(numbersort); //Numerical order : 4, 22, 33, 55, 1111 * + * * @param function an optional function used to specify the sorting order * @returns A reference to the array * @memberOf Array @@ -176,6 +182,7 @@ public interface JSArrayFunctions extends JSObjectFunctions { * s.splice(1,1); //Returns [4]; s is [1] * s.splice(1,0,2,3); //Returns []; s is [1 2 3] * + * * @param start the array element at which the insertion and/or deletion is to begin * @param deletecount The number of elements starting with and including start. * @param items zero or more items to be inserted into the array @@ -199,6 +206,7 @@ public interface JSArrayFunctions extends JSObjectFunctions { * s.unshift(22); //Returns 3; s is [22,1,2] * s.shift(); //Returns 22; s is [1,2] * + * * @param value One or more values to insert at the beginning of the array * @returns The new length of the array * @memberOf Array diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSFunctionFunctions.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSFunctionFunctions.java index 5d4c9ac7..4145b4cf 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSFunctionFunctions.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSFunctionFunctions.java @@ -15,6 +15,7 @@ public interface JSFunctionFunctions extends JSObjectFunctions { * //overrides it with its own version of the method * Object.prototype.toString().apply(o); * + * * @param thisObject The object to which the function is applied. * @param argArray An array of arguments to be passed to function * @return Whatever value is returned by function @@ -33,6 +34,7 @@ public interface JSFunctionFunctions extends JSObjectFunctions { * //overrides it with its own version of the method * Object.prototype.toString().call(o); * + * * @param thisObject The object to which the function is applied. * @param args An array of arguments to be passed to function * @return Whatever value is returned by function diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSGlobalFunctions.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSGlobalFunctions.java index 047801e2..ab20c174 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSGlobalFunctions.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSGlobalFunctions.java @@ -11,6 +11,7 @@ public interface JSGlobalFunctions extends JSObjectFunctions { /** * function decodeURI(uri) unescape characters in a URI. + * * @param uri A string that contains an encoded URI or other text to be decoded. * @returns A copy of uri, with any hexidecimal escaped sequences replaced with characters they represent. * @memberOf Global @@ -27,6 +28,7 @@ public interface JSGlobalFunctions extends JSObjectFunctions { /** * function decodeURIComponent(s) unescape characters in a URI component. + * * @param s A string that contains an encoded URI components or other text to be decoded. * @returns A copy of s, with any hexidecimal escaped sequences replaced with characters they represent. * @memberOf Global @@ -44,6 +46,7 @@ public interface JSGlobalFunctions extends JSObjectFunctions { /** * function encodeURI(uri) escape characters in a URI. + * * @param uri A string that contains the URI or other text to be encoded. * @returns A copy of uri, with certain characters replaced by hexidecimal escape sequences. * @memberOf Global @@ -60,6 +63,7 @@ public interface JSGlobalFunctions extends JSObjectFunctions { /** * function encodeURIComponent(s) escape characters in a URI Component. + * * @param s A string that contains a portion of a URI or other text to be encoded. * @returns A copy of s, with certain characters replaced by hexidecimal escape sequences. * @memberOf Global @@ -76,6 +80,7 @@ public interface JSGlobalFunctions extends JSObjectFunctions { /** * function escape(s) encode a string. + * * @param s A string to be "escaped" or encoded. * @returns An encoded copy of s, with certain characters replaced by hexidecimal escape sequences. * @memberOf Global @@ -94,6 +99,7 @@ public interface JSGlobalFunctions extends JSObjectFunctions { * 
     	 * eval("2+5"); //Returns 7
 	 *
    + * * @param code A string that contains the JavaScript expression to be evaluated or the statements to be executed. * @returns The value of the evaluated code, if any. * @memberOf Global @@ -105,6 +111,7 @@ public interface JSGlobalFunctions extends JSObjectFunctions { /** * function isFinite(n) determine whether a number is finite. + * * @param n The number to be tested. * @returns true if n is or can be converted to a finite number or otherwise false if n is NaN or positive or negative Infinity. * @memberOf Global @@ -130,6 +137,7 @@ public interface JSGlobalFunctions extends JSObjectFunctions { * isNaN(true); //=> false * isNaN(undefined); //=> true * + * * @param n The number to be tested. * @returns true if n is not a number or if it is the special numeric value NaN, otherwise false if n is any other number. * @memberOf Global @@ -145,6 +153,7 @@ public interface JSGlobalFunctions extends JSObjectFunctions { /** * function parseFloat(s) convert a string to a number. + * * @param s The string to be parsed and converted to a number * @returns The parsed number or NaN if s does not begin with a valid number. * @memberOf Global @@ -158,6 +167,7 @@ public interface JSGlobalFunctions extends JSObjectFunctions { /** * function parseInt(s, radix) convert a string to an integer. + * * @param s The string to be parsed and converted to an integer * @param radix An optional integer argument that represents the radix (i.e. base) of the number to be parsed. If omitted or 0, the number is parsed in base 10. * @returns The parsed number or NaN if s does not begin with a valid number. @@ -172,6 +182,7 @@ public interface JSGlobalFunctions extends JSObjectFunctions { /** * function unescape(s) decode an escaped string. + * * @param s A string to be "unescaped" or decoded. * @returns A decoded copy of s. * @memberOf Global diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSNumberFunctions.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSNumberFunctions.java index f44e3fa6..42f6c889 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSNumberFunctions.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSNumberFunctions.java @@ -17,6 +17,7 @@ public interface JSNumberFunctions extends JSObjectFunctions { * n.toFixed(6); //returns 12345.678900: note zeros * (1.23e+20).toFixed(2); //returns 123000000000000000000.00 * + * * @memberOf Number * @param fractionDigits The number of digits to appear after the decimal point. If omitted it is treated as 0. * @returns A string representation of number that does not use exponential notation and has exactly the digits applied. @@ -37,6 +38,7 @@ public interface JSNumberFunctions extends JSObjectFunctions { * n.toExponential(10); //returns 1.2345678900e+4 * n.toExponential(); //returns 1.23456789e+4 * + * * @memberOf Number * @param fractionDigits The number of digits that appear after the decimal point. * @returns a string representation of number in exponential notation. @@ -57,6 +59,7 @@ public interface JSNumberFunctions extends JSObjectFunctions { * n.toPrecision(5); //returns 12346 * n.toPrecision(10); //returns 12345.67890 * + * * @memberOf Number * @param fractionDigits The number of significant digits to appear in the returned string. * @returns a string representation of number that contains the number significant digits. diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSObjectFunctions.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSObjectFunctions.java index 4e658a6c..055093e4 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSObjectFunctions.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSObjectFunctions.java @@ -10,6 +10,7 @@ public interface JSObjectFunctions { /** * function toString() define an objects string representation. + * * @memberOf Object * @returns a string representing the object * @see org.fife.rsta.ac.js.ecma.api.ecma3.JSObject Object @@ -23,6 +24,7 @@ public interface JSObjectFunctions { /** * function toLocaleString() return an object localized string representation. + * * @memberOf Object * @returns A string representing the object * @see org.fife.rsta.ac.js.ecma.api.ecma3.JSObject Object @@ -34,6 +36,7 @@ public interface JSObjectFunctions { /** * function valueOf() the primitive value of a specified object. + * * @memberOf Object * @returns The primitive value associated with the object, if any. * @see org.fife.rsta.ac.js.ecma.api.ecma3.JSObject Object. @@ -54,6 +57,7 @@ public interface JSObjectFunctions { * o.hasOwnProperty("y"); //return false; o does not have property y. * o.hasOwnProperty("toString"); //return false; o inherits toString. * + * * @memberOf Object * @param name A string that contains the name of a property of object. * @returns true if object has a noninherited property with the name specified by name. @@ -76,6 +80,7 @@ public interface JSObjectFunctions { * Function.prototype.isPrototypeOf(o.toString(); //return true: toString is a function. * Array.prototype.isPrototypeOf([1,2,3]; //return true: [1,2,3] is an Array. * + * * @memberOf Object * @param o Any object * @returns true if object is prototype of o. false is not an object or if object @@ -97,6 +102,7 @@ public interface JSObjectFunctions { * o.propertyIsEnumerable("y"); //return false; o does not have property y. * o.propertyIsEnumerable("toString"); //return false; o inherits toString. * + * * @memberOf Object * @param name A string that contains the name of a property of object. * @returns true if object has a noninherited property with the name specified by name and diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSRegExpFunctions.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSRegExpFunctions.java index 46402400..05a422b3 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSRegExpFunctions.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSRegExpFunctions.java @@ -18,6 +18,7 @@ public interface JSRegExpFunctions extends JSObjectFunctions { * alert("Matched: " + result[0]); * } * + * * @param string The string to be searched * @returns An array containing results on the match or null if no match is found. * @type Array @@ -39,6 +40,7 @@ public interface JSRegExpFunctions extends JSObjectFunctions { * r.test("JavaScript"); //returns true * r.test("ECMAScript"); //returns false * + * * @param string The string to be tested * @returns true if string contains text that matches regexp, otherwise false. * @type Boolean diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSStringFunctions.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSStringFunctions.java index 9fc0d093..3bac3f53 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSStringFunctions.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma3/functions/JSStringFunctions.java @@ -84,6 +84,7 @@ public interface JSStringFunctions extends JSObjectFunctions { * var string;//array of string initialised somewhere * strings.sort(function(a,b){return a.localCompare(b);}); * + * * @memberOf String * @param otherString A string to be compared, in a locale-sensitive fashion, with string. * @returns A number that indicates the result of the comparison. @@ -142,6 +143,7 @@ public interface JSStringFunctions extends JSObjectFunctions { * s.slice(3, -1); //returns "def" * s.slice(3,-2); //returns "de" * + * * @memberOf String * @param start The start index where the slice if to begin. * @param end Optional end index where the slice is to end. @@ -160,6 +162,7 @@ public interface JSStringFunctions extends JSObjectFunctions { * "1|2|3|4".split("|"); //returns ["1","2","3","4"] * "%1%2%3%4%".split("%"); //returns ["","1","2","3","4",""] * + * * @memberOf String * @param separator The string or regular expression at which the string splits * @param limit Optional value that specifies the maximum length of the returned array. diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5Array.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5Array.java index e9a51cce..4349108d 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5Array.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5Array.java @@ -8,7 +8,8 @@ /** - * Object Array + * Object Array. + * * @since Standard ECMA-262 3rd. Edition */ public abstract class JS5Array extends JSArray implements JS5ArrayFunctions { @@ -44,6 +45,7 @@ public JS5Array(JSNumber size) { * @constructor * @extends Object * @param element0 An argument list of two or more values. The length field set to the number of arguments. + * @param elementn The nth argument. * @since Standard ECMA-262 3rd. Edition * @since Level 2 Document Object Model Core Definition. */ diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5Date.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5Date.java index 30ac2249..eefb9887 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5Date.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5Date.java @@ -6,7 +6,8 @@ import org.fife.rsta.ac.js.ecma.api.ecma5.functions.JS5DateFunctions; /** - * Object Boolean + * Object Date. + * * @since Standard ECMA-262 3rd. Edition */ public abstract class JS5Date extends JSDate implements JS5DateFunctions { diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5Function.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5Function.java index 20878601..9b8dac16 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5Function.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5Function.java @@ -5,13 +5,15 @@ import org.fife.rsta.ac.js.ecma.api.ecma5.functions.JS5FunctionFunctions; /** - * Object Function + * Object Function. + * * @since Standard ECMA-262 3rd. Edition */ public abstract class JS5Function extends JSFunction implements JS5FunctionFunctions { /** - * Object Function(argument_names..., body) + * Object Function(argument_names..., body). + * * @constructor * @extends Object * @param argumentNames Any number of string arguments, each naming one or more arguments of the Function object to be created. diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5JSON.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5JSON.java index ed6173a8..50fde9c4 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5JSON.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5JSON.java @@ -1,7 +1,8 @@ package org.fife.rsta.ac.js.ecma.api.ecma5; /** - * Object JSON + * Object JSON. + * * @since Standard ECMA-262 5th. Edition */ public abstract class JS5JSON { diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5Object.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5Object.java index f902ed56..ce7e93e9 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5Object.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5Object.java @@ -6,13 +6,14 @@ /** - * Base JavaScript Object + * Base JavaScript Object. + * * @since Standard ECMA-262 3rd. Edition */ public abstract class JS5Object extends JSObject implements JS5ObjectFunctions { /** - * Object Object() + * Object Object(). * *

    Creates a new object instance

    * @@ -24,7 +25,7 @@ public JS5Object() { } /** - * Object Object(value) + * Object Object(value). * * * @constructor @@ -45,6 +46,7 @@ public JS5Object(JSObject value) { * y: { value: 2, writable, false, enumerable:true. configurable:true}, * }); * + * * @param proto The prototype of the newly created object, or null. * @param descriptors An optional object that maps property names to property descriptors. * @returns A newly created object that inherits from {@code proto} and has properties described by descriptors @@ -70,6 +72,7 @@ public static JS5Object create(JS5Object proto, JS5Object descriptors) { * y: { value: 2, writable, false, enumerable:true. configurable:true}, * }); * + * * @param o The object on which properties are to be created or configured. * @param descriptors An object that maps property names to property descriptors. * @returns The object {@code o} @@ -93,6 +96,7 @@ public static JS5Object defineProperties(JS5Object o, JS5Object descriptors) { * Object.defineProperty (o, n, { value: v, writable, false, enumerable:true. configurable:true}); * } * + * * @param o The object on which a property is to be created or configured. * @param name The name of the property created or configured. * @param desc A property descriptor object that describes the new property. @@ -144,6 +148,7 @@ public static JS5Object getOwnPropertyDescriptor(JS5Object o, JS5String name) { * 
     	 * Object.getOwnPropertyNames([]); //returns [length]: "length" is non enumerable
 	 *
    + * * @param o An object * @returns An array that contains the names of all non-inherited properties of {@code o}, including non-enumerable properties. * @see org.fife.rsta.ac.js.ecma.api.ecma5.JS5Object Object @@ -165,6 +170,7 @@ public static JS5Array getOwnPropertyNames(JS5Object o) { * var o = Object.create(p); //an object inherited from p * Object.getPrototypeOf(o); //=> p * + * * @param o An object. * @returns The prototype of object {@code o}. * @see org.fife.rsta.ac.js.ecma.api.ecma5.JS5Object Object @@ -186,6 +192,7 @@ public static JS5Object getPrototypeOf(JS5Object o) { * Object.preventExtensions(o); //Make it non-extensible * Object.isExtensible(o); //=> false * + * * @param o The object to be checked for extensibility * @returns {code true} if the object can be extended with new properties, otherwise {code false}. * @see org.fife.rsta.ac.js.ecma.api.ecma5.JS5Object Object @@ -241,6 +248,7 @@ public static JSBoolean isSealed(JS5Object o) { * 
     	 * Object.keys({x:1, y:2}); // => ["x", "y"]
 	 *
    + * * @param o an object * @returns An array that contains the names of all enumerable own (non-inherited) properties of {@code o}. * @see org.fife.rsta.ac.js.ecma.api.ecma5.JS5Object Object diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5String.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5String.java index c4f127ad..f2eabdea 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5String.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/JS5String.java @@ -5,14 +5,15 @@ /** - * Object String + * Object String. + * * @since Standard ECMA-262 3rd. Edition */ public abstract class JS5String extends JSString implements JS5StringFunctions { /** - * Object String(s) + * Object String(s). * * @constructor * @extends Object diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/functions/JS5ArrayFunctions.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/functions/JS5ArrayFunctions.java index 54932fdf..59ec45d8 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/functions/JS5ArrayFunctions.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/ecma/api/ecma5/functions/JS5ArrayFunctions.java @@ -19,6 +19,7 @@ public interface JS5ArrayFunctions extends JS5ObjectFunctions, JSArrayFunctions * [1,2,3].every(function(x){return x < 2;} //=>false * [].every(function(x){return false;} //=>true, always true for [] * + * * @param predicate A predicate function to test array elements * @param o The optional this value for invocations of predicate. * @returns true if predicate is true for every element of the array or false @@ -39,6 +40,7 @@ public interface JS5ArrayFunctions extends JS5ObjectFunctions, JSArrayFunctions * 
     	 * [1,2,3].filter(function(x){return x > 1}); // returns [2,3]
 	 *
    + * * @param predicate The function to invoke to determine whether an element of array will be included in the returned array. * @param o An optional value on which predicate is invoked * @returns a new array containing only those elements of array for which predicate returned true @@ -62,6 +64,7 @@ public interface JS5ArrayFunctions extends JS5ObjectFunctions, JSArrayFunctions * var a = [1,2,3]; * a.forEach(function(x,i,a){a[i]++;}); //a is now [2,3,4] * + * * @param f The function to invoke for each element of array * @param o An optional value on which {@code f} is invoked * @memberOf Array @@ -80,6 +83,7 @@ public interface JS5ArrayFunctions extends JS5ObjectFunctions, JSArrayFunctions * ['a','b','c'].indexOf('d'); //returns -1 * ['a','b','c'].indexOf('a',1); //returns -1 * + * * @param value The value to search array for. * @param start An optional array index at which to begin the search. If omitted, 0 is used. * @returns The lowest index => start of array at which the element matches value. Or -1 if no match is found @@ -112,6 +116,7 @@ public interface JS5ArrayFunctions extends JS5ObjectFunctions, JSArrayFunctions * 
     	 * [1,2,3].map(function(x){return x*x;}); //returns [1,4,9]
 	 *
    + * * @param f The function to invoke for each element of array. Its return becomes the elements of the returned array * @param o An optional value of which f is invoked * @returns A new array with elements computed by function f @@ -132,6 +137,7 @@ public interface JS5ArrayFunctions extends JS5ObjectFunctions, JSArrayFunctions * 
     	 * [1,2,3].reduce(function(x,y){return x*y;}); //returns 6 ((1*2(*3))
 	 *
    + * * @param f A function that combines two values and returns a "reduced" value * @param initial An optional initial value to see the array reduction with. * @returns The reduced value of an array. @@ -152,6 +158,7 @@ public interface JS5ArrayFunctions extends JS5ObjectFunctions, JSArrayFunctions * 
     	 * [2,10,60].reduceRight(function(x,y){return x/y;}); //returns 3 (60/10)/2
 	 *
    + * * @param f A function that combines two values and returns a "reduced" value * @param initial An optional initial value to see the array reduction with. * @returns The reduced value of an array. @@ -172,6 +179,7 @@ public interface JS5ArrayFunctions extends JS5ObjectFunctions, JSArrayFunctions * [1,2,3].some(function(x){return x > 2;} //=>true * [].some(function(x){return true;} //=>false, always false for [] * + * * @param predicate A predicate function to test array elements. * @param o The optional this value for the invocations of predicate. * @returns true if predicate returns true for at least one element of array, otherwise false diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/resolver/JSR223JavaScriptCompletionResolver.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/resolver/JSR223JavaScriptCompletionResolver.java index bd67aaf3..eb593e8e 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/resolver/JSR223JavaScriptCompletionResolver.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/resolver/JSR223JavaScriptCompletionResolver.java @@ -21,6 +21,7 @@ public class JSR223JavaScriptCompletionResolver extends * RhinoCompletionProvider constructor * - resolves Rhino specific types * Used to resolve Static class e.g. java.lag.String methods and fields + * * @param provider */ public JSR223JavaScriptCompletionResolver(SourceCompletionProvider provider) { @@ -100,6 +101,7 @@ public String getFunctionNameLookup(FunctionCall call, SourceCompletionProvider /** * Try to resolve the Token.NAME AstNode and return a TypeDeclaration. + * * @param node node to resolve * @return TypeDeclaration if the name can be resolved as a Java Class else null */ diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/resolver/JavaScriptCompletionResolver.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/resolver/JavaScriptCompletionResolver.java index 4a4d92d1..5d7764c3 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/resolver/JavaScriptCompletionResolver.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/resolver/JavaScriptCompletionResolver.java @@ -82,6 +82,7 @@ public JavaScriptType compileText(String text) { /** * Resolve node type to TypeDeclaration. Called instead of #compileText(String text) when document is already parsed + * * @param text The node to resolve * @return TypeDeclaration for node or null if not found. */ @@ -140,6 +141,7 @@ protected TypeDeclaration resolveNativeType(AstNode node) { /** * Test whether the node can be resolved as a static Java class. * Only looks for Token.NAME nodes to test + * * @param node node to test * @return The type declaration. */ @@ -153,6 +155,7 @@ protected TypeDeclaration testJavaStaticType(AstNode node) { /** * Try to resolve the Token.NAME AstNode and return a TypeDeclaration. + * * @param node node to resolve * @return TypeDeclaration if the name can be resolved as a Java Class else null */ @@ -498,6 +501,7 @@ private JavaScriptType lookupJavaScriptType( /** * Creates a new JavaScriptType based on the String type. + * * @param provider SourceCompletionProvider * @param type type of JavaScript type to create e.g. java.sql.Connection * @param text Text entered from the user to resolve the node. This will be null if resolveNode(AstNode node) is called @@ -523,6 +527,7 @@ private JavaScriptType createNewTypeDeclaration( * Method called if the lastJavaScriptType is not null. i.e. has gone through one iteration at least. * Resolves TypeDeclaration for parts of a variable past the first part. e.g. "".toString() //resolve toString() * In some circumstances this is useful to resolve this. e.g. for Custom Object completions + * * @param node Node to resolve * @return Type Declaration * diff --git a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/resolver/JavaScriptResolver.java b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/resolver/JavaScriptResolver.java index 70c8cb54..4499b1e2 100644 --- a/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/resolver/JavaScriptResolver.java +++ b/RSTALanguageSupport/src/main/java/org/fife/rsta/ac/js/resolver/JavaScriptResolver.java @@ -25,6 +25,7 @@ public JavaScriptResolver(SourceCompletionProvider provider) { /** * Resolve node type to TypeDeclaration. Called instead of #compileText(String text) when document is already parsed + * * @param node AstNode to resolve * @return TypeDeclaration for node or null if not found. */ @@ -32,6 +33,7 @@ public JavaScriptResolver(SourceCompletionProvider provider) { /** * Resolve node type to TypeDeclaration. Called instead of #compileText(String text) when document is already parsed + * * @param text The type of node to resolve * @return TypeDeclaration for node or null if not found. */ diff --git a/config/checkstyle/lsSuppressions.xml b/config/checkstyle/lsSuppressions.xml index 1cc398ec..0a45985e 100644 --- a/config/checkstyle/lsSuppressions.xml +++ b/config/checkstyle/lsSuppressions.xml @@ -11,7 +11,7 @@ For now we're ignoring several issues that will take some time to address. TODO: Remove these issues one by one. --> - +