jdoc checkstyle

Author: rbri

src/main/java/org/htmlunit/WebRequest.java

@@ -56,6 +56,9 @@
  */
 public class WebRequest implements Serializable {
 
+    /**
+     * Enum to configure request creation.
+     */
     public enum HttpHint {
         /** Force to include the charset. */
         IncludeCharsetInContentTypeHeader,
@@ -655,13 +658,21 @@ public void setDefaultResponseContentCharset(final Charset defaultResponseConten
         this.defaultResponseContentCharset_ = Objects.requireNonNull(defaultResponseContentCharset);
     }
 
+    /**
+     * @param hint the hint to check for
+     * @return true if the hint is enabled
+     */
     public boolean hasHint(final HttpHint hint) {
         if (httpHints_ == null) {
             return false;
         }
         return httpHints_.contains(hint);
     }
 
+    /**
+     * Enables the hint.
+     * @param hint the hint to add
+     */
     public void addHint(final HttpHint hint) {
         if (httpHints_ == null) {
             httpHints_ = EnumSet.noneOf(HttpHint.class);

src/main/java/org/htmlunit/httpclient/HttpClientConverter.java

@@ -267,6 +267,13 @@ public static URL replaceForCookieIfNecessary(URL url) {
         return url;
     }
 
+    /**
+     * @param cookieString the string to parse
+     * @param pageUrl the page url as root
+     * @param browserVersion the {@link BrowserVersion}
+     * @return a list of {@link org.htmlunit.util.Cookie}'s
+     * @throws MalformedCookieException in case the cookie does not conform to the spec
+     */
     public static List<org.htmlunit.util.Cookie> parseCookie(final String cookieString, final URL pageUrl,
             final BrowserVersion browserVersion)
             throws MalformedCookieException {
@@ -311,6 +318,13 @@ public static List<org.htmlunit.util.Cookie> fromHttpClient(final List<Cookie> c
         return list;
     }
 
+    /**
+     * Adds all matching cookies to the provided set.
+     * @param cookies the cookies to select from
+     * @param normalizedUrl the url to match against
+     * @param browserVersion the {@link BrowserVersion}
+     * @param matches the set to add
+     */
     public static void addMatching(final Set<org.htmlunit.util.Cookie> cookies,
             final URL normalizedUrl, final BrowserVersion browserVersion,
             final Set<org.htmlunit.util.Cookie> matches) {

src/main/java/org/htmlunit/javascript/host/Element.java

@@ -1574,6 +1574,16 @@ public static boolean webkitMatchesSelector(final Context context, final Scripta
         return matches(context, scope, thisObj, args, function);
     }
 
+    /**
+     * Traverses the element and its parents (heading toward the document root) until it finds a node
+     * that matches the specified CSS selector.
+     * @param context the context
+     * @param scope the scope
+     * @param thisObj this object
+     * @param args the arguments
+     * @param function the function
+     * @return the found element or null
+     */
     @JsxFunction
     public static Element closest(final Context context, final Scriptable scope,
             final Scriptable thisObj, final Object[] args, final Function function) {

src/main/java/org/htmlunit/javascript/host/css/StyleSheet.java

@@ -59,6 +59,10 @@ public void jsConstructor() {
         // nothing to do
     }
 
+    /**
+     * Ctor.
+     * @param ownerNode the owner node
+     */
     public StyleSheet(final HTMLElement ownerNode) {
         super();
         ownerNode_ = ownerNode;

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

@@ -442,6 +442,12 @@ public void fillRequest(final WebRequest webRequest) {
         }
     }
 
+    /**
+     * Delegates the KeyDataPair construction to the backend.
+     * @param name the name
+     * @param fileName the filename
+     * @return the constructed {@link KeyDataPair}
+     */
     public KeyDataPair getKeyDataPair(final String name, final String fileName) {
         String contentType = getType();
         if (StringUtils.isEmpty(contentType)) {

src/main/java/org/htmlunit/javascript/host/xml/XMLHttpRequest.java

@@ -1272,11 +1272,19 @@ public void setOnreadystatechange(final Function readyStateChangeHandler) {
         super.setOnreadystatechange(readyStateChangeHandler);
     }
 
+    /**
+     * @return the number of milliseconds a request can take before automatically being terminated.
+     * The default value is 0, which means there is no timeout.
+     */
     @JsxGetter
     public int getTimeout() {
         return timeout_;
     }
 
+    /**
+     * Sets the number of milliseconds a request can take before automatically being terminated.
+     * @param timeout the timeout in milliseconds
+     */
     @JsxSetter
     public void setTimeout(final int timeout) {
         timeout_ = timeout;

src/main/java/org/htmlunit/platform/canvas/rendering/RenderingBackend.java

@@ -26,6 +26,9 @@
  */
 public interface RenderingBackend {
 
+    /**
+     * WindingRule to be used while rendering.
+     */
     enum WindingRule {
         /** WindingRule.NON_ZERO. */
         NON_ZERO,

src/main/java/org/htmlunit/platform/image/ImageData.java

@@ -27,5 +27,10 @@
  */
 public interface ImageData extends AutoCloseable {
 
+    /**
+     * <span style="color:red">INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.</span><br>
+     * @return the {@link IntDimension2D} of this
+     * @throws IOException in case of error
+     */
     IntDimension2D getWidthHeight() throws IOException;
 }

src/main/java/org/htmlunit/platform/image/ImageIOImageData.java

@@ -49,6 +49,11 @@ public class ImageIOImageData implements ImageData {
 
     private final ImageReader imageReader_;
 
+    /**
+     * Ctor.
+     * @param inputStream the {@link InputStream} to read from
+     * @throws IOException in case of error
+     */
     public ImageIOImageData(final InputStream inputStream) throws IOException {
         final ImageInputStream iis = ImageIO.createImageInputStream(inputStream);
         final Iterator<ImageReader> iter = ImageIO.getImageReaders(iis);

src/main/java/org/htmlunit/util/OrderedFastHashMap.java

@@ -544,26 +544,54 @@ public V put(final K key, final V value) {
         return this.put(key, value, Position.LAST);
     }
 
+    /**
+     * Insert at the beginning.
+     * @param key the key
+     * @param value the value
+     * @return the inserted value
+     */
     public V addFirst(final K key, final V value) {
         return this.put(key, value, Position.FIRST);
     }
 
+    /**
+     * Append at the end.
+     * @param key the key
+     * @param value the value
+     * @return the appended value
+     */
     public V add(final K key, final V value) {
         return this.put(key, value, Position.LAST);
     }
 
+    /**
+     * Append at the end.
+     * @param key the key
+     * @param value the value
+     * @return the appended value
+     */
     public V addLast(final K key, final V value) {
         return this.put(key, value, Position.LAST);
     }
 
+    /**
+     * @return the first value.
+     */
     public V getFirst() {
         return getValue(0);
     }
 
+    /**
+     * @return the last value.
+     */
     public V getLast() {
         return getValue(this.orderedListSize_ - 1);
     }
 
+    /**
+     * Removes the first entry.
+     * @return the removed value or null if the map was empty.
+     */
     public V removeFirst() {
         if (this.orderedListSize_ > 0) {
             final int pos = this.orderedList_[0];
@@ -573,6 +601,10 @@ public V removeFirst() {
         return null;
     }
 
+    /**
+     * Removes the last entry.
+     * @return the removed value or null if the map was empty.
+     */
     public V removeLast() {
         if (this.orderedListSize_ > 0) {
             final int pos = this.orderedList_[this.orderedListSize_ - 1];