You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by GitBox <gi...@apache.org> on 2020/09/14 17:40:24 UTC
[GitHub] [maven-doxia] michaelboyles opened a new pull request #38: [DOXIA-606] fix javadoc issues with JDK 8 when generating documentation
michaelboyles opened a new pull request #38:
URL: https://github.com/apache/maven-doxia/pull/38
https://issues.apache.org/jira/browse/DOXIA-606
Boy does this thing take a while to build!
```
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 24:58 min
[INFO] Finished at: 2020-09-14T18:12:47+01:00
[INFO] ------------------------------------------------------------------------
```
----------------------------------------------------------------
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:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
[GitHub] [maven-doxia] asfgit closed pull request #38: [DOXIA-606] fix javadoc issues with JDK 8 when generating documentation
Posted by GitBox <gi...@apache.org>.
asfgit closed pull request #38:
URL: https://github.com/apache/maven-doxia/pull/38
----------------------------------------------------------------
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:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
[GitHub] [maven-doxia] michaelboyles commented on a change in pull request #38: [DOXIA-606] fix javadoc issues with JDK 8 when generating documentation
Posted by GitBox <gi...@apache.org>.
michaelboyles commented on a change in pull request #38:
URL: https://github.com/apache/maven-doxia/pull/38#discussion_r488162935
##########
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:
I copied the existing precedent. Would you rather I change the other ones which were not affecting the build or make them inconsistent with one another?
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [maven-doxia] michaelboyles commented on a change in pull request #38: [DOXIA-606] fix javadoc issues with JDK 8 when generating documentation
Posted by GitBox <gi...@apache.org>.
michaelboyles commented on a change in pull request #38:
URL: https://github.com/apache/maven-doxia/pull/38#discussion_r488172412
##########
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:
Ok, will fix the others
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [maven-doxia] elharo commented on a change in pull request #38: [DOXIA-606] fix javadoc issues with JDK 8 when generating documentation
Posted by GitBox <gi...@apache.org>.
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:
users@infra.apache.org
[GitHub] [maven-doxia] elharo commented on a change in pull request #38: [DOXIA-606] fix javadoc issues with JDK 8 when generating documentation
Posted by GitBox <gi...@apache.org>.
elharo commented on a change in pull request #38:
URL: https://github.com/apache/maven-doxia/pull/38#discussion_r488170013
##########
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:
Up to you, but please don't introduce new violations
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [maven-doxia] michaelboyles commented on a change in pull request #38: [DOXIA-606] fix javadoc issues with JDK 8 when generating documentation
Posted by GitBox <gi...@apache.org>.
michaelboyles commented on a change in pull request #38:
URL: https://github.com/apache/maven-doxia/pull/38#discussion_r488165977
##########
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:
Moved description to regular comment
##########
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:
Moved description to regular comment
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [maven-doxia] michaelboyles commented on a change in pull request #38: [DOXIA-606] fix javadoc issues with JDK 8 when generating documentation
Posted by GitBox <gi...@apache.org>.
michaelboyles commented on a change in pull request #38:
URL: https://github.com/apache/maven-doxia/pull/38#discussion_r488166146
##########
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:
Deleted
----------------------------------------------------------------
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:
users@infra.apache.org