improved jdoc

Author: rbri

src/main/java/org/htmlunit/javascript/host/event/BeforeUnloadEvent.java

@@ -78,13 +78,17 @@ private static Object getReturnValueDefault(final BrowserVersion browserVersion)
     }
 
     /**
+     * Returns {@code true} if returnValue holds the beforeunload message.
+     *
      * @return {@code true} if returnValue holds the beforeunload message
      */
     public boolean isBeforeUnloadMessageSet() {
         return !getReturnValueDefault(getBrowserVersion()).equals(getReturnValue());
     }
 
     /**
+     * Returns the return value associated with the event.
+     *
      * @return the return value associated with the event
      */
     @JsxGetter

src/main/java/org/htmlunit/javascript/host/event/BlobEvent.java

@@ -65,6 +65,8 @@ public void jsConstructor(final String type, final ScriptableObject details) {
     }
 
     /**
+     * Returns the Blob associated with the event.
+     *
      * @return the Blob associated with the event
      */
     @JsxGetter

src/main/java/org/htmlunit/javascript/host/event/CloseEvent.java

@@ -75,6 +75,8 @@ public void jsConstructor(final String type, final ScriptableObject details) {
     }
 
     /**
+     * Returns the code.
+     *
      * @return the code
      */
     @JsxGetter

src/main/java/org/htmlunit/javascript/host/file/Blob.java

