Skip to content

Commit 4eca2da

Browse files
chirinochirino
committed
fix: attach an empty javadoc for modules which are not intended to be consumed as libraries
The empty javadoc.jar just contains a README.md stating why no javadoc was included. Fixes #877
1 parent 4af3abf commit 4eca2da

14 files changed

Lines changed: 138 additions & 30 deletions

File tree

‎aot-build-time-cli/pom.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@
106106
<configuration>
107107
<flags>-Xmx1G</flags>
108108
<programFile>chicory-aot</programFile>
109+
<inputFile>${project.build.directory}/${project.build.finalName}.jar</inputFile>
109110
<attachProgramFile>true</attachProgramFile>
110111
</configuration>
111112

‎aot-build-time/src/main/javadoc/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Notice: Private API
2+
3+
This module contains the private API. It is not intended for public use and it's classes
4+
are subject to change without notice.

‎aot-maven-plugin/src/main/javadoc/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Notice: Private API
2+
3+
This module contains the private API. It is not intended for public use and it's classes
4+
are subject to change without notice.

‎cli/pom.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@
9090
<version>2.1.1</version>
9191
<configuration>
9292
<flags>-Xmx1G</flags>
93+
<inputFile>${project.build.directory}/${project.build.finalName}.jar</inputFile>
9394
<programFile>chicory</programFile>
9495
<attachProgramFile>true</attachProgramFile>
9596
</configuration>

‎cli/src/main/javadoc/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Notice: Private API
2+
3+
This module contains the private API. It is not intended for public use and it's classes
4+
are subject to change without notice.

‎docs-lib/src/main/javadoc/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Notice: Private API
2+
3+
This module contains the private API. It is not intended for public use and it's classes
4+
are subject to change without notice.

‎fuzz/src/main/javadoc/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Notice: Private API
2+
3+
This module contains the private API. It is not intended for public use and it's classes
4+
are subject to change without notice.

‎jmh/src/main/javadoc/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Notice: Private API
2+
3+
This module contains the private API. It is not intended for public use and it's classes
4+
are subject to change without notice.

‎pom.xml‎

Lines changed: 92 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@
8989
<maven-install-plugin.version>3.1.4</maven-install-plugin.version>
9090
<maven-jar-plugin.version>3.4.2</maven-jar-plugin.version>
9191
<maven-javadoc-plugin.version>3.11.2</maven-javadoc-plugin.version>
92+
<maven-build-helper-maven-plugin>3.6.0</maven-build-helper-maven-plugin>
9293
<maven-plugin-plugin.version>3.15.1</maven-plugin-plugin.version>
9394
<maven-resources-plugin.version>3.3.1</maven-resources-plugin.version>
9495
<maven-shade-plugin.version>3.6.0</maven-shade-plugin.version>
@@ -649,14 +650,14 @@
649650
<arg>-XDcompilePolicy=simple</arg>
650651
<arg>--should-stop=ifError=FLOW</arg>
651652
<arg>-Xplugin:ErrorProne \
652-
-Xep:MissingCasesInEnumSwitch:OFF \
653-
-Xep:MissingOverride:ERROR \
654-
-Xep:MissingSummary:OFF \
655-
-Xep:NonOverridingEquals:OFF \
656-
-Xep:OperatorPrecedence:OFF \
657-
-Xep:ReferenceEquality:OFF \
658-
-Xep:UnnecessaryParentheses:OFF \
659-
-XepExcludedPaths:.*/target/generated-(|test-)sources/.*</arg>
653+
-Xep:MissingCasesInEnumSwitch:OFF \
654+
-Xep:MissingOverride:ERROR \
655+
-Xep:MissingSummary:OFF \
656+
-Xep:NonOverridingEquals:OFF \
657+
-Xep:OperatorPrecedence:OFF \
658+
-Xep:ReferenceEquality:OFF \
659+
-Xep:UnnecessaryParentheses:OFF \
660+
-XepExcludedPaths:.*/target/generated-(|test-)sources/.*</arg>
660661
</compilerArgs>
661662
<annotationProcessorPaths>
662663
<path>
@@ -713,28 +714,6 @@
713714
</executions>
714715
</plugin>
715716

