#332 Fix Java docs

aim42 · Aug 15, 2024 · 274ddc8 · 274ddc8
1 parent 8f39028
commit 274ddc8
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 10 deletions.
diff --git a/htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/check/SuggestingChecker.java b/htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/check/SuggestingChecker.java
@@ -27,8 +27,8 @@ public SuggestingChecker(Configuration pConfig) {
     /**
      * let the instance determine the list of possible values
      * Examples:
-     * - MissingImageFilesChecker -> collect the names of images files
-     * - BrokenCrossReferencesChecker -> collect all (internal) link targets
+     * - MissingImageFilesChecker → collect the names of images files
+     * - BrokenCrossReferencesChecker → collect all (internal) link targets
      **/
     protected abstract void setValidPossibilities();
 

diff --git a/htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/html/HtmlPage.java b/htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/html/HtmlPage.java
@@ -103,7 +103,7 @@ public final List<String> getAllMapNames() {
     }
 
     /**
-     * @return list of all usemap-references y with <img src="x" usemap="y"
+     * @return list of all usemap-references y with &lt;img src="x" usemap="y" ...
      */
     public List<String> getAllUsemapRefs() {
         return getImagesWithUsemapDeclaration().stream()
@@ -133,7 +133,7 @@ public final List<HtmlElement> getAllImageTagsWithNonEmptyAltAttribute() {
     }
 
     /**
-     * builds an immutable list of <img...> tags, where
+     * Builds an immutable list of &lt;img...&gt; tags, where
      * the alt-tag is missing or empty ("").
      */
     public final List<HtmlElement> getAllImageTagsWithMissingAltAttribute() {
@@ -169,11 +169,11 @@ public final List<HtmlElement> getAllIds() {
     }
 
     /**
-     * @return List < String >  of all href-attributes
+     * @return List<String> of all href-attributes
      * <p>
      * common pitfalls with hrefs:
      * - local hrefs start with # (like "#appendix")
-     * - remote hrefs should be valid URLs (like "<a href="https://google.com">https://google.com</a>")
+     * - remote hrefs should be valid URLs (like "&lt;a href="https://google.com"&gt;https://google.com&lt;/a&gt;")
      * - remote hrefs might start with other than http (e.g. https, mailto, telnet, ssh)
      * - hrefs might start with file://
      * - href might be empty string (nobody knows wtf this is good for, but html parsers usually accept it)
@@ -206,8 +206,15 @@ public List<HtmlElement> getImagesWithUsemapDeclaration() {
     }
 
     /**
-     * html-map has the following form:
-     * <map name="mapName"><area...><area...></map>
+     * An HTML map has the following form:
+     *
+     * <code>
+     *     &lt;map name="mapName"&gt;
+     *         &lt;area...&gt;
+     *         &lt;area...&gt;
+     *     &lt;/map&gt;
+     * </code>
+     *
      * <p>
      * collect all area elements for a given map.
      * If more than one map exists with this name, areas

diff --git a/htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/report/SummarizerUtil.java b/htmlSanityCheck-core/src/main/java/org/aim42/htmlsanitycheck/report/SummarizerUtil.java
@@ -2,10 +2,10 @@
 
 public class SummarizerUtil {
     /**
-     * returns the percentage of successful checks.
+     * Returns the percentage of successful checks.
      * <p>
      * Edge case:
-     * 0 checks -> 100% successful
+     * 0 checks → 100% successful
      */
     public static int percentSuccessful(int totalChecks, int totalNrOfFindings) {