You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@nutch.apache.org by GitBox <gi...@apache.org> on 2021/02/10 05:26:19 UTC
[GitHub] [nutch] lewismc opened a new pull request #568: NUTCH-2842 Fix Javadoc warnings, errors and add Javadoc check to Github Action and Jenkins
lewismc opened a new pull request #568:
URL: https://github.com/apache/nutch/pull/568
This patch fixes all errors and all but 7 warnings (see below). It activates the `failonerror` flag which will now be run upon every pull request, as part of our Jenkins build and as part of the release process.
```
[javadoc] javadoc: warning - Multiple sources of package comments found for package "org.apache.nutch.crawl"
[javadoc] javadoc: warning - Multiple sources of package comments found for package "org.apache.nutch.fetcher"
[javadoc] javadoc: warning - Multiple sources of package comments found for package "org.apache.nutch.indexer"
[javadoc] javadoc: warning - Multiple sources of package comments found for package "org.apache.nutch.metadata"
[javadoc] javadoc: warning - Multiple sources of package comments found for package "org.apache.nutch.plugin"
[javadoc] javadoc: warning - Multiple sources of package comments found for package "org.apache.nutch.util.domain"
[javadoc] javadoc: warning - Multiple sources of package comments found for package "javax.annotation"
```
I have not found a solution for the above warnings and therefore cannot activate the `failonwarning` flag quite yet.
Also, I had to remove the Lucene and Solr javadoc links as they were also causing warnings. I think this is due to the doclet version I am using which is not forward compatible with the >1.8 Javadoc genrated by Lucene or Solr.
Feedback welcome folks, thank you.
----------------------------------------------------------------
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] [nutch] sebastian-nagel commented on pull request #568: NUTCH-2842 Fix Javadoc warnings, errors and add Javadoc check to Github Action and Jenkins
Posted by GitBox <gi...@apache.org>.
sebastian-nagel commented on pull request #568:
URL: https://github.com/apache/nutch/pull/568#issuecomment-777298196
Hi @lewismc, looks great! +1 to commit.
> [javadoc] javadoc: warning - Multiple sources of package comments found for package "org.apache.nutch.crawl"
Caused by the `package.html` files copied over into build/:
- solution 1: exclude in the copy statement
```xml
<target name="compile-core" depends="init, resolve-default" description="--> compile core Java files only">
...
<copy todir="${build.classes}">
<fileset dir="${src.dir}" includes="**/*.html" />
```
should be:
```xml
<fileset dir="${src.dir}" includes="**/*.html" excludes="**/package.html" />
```
- solution 2: replace the remaining `package.html` by `package-info.java`. More work but imho the right way to go. Maybe a subtask or new issue.
> [javadoc] javadoc: warning - Multiple sources of package comments found for package "javax.annotation"
The jar file `javax.annotation-api-1.3.2.jar` includes `javax/annotation/package.html` and we include the jar twice in the any23 resp. parse-tika plugins.
----------------------------------------------------------------
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] [nutch] lewismc merged pull request #568: NUTCH-2842 Fix Javadoc warnings, errors and add Javadoc check to Github Action and Jenkins
Posted by GitBox <gi...@apache.org>.
lewismc merged pull request #568:
URL: https://github.com/apache/nutch/pull/568
----------------------------------------------------------------
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] [nutch] lewismc commented on pull request #568: NUTCH-2842 Fix Javadoc warnings, errors and add Javadoc check to Github Action and Jenkins
Posted by GitBox <gi...@apache.org>.
lewismc commented on pull request #568:
URL: https://github.com/apache/nutch/pull/568#issuecomment-777661035
Thank you @sebastian-nagel for the review. I created https://issues.apache.org/jira/browse/NUTCH-2849 to address solution # 2 above. Thanks for this... I couldn't quite figure it out.
----------------------------------------------------------------
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