[DOXIA-606] fix javadoc issues with JDK 8 when generating documentation
Closes #38
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/parser/Xhtml5BaseParserTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/parser/Xhtml5BaseParserTest.java
index 2776045..3d58d7a 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/parser/Xhtml5BaseParserTest.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/parser/Xhtml5BaseParserTest.java
@@ -69,7 +69,6 @@
assertNotEquals( "unknown", XhtmlBaseParser.doxiaVersion() );
}
- /** @throws Exception */
public void testHeadingEventsList()
throws Exception
{
@@ -110,7 +109,6 @@
assertFalse( it.hasNext() );
}
- /** @throws Exception */
public void testNestedHeadingEventsList()
throws Exception
{
@@ -150,7 +148,6 @@
assertFalse( it.hasNext() );
}
- /** @throws Exception */
public void testFigureEventsList()
throws Exception
{
@@ -164,7 +161,6 @@
assertFalse( it.hasNext() );
}
- /** @throws Exception */
public void testTableEventsList()
throws Exception
{
@@ -194,7 +190,6 @@
assertFalse( it.hasNext() );
}
- /** @throws Exception */
public void testSignificantWhiteSpace()
throws Exception
{
@@ -267,7 +262,6 @@
assertFalse( it.hasNext() );
}
- /** @throws Exception */
public void testPreFormattedText()
throws Exception
{
@@ -304,7 +298,6 @@
assertFalse( it.hasNext() );
}
- /** @throws Exception */
public void testPreEOL()
throws Exception
{
@@ -327,7 +320,6 @@
assertEquals( "verbatim_", it.next().getName() );
}
- /** @throws Exception */
public void testDoxia250()
throws Exception
{
@@ -368,7 +360,6 @@
assertEquals( "paragraph_", event.getName() );
}
- /** @throws Exception */
public void testEntities()
throws Exception
{
@@ -437,7 +428,6 @@
assertFalse( it.hasNext() );
}
- /** @throws Exception */
public void testXhtmlEntities()
throws Exception
{
@@ -478,7 +468,6 @@
assertFalse( it.hasNext() );
}
- /** @throws Exception */
public void testLists()
throws Exception
{
@@ -508,7 +497,6 @@
assertEquals( "division_", it.next().getName() );
}
- /** @throws Exception */
public void testSimpleTags()
throws Exception
{
@@ -524,7 +512,6 @@
assertEquals( "division_", it.next().getName() );
}
- /** @throws Exception */
public void testSemanticTags()
throws Exception
{
@@ -680,7 +667,6 @@
}
- /** @throws Exception */
public void testSpecial()
throws Exception
{
@@ -697,7 +683,6 @@
assertEquals( "paragraph_", it.next().getName() );
}
- /** @throws Exception */
public void testTable()
throws Exception
{
@@ -726,7 +711,6 @@
assertEquals( "table_", it.next().getName() );
}
- /** @throws Exception */
public void testFigure()
throws Exception
{
@@ -741,7 +725,6 @@
assertEquals( "figure_", it.next().getName() );
}
- /** @throws Exception */
public void testAnchorLink()
throws Exception
{
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/AbstractSinkTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/AbstractSinkTest.java
index 0191895..4247059 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/AbstractSinkTest.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/sink/impl/AbstractSinkTest.java
@@ -63,7 +63,7 @@
/**
* Ability to wrap the xmlFragment with a roottag and namespaces, when required
*
- * @param xmlFragment
+ * @param xmlFragment XML fragment to wrap
* @return valid XML
*/
protected String wrapXml( String xmlFragment )
@@ -766,7 +766,7 @@
/**
* Checks that the sequence <code>[blockquote(), text( text ),
* blockquote_()]</code>, invoked on the current sink, produces
- * the same result as {@link #getBlackquoteBlock getBlockquoteBlock}( text ).
+ * the same result as {@link #getBlockquoteBlock}( text ).
*/
public void testBlockquote()
{
@@ -1366,7 +1366,7 @@
* Returns a Division block generated by this sink.
* @param text The text to use.
* @return The result of invoking a Division block on the current sink.
- * @see #testDivision()
+ * @see #testDivider()
*/
protected abstract String getDivisionBlock( String text );
diff --git a/doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownParserTest.java b/doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownParserTest.java
index 861dc9f..8110378 100644
--- a/doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownParserTest.java
+++ b/doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownParserTest.java
@@ -35,7 +35,7 @@
/**
* Tests for {@link MarkdownParser}.
*
- * @author Julien Nicoulaud <julien.nicoulaud@gmail.com>
+ * @author <a href="mailto:julien.nicoulaud@gmail.com">Julien Nicoulaud</a>
* @since 1.3
*/
public class MarkdownParserTest
@@ -79,7 +79,7 @@
/**
* Assert the paragraph sink event is fired when parsing "paragraph.md".
*
- * @throws Exception if the event list is not correct when parsing the document.
+ * @throws Exception if the event list is not correct when parsing the document
*/
public void testParagraphSinkEvent()
throws Exception
@@ -94,7 +94,7 @@
/**
* Assert the bold sink event is fired when parsing "font-bold.md".
*
- * @throws Exception if the event list is not correct when parsing the document.
+ * @throws Exception if the event list is not correct when parsing the document
*/
public void testFontBoldSinkEvent()
throws Exception
@@ -116,7 +116,7 @@
/**
* Assert the italic sink event is fired when parsing "font-italic.md".
*
- * @throws Exception if the event list is not correct when parsing the document.
+ * @throws Exception if the event list is not correct when parsing the document
*/
public void testFontItalicSinkEvent()
throws Exception
@@ -137,7 +137,7 @@
/**
* Assert the monospaced/code sink event is fired when parsing "font-monospaced.md".
*
- * @throws Exception if the event list is not correct when parsing the document.
+ * @throws Exception if the event list is not correct when parsing the document
*/
public void testFontMonospacedSinkEvent()
throws Exception
@@ -158,7 +158,7 @@
/**
* Assert the verbatim sink event is fired when parsing "code.md".
*
- * @throws Exception if the event list is not correct when parsing the document.
+ * @throws Exception if the event list is not correct when parsing the document
*/
public void testCodeSinkEvent()
throws Exception
@@ -173,7 +173,7 @@
/**
* Assert the figureGraphics sink event is fired when parsing "image.md".
*
- * @throws Exception if the event list is not correct when parsing the document.
+ * @throws Exception if the event list is not correct when parsing the document
*/
public void testImageSinkEvent()
throws Exception
@@ -188,7 +188,7 @@
/**
* Assert the link sink event is fired when parsing "link.md".
*
- * @throws Exception if the event list is not correct when parsing the document.
+ * @throws Exception if the event list is not correct when parsing the document
*/
public void testLinkSinkEvent()
throws Exception
@@ -203,7 +203,7 @@
/**
* Assert the link sink event is fired when parsing "link.md".
*
- * @throws Exception if the event list is not correct when parsing the document.
+ * @throws Exception if the event list is not correct when parsing the document
*/
public void testLinkRewriteSinkEvent()
throws Exception
@@ -232,7 +232,7 @@
/**
* Assert the list sink event is fired when parsing "list.md".
*
- * @throws Exception if the event list is not correct when parsing the document.
+ * @throws Exception if the event list is not correct when parsing the document
*/
public void testListSinkEvent()
throws Exception
@@ -248,7 +248,7 @@
/**
* Assert the numbered list sink event is fired when parsing "numbered-list.md".
*
- * @throws Exception if the event list is not correct when parsing the document.
+ * @throws Exception if the event list is not correct when parsing the document
*/
public void testNumberedListSinkEvent()
throws Exception
@@ -264,7 +264,7 @@
/**
* Assert the metadata is passed through when parsing "metadata.md".
*
- * @throws Exception if the event list is not correct when parsing the document.
+ * @throws Exception if the event list is not correct when parsing the document
*/
public void testMetadataSinkEvent()
throws Exception
@@ -282,7 +282,7 @@
/**
* Assert the first header is passed as title event when parsing "first-heading.md".
*
- * @throws Exception if the event list is not correct when parsing the document.
+ * @throws Exception if the event list is not correct when parsing the document
*/
public void testFirstHeadingSinkEvent()
throws Exception
@@ -299,7 +299,7 @@
/**
* Assert the first header is passed as title event when parsing "comment-before-heading.md".
*
- * @throws Exception if the event list is not correct when parsing the document.
+ * @throws Exception if the event list is not correct when parsing the document
*/
public void testCommentBeforeHeadingSinkEvent()
throws Exception
@@ -316,7 +316,7 @@
/**
* Assert the first header is passed as title event when parsing "comment-before-heading.md".
*
- * @throws Exception if the event list is not correct when parsing the document.
+ * @throws Exception if the event list is not correct when parsing the document
*/
public void testHtmlContent()
throws Exception
@@ -337,9 +337,10 @@
/**
* Parse the file and return a {@link SinkEventTestingSink}.
*
- * @param file the file to parse with {@link #parser}.
- * @return a sink to test parsing events.
- * @throws ParseException if the document parsing failed.
+ * @param file the file to parse with {@link #parser}
+ * @return a sink to test parsing events
+ * @throws ParseException if the document parsing failed
+ * @throws IOException if an I/O error occurs while closing test reader
*/
protected SinkEventTestingSink parseFileToEventTestingSink( String file ) throws ParseException, IOException
{
@@ -361,7 +362,6 @@
}
}
- /** @throws Exception */
public void testTocMacro()
throws Exception
{
@@ -385,11 +385,7 @@
"body_" );
}
- /**
- * TOC macro fails with EmptyStackException when title 2 followed by title 4 then title 2
- *
- * @throws Exception
- */
+ // TOC macro fails with EmptyStackException when title 2 followed by title 4 then title 2
public void testTocMacroDoxia559()
throws Exception
{
@@ -417,11 +413,7 @@
"body_" );
}
- /**
- * test fix for https://github.com/vsch/flexmark-java/issues/384
- *
- * @throws Exception
- */
+ // test fix for https://github.com/vsch/flexmark-java/issues/384
public void testFlexIssue384()
throws Exception
{
