[GitHub] [nutch] sebastian-nagel commented on pull request #568: NUTCH-2842 Fix Javadoc warnings, errors and add Javadoc check to Github Action and Jenkins

[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