Mikhail Petrov created IGNITE-28608:
---------------------------------------

             Summary: Include ignite generated sources to maven sources path 
before javadoc generation 
                 Key: IGNITE-28608
                 URL: https://issues.apache.org/jira/browse/IGNITE-28608
             Project: Ignite
          Issue Type: Improvement
            Reporter: Mikhail Petrov


The `maven-javadoc-plugin aggregate-no-fork` goal iterates through all 
submodules and aggregates the contents of the `src/main/java` source 
directories to generate Javadoc documentation.

Even if a class is excluded from Javadoc generation (see the 
`excludePackageNames` property of the `maven-javadoc-plugin`), the Javadoc 
documentation builder still analyzes the excluded file imports. See 
https://github.com/apache/maven-javadoc-plugin/issues/924

If there are imports of classes whose source code is automatically generated 
and is not located in the `src/main/java` directory, Javadoc generation MAY 
fail. If the source file is not found, Javadoc Builder appears to look for a 
compiled CLASS file to process with import checking. This behavior is poorly 
documented and does not work at all in some environments.

It is suggested to explicitly add directories with automatically generated 
source files to the Maven source file path before generating Javadoc 
documentation.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to