Make javadoc lint happy

jbake-org · Oct 30, 2018 · 7fe542f · 7fe542f
1 parent c8848ec
commit 7fe542f
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/jbake-core/src/main/java/org/jbake/app/ContentStore.java b/jbake-core/src/main/java/org/jbake/app/ContentStore.java
@@ -176,7 +176,7 @@ private void activateOnCurrentThread() {
     /**
      * Get a document by sourceUri and update it from the given map.
      * @return the saved document.
-     * @throws Exception if sourceUri or docType are null, or if the document doesn't exist.
+     * throws {@link IllegalArgumentException} if sourceUri or docType are null, or if the document doesn't exist.
      */
     public ODocument mergeDocument(Map<String, Object> incomingDocMap)
     {

diff --git a/jbake-core/src/main/java/org/jbake/app/configuration/JBakeConfiguration.java b/jbake-core/src/main/java/org/jbake/app/configuration/JBakeConfiguration.java
@@ -332,12 +332,12 @@ public interface JBakeConfiguration {
     Charset getInputCharset();
 
     /**
-     * Should JBake prefix <img src="..."> with site base URL?
+     * Should JBake prefix &lt;img src="..."&gt; with site base URL?
      */
     boolean getMakeImagesUrlAbolute();
 
     /**
-     * Should JBake prefix <img src="..."> with site base URL relative URLs?
+     * Should JBake prefix &lt;img src="..."&gt; with site base URL relative URLs?
      * This is not disjunctive from IMAGES_URL_MAKE_ABSOLUTE.
      */
     boolean getRelativeImagePathsPointToAssets();

diff --git a/jbake-core/src/main/java/org/jbake/parser/AsciidoctorEngine.java b/jbake-core/src/main/java/org/jbake/parser/AsciidoctorEngine.java
@@ -121,7 +121,7 @@ public Map<String, String> parseHeaderBlock(final ParserContext context) {
                 documentModel.put(key, attributes.get(key));
             }
         }
-        
+
         return null; // TODO: Create the header map first, then apply to the doc.
     }
 

diff --git a/jbake-core/src/main/java/org/jbake/parser/texy/TitleExtractor.java b/jbake-core/src/main/java/org/jbake/parser/texy/TitleExtractor.java
@@ -76,7 +76,7 @@ public void tryExtractHighestHeader(ParserContext context)
 
     /**
      * Getting an inner XML is a bit complicated in JDK.
-     * TODO: All this just to get rid if the previously added <div>? Let's use JSoup I guess.
+     * TODO: All this just to get rid if the previously added &lt;div/&gt;? Let's use JSoup I guess.
      */
     public static String innerXml(Node docRootNode)
     {