716-
<plugin>
717-
<groupId>org.apache.maven.plugins</groupId>
718-
<artifactId>maven-javadoc-plugin</artifactId>
719-
<version>${maven-javadoc-plugin.version}</version>
720-
<configuration>
721-
<doclint>none</doclint>
722-
<source>11</source>
723-
</configuration>
724-
<executions>
725-
<execution>
726-
<id>attach-javadocs</id>
727-
<goals>
728-
<goal>jar</goal>
729-
</goals>
730-
<configuration>
731-
<doclint>all,-missing</doclint>
732-
<release>${maven.compiler.release}</release>
733-
</configuration>
734-
</execution>
735-
</executions>
736-
</plugin>
737-
738717
<plugin>
739718
<groupId>org.apache.maven.plugins</groupId>
740719
<artifactId>maven-source-plugin</artifactId>
@@ -763,6 +742,89 @@
763742
</build>
764743

765744
<profiles>
745+
746+
<profile>
747+
<id>package-prebuilt-javadoc</id>
748+
<activation>
749+
<file>
750+
<exists>${project.basedir}/src/main/javadoc/README.md</exists>
751+
</file>
752+
</activation>
753+
<build>
754+
<plugins>
755+
756+
<plugin>
757+
<groupId>org.apache.maven.plugins</groupId>
758+
<artifactId>maven-jar-plugin</artifactId>
759+
<version>${maven-jar-plugin.version}</version>
760+
<executions>
761+
<execution>
762+
<id>fake-javadoc-jar</id>
763+
<goals>
764+
<goal>jar</goal>
765+
</goals>
766+
<phase>package</phase>
767+
<configuration>
768+
<classifier>javadoc</classifier>
769+
<includes>
770+
<include>${project.basedir}/src/main/javadoc/README.md</include>
771+
</includes>
772+
<archive>
773+
<manifest>
774+
<addDefaultImplementationEntries>true</addDefaultImplementationEntries>
775+
</manifest>
776+
</archive>
777+
</configuration>
778+
</execution>
779+
</executions>
780+
</plugin>
781+
782+
<plugin>
783+
<groupId>org.apache.maven.plugins</groupId>
784+
<artifactId>maven-javadoc-plugin</artifactId>
785+
<version>${maven-javadoc-plugin.version}</version>
786+
<configuration>
787+
<skip>true</skip>
788+
</configuration>
789+
</plugin>
790+
</plugins>
791+
</build>
792+
</profile>
793+
<profile>
794+
<id>package-standard-javadocs</id>
795+
<activation>
796+
<file>
797+
<missing>${project.basedir}/src/main/javadoc/javadoc.jar</missing>
798+
</file>
799+
</activation>
800+
<build>
801+
<plugins>
802+
<plugin>
803+
<groupId>org.apache.maven.plugins</groupId>
804+
<artifactId>maven-javadoc-plugin</artifactId>
805+
<version>${maven-javadoc-plugin.version}</version>
806+
<configuration>
807+
<!--<doclint>none</doclint>-->
808+
<doclint>all,-missing</doclint>
809+
<source>11</source>
810+
<release>${maven.compiler.release}</release>
811+
<sourceFileExcludes>
812+
<sourceFileExclude>**/internal/**</sourceFileExclude>
813+
</sourceFileExcludes>
814+
</configuration>
815+
<executions>
816+
<execution>
817+
<id>attach-javadocs</id>
818+
<goals>
819+
<goal>jar</goal>
820+
</goals>
821+
</execution>
822+
</executions>
823+
</plugin>
824+
</plugins>
825+
</build>
826+
</profile>
827+
766828
<profile>
767829
<!-- Disable strict checks during development -->
768830
<id>dev</id>

‎runtime-tests/src/main/javadoc/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Notice: Private API
2+
3+
This module contains the private API. It is not intended for public use and it's classes
4+
are subject to change without notice.

0 commit comments

Comments
 (0)