@@ -62,34 +62,47 @@ public class Blob extends HtmlUnitScriptable {
      * The backend used for saving the blob.
      */
     protected abstract static class Backend implements Serializable {
+
         /**
+         * Returns the name.
+         *
          * @return the name
          */
         abstract String getName();
 
         /**
+         * Returns the last modified timestamp as long.
+         *
          * @return the last modified timestamp as long
          */
         abstract long getLastModified();
 
         /**
+         * Returns the size.
+         *
          * @return the size
          */
         abstract long getSize();
 
         /**
+         * Returns the type.
+         *
          * @param browserVersion the {@link BrowserVersion}
          * @return the type
          */
         abstract String getType(BrowserVersion browserVersion);
 
         /**
+         * Returns the text.
+         *
          * @return the text
          * @throws IOException in case of error
          */
         abstract String getText() throws IOException;
 
         /**
+         * Returns the bytes.
+         *
          * @param start the start position
          * @param end the end position
          * @return the bytes
@@ -317,6 +330,7 @@ public Blob(final byte[] bytes, final String contentType) {
 
     /**
      * Returns the {@code size} property.
+     *
      * @return the {@code size} property
      */
     @JsxGetter
@@ -326,6 +340,7 @@ public long getSize() {
 
     /**
      * Returns the {@code type} property.
+     *
      * @return the {@code type} property
      */
     @JsxGetter
@@ -334,6 +349,9 @@ public String getType() {
     }
 
     /**
+     * Returns a Promise that resolves with an ArrayBuffer containing the
+     *         data in binary form.
+     *
      * @return a Promise that resolves with an ArrayBuffer containing the
      *         data in binary form.
      */
@@ -350,6 +368,8 @@ public NativePromise arrayBuffer() {
     }
 
     /**
+     * Returns a new Blob object which contains data from a subset of the blob on which it's called.
+     *
      * @param start An index into the Blob indicating the first byte to include in the new Blob. If you specify
      *        a negative value, it's treated as an offset from the end of the Blob toward the beginning.
      *        For example, -10 would be the 10th from last byte in the Blob. The default value is 0.
@@ -402,6 +422,8 @@ public Blob slice(final Object start, final Object end, final Object contentType
     }
 
     /**
+     * Returns a ReadableStream which, upon reading, returns the contents of the Blob.
+     *
      * @return a ReadableStream which, upon reading, returns the contents of the Blob.
      */
     @JsxFunction
@@ -410,6 +432,9 @@ public ReadableStream stream() {
     }
 
     /**
+     * Returns a Promise that resolves with a string containing the
+     *         contents of the blob, interpreted as UTF-8.
+     *
      * @return a Promise that resolves with a string containing the
      *         contents of the blob, interpreted as UTF-8.
      */
@@ -419,6 +444,8 @@ public NativePromise text() {
     }
 
     /**
+     * Returns the bytes of this blob.
+     *
      * @return the bytes of this blob
      */
     public byte[] getBytes() {

src/main/java/org/htmlunit/javascript/host/intl/Collator.java

@@ -31,6 +31,8 @@
  *
  * @author Ahmed Ashour
  * @author Ronald Brill
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator">MDN Documentation</a>
  */
 @JsxClass
 public class Collator extends HtmlUnitScriptable {
@@ -43,10 +45,10 @@ public class Collator extends HtmlUnitScriptable {
      * JavaScript constructor.
      * @param cx the current context
      * @param scope the scope
-     * @param args the arguments to the WebSocket constructor
+     * @param args the arguments to the Collator constructor
      * @param ctorObj the function object
-     * @param inNewExpr Is new or not
-     * @return the java object to allow JavaScript to access
+     * @param inNewExpr {@code true} if invoked with the {@code new} operator
+     * @return the Java object that JavaScript can access
      */
     @JsxConstructor
     public static Scriptable jsConstructor(final Context cx, final VarScope scope,

src/main/java/org/htmlunit/javascript/host/intl/DateTimeFormat.java

@@ -49,6 +49,8 @@
  * @author Ahmed Ashour
  * @author Ronald Brill
  * @author Lai Quang Duong
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat">MDN Documentation</a>
  */
 @JsxClass
 public class DateTimeFormat extends HtmlUnitScriptable {
@@ -252,10 +254,10 @@ private static Chronology getChronology(final Map<String, Chronology> chronologi
      * JavaScript constructor.
      * @param cx the current context
      * @param scope the scope
-     * @param args the arguments to the WebSocket constructor
+     * @param args the arguments to the DateTimeFormat constructor
      * @param ctorObj the function object
-     * @param inNewExpr Is new or not
-     * @return the java object to allow JavaScript to access
+     * @param inNewExpr {@code true} if invoked with the {@code new} operator
+     * @return the Java object that JavaScript can access
      */
     @JsxConstructor
     public static Scriptable jsConstructor(final Context cx, final VarScope scope,
@@ -286,7 +288,7 @@ public static Scriptable jsConstructor(final Context cx, final VarScope scope,
     /**
      * Formats a date according to the locale and formatting options of this {@code DateTimeFormat} object.
      * @param object the JavaScript object to convert
-     * @return the dated formated
+     * @return the formatted date
      */
     @JsxFunction
     public String format(final Object object) {
@@ -295,7 +297,8 @@ public String format(final Object object) {
     }
 
     /**
-     * @return A new object with properties reflecting the locale and date and time formatting options
+     * Returns the resolved options for this Intl.DateTimeFormat object.
+     * @return a new object with properties reflecting the locale and date and time formatting options
      *         computed during the initialization of the given {@code DateTimeFormat} object.
      */
     @JsxFunction
@@ -363,7 +366,7 @@ static final class DateTimeFormatHelper {
          * Formats a date according to the locale and formatting options of this {@code DateTimeFormat} object.
          * @param date the JavaScript object to convert
          * @param zoneId the current time zone id
-         * @return the dated formated
+         * @return the formatted date
          */
         String format(final Date date, final ZoneId zoneId) {
             TemporalAccessor zonedDateTime = date.toInstant().atZone(zoneId);

src/main/java/org/htmlunit/javascript/host/intl/Intl.java

@@ -48,6 +48,8 @@
  * @author Ahmed Ashour
  * @author Lai Quang Duong
  * @author Ronald Brill
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl">MDN Documentation</a>
  */
 @JsxClass
 public class Intl extends HtmlUnitScriptable {

src/main/java/org/htmlunit/javascript/host/intl/Locale.java

@@ -37,6 +37,8 @@
  *
  * @author Lai Quang Duong
  * @author Ronald Brill
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale">MDN Documentation</a>
  */
 @JsxClass
 public class Locale extends HtmlUnitScriptable {
@@ -198,6 +200,7 @@ private static void setUnicodeKeyword(final java.util.Locale.Builder builder,
     }
 
     /**
+     * Returns the language subtag.
      * @return the language
      */
     @JsxGetter
@@ -206,6 +209,7 @@ public Object getLanguage() {
     }
 
     /**
+     * Returns the script subtag.
      * @return the script
      */
     @JsxGetter
@@ -214,6 +218,7 @@ public Object getScript() {
     }
 
     /**
+     * Returns the region subtag.
      * @return the region
      */
     @JsxGetter
@@ -222,6 +227,7 @@ public Object getRegion() {
     }
 
     /**
+     * Returns the calendar type.
      * @return the calendar type
      */
     @JsxGetter
@@ -230,6 +236,7 @@ public Object getCalendar() {
     }
 
     /**
+     * Returns the collation type.
      * @return the collation type
      */
     @JsxGetter
@@ -238,6 +245,7 @@ public Object getCollation() {
     }
 
     /**
+     * Returns the numbering system.
      * @return the numbering system
      */
     @JsxGetter
@@ -246,6 +254,7 @@ public Object getNumberingSystem() {
     }
 
     /**
+     * Returns the case first setting.
      * @return the case first setting
      */
     @JsxGetter
@@ -254,6 +263,7 @@ public Object getCaseFirst() {
     }
 
     /**
+     * Returns the hour cycle.
      * @return the hour cycle
      */
     @JsxGetter
@@ -262,6 +272,7 @@ public Object getHourCycle() {
     }
 
     /**
+     * Returns whether numeric sorting is used.
      * @return whether numeric sorting is used
      */
     @JsxGetter
@@ -270,6 +281,7 @@ public boolean isNumeric() {
     }
 
     /**
+     * Returns the base name (without Unicode extensions).
      * @return the base name (without Unicode extensions)
      */
     @JsxGetter
@@ -333,6 +345,7 @@ public Locale minimize() {
     }
 
     /**
+     * Returns the locale's Unicode locale identifier string.
      * @return the locale's Unicode locale identifier string
      */
     @JsxFunction(functionName = "toString")

src/main/java/org/htmlunit/javascript/host/intl/NumberFormat.java

@@ -44,6 +44,8 @@
  * @author Ahmed Ashour
  * @author Ronald Brill
  * @author Lai Quang Duong
+ *
+ * @see <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat">MDN Documentation</a>
  */
 @JsxClass
 public class NumberFormat extends HtmlUnitScriptable {
@@ -171,10 +173,10 @@ private static String getPattern(final Map<String, String> formats, final String
      * JavaScript constructor.
      * @param cx the current context
      * @param scope the scope
-     * @param args the arguments to the WebSocket constructor
+     * @param args the arguments to the NumberFormat constructor
      * @param ctorObj the function object
-     * @param inNewExpr Is new or not
-     * @return the java object to allow JavaScript to access
+     * @param inNewExpr {@code true} if invoked with the {@code new} operator
+     * @return the Java object that JavaScript can access
      */
     @JsxConstructor
     public static Scriptable jsConstructor(final Context cx, final VarScope scope,
@@ -204,7 +206,7 @@ public static Scriptable jsConstructor(final Context cx, final VarScope scope,
     /**
      * Formats a number according to the locale and formatting options of this Intl.NumberFormat object.
      * @param object the JavaScript object to convert
-     * @return the dated formated
+     * @return the formatted number
      */
     @JsxFunction
     public String format(final Object object) {
@@ -213,8 +215,9 @@ public String format(final Object object) {
     }
 
     /**
-     * @return A new object with properties reflecting the locale and date and time formatting options
-     *         computed during the initialization of the given {@code DateTimeFormat} object.
+     * Returns the resolved options for this Intl.NumberFormat object.
+     * @return a new object with properties reflecting the locale and number formatting options
+     *         computed during the initialization of the given {@code NumberFormat} object.
      */
     @JsxFunction
     public Scriptable resolvedOptions() {

src/main/java/org/htmlunit/javascript/host/intl/V8BreakIterator.java

@@ -51,10 +51,10 @@ public class V8BreakIterator extends HtmlUnitScriptable {
      * JavaScript constructor.
      * @param cx the current context
      * @param scope the scope
-     * @param args the arguments to the WebSocket constructor
+     * @param args the arguments to the V8BreakIterator constructor
      * @param ctorObj the function object
-     * @param inNewExpr Is new or not
-     * @return the java object to allow JavaScript to access
+     * @param inNewExpr {@code true} if invoked with the {@code new} operator
+     * @return the Java object that JavaScript can access
      */
     @JsxConstructor
     public static Scriptable jsConstructor(final Context cx, final VarScope scope,