elharo commented on a change in pull request #38:
URL: https://github.com/apache/maven-doxia/pull/38#discussion_r488147741
##########
File path:
doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownParserTest.java
##########
@@ -340,6 +340,7 @@ public void testHtmlContent()
* @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.
Review comment:
no period at end of doc comment unless it's a complete sentence; per
Oracle style guide
##########
File path:
doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownParserTest.java
##########
@@ -361,7 +362,7 @@ protected String parseFileToHtml( String file ) throws
ParseException, IOExcepti
}
}
- /** @throws Exception */
+ /** @throws Exception if the document parsing failed. */
Review comment:
no period, or just delete this one. We don't need doc comments for tests
##########
File path:
doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownParserTest.java
##########
@@ -388,7 +389,7 @@ public void testTocMacro()
/**
* TOC macro fails with EmptyStackException when title 2 followed by title
4 then title 2
*
- * @throws Exception
+ * @throws Exception if the document parsing failed.
Review comment:
ditto
##########
File path:
doxia-modules/doxia-module-markdown/src/test/java/org/apache/maven/doxia/module/markdown/MarkdownParserTest.java
##########
@@ -420,7 +421,7 @@ public void testTocMacroDoxia559()
/**
* test fix for https://github.com/vsch/flexmark-java/issues/384
*
- * @throws Exception
+ * @throws Exception if the document parsing failed.
Review comment:
ditto
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
