jdoc checkstyle

Author: rbri

src/main/java/org/htmlunit/WebWindowEvent.java

@@ -169,7 +169,9 @@ public String toString() {
         return builder.toString();
     }
 
-    /** @return the event type */
+    /**
+     * @return the event type
+     */
     public int getEventType() {
         return type_;
     }

src/main/java/org/htmlunit/html/DomElement.java

@@ -859,13 +859,17 @@ protected ChildElementsIterator(final DomNode domNode) {
             }
         }
 
-        /** @return is there a next one ? */
+        /**
+         * @return is there a next one ?
+         */
         @Override
         public boolean hasNext() {
             return nextElement_ != null;
         }
 
-        /** @return the next one */
+        /**
+         * @return the next one
+         */
         @Override
         public DomElement next() {
             if (nextElement_ != null) {

src/main/java/org/htmlunit/html/DomNode.java

@@ -1434,7 +1434,9 @@ public void remove() {
             current.remove();
         }
 
-        /** @return the next node, if there is one */
+        /**
+         * @return the next node, if there is one
+         */
         @SuppressWarnings("unchecked")
         public T nextNode() {
             currentNode_ = nextNode_;
@@ -1537,7 +1539,9 @@ public void remove() {
             current.remove();
         }
 
-        /** @return the next node, if there is one */
+        /**
+         * @return the next node, if there is one
+         */
         @SuppressWarnings("unchecked")
         public DomNode nextNode() {
             currentNode_ = nextNode_;
@@ -1638,7 +1642,9 @@ public void remove() {
             current.remove();
         }
 
-        /** @return the next node, if there is one */
+        /**
+         * @return the next node, if there is one
+         */
         @SuppressWarnings("unchecked")
         public DomElement nextNode() {
             currentNode_ = nextNode_;
@@ -1739,7 +1745,9 @@ public void remove() {
             current.remove();
         }
 
-        /** @return the next node, if there is one */
+        /**
+         * @return the next node, if there is one
+         */
         @SuppressWarnings("unchecked")
         public HtmlElement nextNode() {
             currentNode_ = nextNode_;

src/main/java/org/htmlunit/html/HtmlTableRow.java

@@ -166,7 +166,9 @@ public CellIterator() {
             setNextCell(getFirstChild());
         }
 
-        /** @return whether there is another cell available */
+        /**
+         * @return whether there is another cell available
+         */
         @Override
         public boolean hasNext() {
             return nextCell_ != null;

src/main/java/org/htmlunit/html/XmlSerializer.java

@@ -54,6 +54,12 @@ public class XmlSerializer {
     private final StringBuilder indent_ = new StringBuilder();
     private File outputDir_;
 
+    /**
+     * Saves the given {@link SgmlPage} to the file.
+     * @param page the page to save
+     * @param file the destination
+     * @throws IOException in case of error
+     */
     public void save(final SgmlPage page, final File file) throws IOException {
         save(page, file, false);
     }

src/main/java/org/htmlunit/html/parser/neko/HtmlUnitNekoHtmlParser.java

@@ -315,7 +315,9 @@ class HtmlUnitNekoHTMLErrorHandler implements XMLErrorHandler {
         html_ = htmlContent;
     }
 
-    /** @see DefaultErrorHandler#error(String,String,XMLParseException) */
+    /**
+     * @see DefaultErrorHandler#error(String,String,XMLParseException)
+     */
     @Override
     public void error(final String domain, final String key,
             final XMLParseException exception) throws XNIException {
@@ -327,7 +329,9 @@ public void error(final String domain, final String key,
                 key);
     }
 
-    /** @see DefaultErrorHandler#warning(String,String,XMLParseException) */
+    /**
+     * @see DefaultErrorHandler#warning(String,String,XMLParseException)
+     */
     @Override
     public void warning(final String domain, final String key,
             final XMLParseException exception) throws XNIException {

src/main/java/org/htmlunit/html/xpath/XPathHelper.java

@@ -92,6 +92,14 @@ public static <T> List<T> getByXPath(final DomNode contextNode, final String xpa
         }
     }
 
+    /**
+     * @param <T> the type of nodes expected
+     * @param node the start node
+     * @param xpath the {@link XPathAdapter} to search for
+     * @param prefixResolver the {@link PrefixResolver} to be used
+     * @return a list of nodes matching the given xpath
+     * @throws TransformerException in case of error
+     */
     public static <T> List<T> getByXPath(final Node node, final XPathAdapter xpath,
             final PrefixResolver prefixResolver) throws TransformerException {
         final List<T> list = new ArrayList<>();

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

@@ -125,6 +125,10 @@ public String getHash() {
         return ref == null ? "" : "#" + ref;
     }
 
+    /**
+     * Sets the {@code hash} property.
+     * @param fragment the {@code hash} property
+     */
     @JsxSetter
     public void setHash(final String fragment) throws MalformedURLException {
         if (url_ == null) {
@@ -146,6 +150,10 @@ public String getHost() {
         return url_.getHost() + (port > 0 ? ":" + port : "");
     }
 
+    /**
+     * Sets the {@code host} property.
+     * @param host the {@code host} property
+     */
     @JsxSetter
     public void setHost(final String host) throws MalformedURLException {
         if (url_ == null) {
@@ -210,6 +218,10 @@ public String getHostname() {
         return UrlUtils.encodeAnchor(url_.getHost());
     }
 
+    /**
+     * Sets the {@code hostname} property.
+     * @param hostname the {@code hostname} property
+     */
     @JsxSetter
     public void setHostname(final String hostname) throws MalformedURLException {
         if (getBrowserVersion().hasFeature(JS_ANCHOR_HOSTNAME_IGNORE_BLANK)) {
@@ -234,6 +246,10 @@ public String getHref() {
         return jsToString();
     }
 
+    /**
+     * Sets the {@code href} property.
+     * @param href the {@code href} property
+     */
     @JsxSetter
     public void setHref(final String href) throws MalformedURLException {
         if (url_ == null) {
@@ -289,6 +305,10 @@ public String getPassword() {
         return idx == -1 ? "" : userInfo.substring(idx + 1);
     }
 
+    /**
+     * Sets the {@code password} property.
+     * @param password the {@code password} property
+     */
     @JsxSetter
     public void setPassword(final String password) throws MalformedURLException {
         if (url_ == null) {
@@ -311,6 +331,10 @@ public String getPathname() {
         return path.isEmpty() ? "/" : path;
     }
 
+    /**
+     * Sets the {@code path} property.
+     * @param path the {@code path} property
+     */
     @JsxSetter
     public void setPathname(final String path) throws MalformedURLException {
         if (url_ == null) {
@@ -334,6 +358,10 @@ public String getPort() {
         return port == -1 ? "" : Integer.toString(port);
     }
 
+    /**
+     * Sets the {@code port} property.
+     * @param port the {@code port} property
+     */
     @JsxSetter
     public void setPort(final String port) throws MalformedURLException {
         if (url_ == null) {
@@ -356,6 +384,10 @@ public String getProtocol() {
         return protocol.isEmpty() ? "" : (protocol + ":");
     }
 
+    /**
+     * Sets the {@code protocol} property.
+     * @param protocol the {@code protocol} property
+     */
     @JsxSetter
     public void setProtocol(final String protocol) throws MalformedURLException {
         if (url_ == null || protocol.isEmpty()) {
@@ -391,6 +423,10 @@ public String getSearch() {
         return search == null ? "" : "?" + search;
     }
 
+    /**
+     * Sets the {@code search} property.
+     * @param search the {@code search} property
+     */
     @JsxSetter
     public void setSearch(final String search) throws MalformedURLException {
         if (url_ == null) {
@@ -416,6 +452,11 @@ public void setSearch(final String search) throws MalformedURLException {
         url_ = UrlUtils.getUrlWithNewQuery(url_, query);
     }
 
+    /**
+     * Sets the {@code search} property based on {@link NameValuePair}'s.
+     * @param nameValuePairs the pairs
+     * @throws MalformedURLException in case of error
+     */
     public void setSearch(final List<NameValuePair> nameValuePairs) throws MalformedURLException {
         final StringBuilder newSearch = new StringBuilder();
         for (final NameValuePair nameValuePair : nameValuePairs) {
@@ -448,6 +489,10 @@ public String getUsername() {
         return StringUtils.substringBefore(userInfo, ':');
     }
 
+    /**
+     * Sets the {@code username} property.
+     * @param username the {@code username} property
+     */
     @JsxSetter
     public void setUsername(final String username) throws MalformedURLException {
         if (url_ == null) {

src/main/java/org/htmlunit/util/geometry/Point2D.java

@@ -23,15 +23,26 @@ public class Point2D {
     private final double myX_;
     private final double myY_;
 
+    /**
+     * Ctor.
+     * @param x x value
+     * @param y y value
+     */
     public Point2D(final double x, final double y) {
         myX_ = x;
         myY_ = y;
     }
 
+    /**
+     * @return the x value
+     */
     public double getX() {
         return myX_;
     }
 
+    /**
+     * @return the y value
+     */
     public double getY() {
         return myY_;
     }