javadoc fixes

HtmlUnit · Oct 20, 2024 · 0d25822 · 0d25822
1 parent 15862b8
commit 0d25822
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 8 deletions.
diff --git a/src/main/java/org/htmlunit/html/HtmlDomTreeWalker.java b/src/main/java/org/htmlunit/html/HtmlDomTreeWalker.java
@@ -108,7 +108,7 @@ public DomNode getCurrentNode() {
     /**
      * @see org.w3c.dom.traversal.TreeWalker#setCurrentNode(Node)
      * @param currentNode the current node
-     * @throws DOMException
+     * @throws DOMException if the current node provides is null
      */
     public void setCurrentNode(final Node currentNode) throws DOMException {
         if (currentNode == null) {

diff --git a/src/main/java/org/htmlunit/html/XmlSerializer.java b/src/main/java/org/htmlunit/html/XmlSerializer.java
@@ -270,6 +270,7 @@ private static String getFileExtension(final Page enclosedPage) {
     /**
      * @param link the link to get the attributes from
      * @return the attribute map
+     * @throws IOException in case of error
      */
     protected Map<String, DomAttr> getAttributesFor(final HtmlLink link) throws IOException {
         final Map<String, DomAttr> map = createAttributesCopyWithClonedAttribute(link, "href");

diff --git a/src/main/java/org/htmlunit/html/impl/SimpleRange.java b/src/main/java/org/htmlunit/html/impl/SimpleRange.java
@@ -277,7 +277,7 @@ else if (endContainer_.getChildNodes().getLength() > endOffset_) {
      * Moves the contents of a Range from the containing document or document
      * fragment to a new DocumentFragment.
      * @return DocumentFragment containing the extracted contents
-     * @throws DOMException
+     * @throws DOMException in case of error
      */
     public DomDocumentFragment extractContents() throws DOMException {
         final DomDocumentFragment fragment = cloneContents();
@@ -292,7 +292,7 @@ public DomDocumentFragment extractContents() throws DOMException {
     /**
      * @return true if startContainer equals endContainer and
      * startOffset equals endOffset
-     * @throws DOMException
+     * @throws DOMException in case of error
      */
     public boolean isCollapsed() throws DOMException {
         return startContainer_ == endContainer_ && startOffset_ == endOffset_;
@@ -301,7 +301,7 @@ public boolean isCollapsed() throws DOMException {
     /**
      * @return the deepest common ancestor container of this range's two
      * boundary-points.
-     * @throws DOMException
+     * @throws DOMException in case of error
      */
     public DomNode getCommonAncestorContainer() throws DOMException {
         if (startContainer_ != null && endContainer_ != null) {

diff --git a/src/main/java/org/htmlunit/javascript/JavaScriptEngine.java b/src/main/java/org/htmlunit/javascript/JavaScriptEngine.java
@@ -275,6 +275,7 @@ private void init(final WebWindow webWindow, final Page page, final Context cont
      * @param browserVersion the {@link BrowserVersion}
      * @param prototypes map of prototypes
      * @param prototypesPerJSName map of prototypes with the class name as key
+     * @throws Exception in case of error
      */
     public static void configureScope(final HtmlUnitScriptable jsScope,
             final ClassConfiguration scopeConfig,
@@ -529,10 +530,7 @@ private static void removePrototypeProperties(final Scriptable scope, final Stri
      * @throws InstantiationException if the new class cannot be instantiated
      * @throws IllegalAccessException if we don't have access to create the new instance
      * @return the created prototype
-     * @throws SecurityException
-     * @throws NoSuchMethodException
-     * @throws InvocationTargetException
-     * @throws IllegalArgumentException
+     * @throws Exception in case of errors
      */
     public static HtmlUnitScriptable configureClass(final ClassConfiguration config, final Scriptable window)
         throws Exception {

diff --git a/src/main/java/org/htmlunit/javascript/host/file/Blob.java b/src/main/java/org/htmlunit/javascript/host/file/Blob.java
@@ -84,10 +84,13 @@ protected abstract static class Backend implements Serializable {
 
         /**
          * @return the text
+         * @throws IOException in case of error
          */
         abstract String getText() throws IOException;
 
         /**
+         * @param start the start position
+         * @param end the end position
          * @return the bytes
          */
         abstract byte[] getBytes(int start, int end);