Skip to content

Commit ad30a01

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 Signed-off-by: Hiram Chirino <hiram@hiramchirino.com>
1 parent 3a2fa87 commit ad30a01

6 files changed

Lines changed: 99 additions & 22 deletions

File tree

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@
105105
<version>2.1.1</version>
106106
<configuration>
107107
<flags>-Xmx1G</flags>
108+
<inputFile>${project.build.directory}/${project.build.finalName}.jar</inputFile>
108109
<programFile>chicory-compiler</programFile>
109110
<attachProgramFile>true</attachProgramFile>
110111
</configuration>

‎build-time-compiler-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.

‎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.

‎compiler-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.

‎pom.xml‎

Lines changed: 85 additions & 22 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>
@@ -720,28 +721,6 @@
720721
</executions>
721722
</plugin>
722723

723-
<plugin>
724-
<groupId>org.apache.maven.plugins</groupId>
725-
<artifactId>maven-javadoc-plugin</artifactId>
726-
<version>${maven-javadoc-plugin.version}</version>
727-
<configuration>
728-
<doclint>none</doclint>
729-
<source>11</source>
730-
</configuration>
731-
<executions>
732-
<execution>
733-
<id>attach-javadocs</id>
734-
<goals>
735-
<goal>jar</goal>
736-
</goals>
737-
<configuration>
738-
<doclint>all,-missing</doclint>
739-
<release>${maven.compiler.release}</release>
740-
</configuration>
741-
</execution>
742-
</executions>
743-
</plugin>
744-
745724
<plugin>
746725
<groupId>org.apache.maven.plugins</groupId>
747726
<artifactId>maven-source-plugin</artifactId>
@@ -770,6 +749,90 @@
770749
</build>
771750

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

0 commit comments

Comments
 (0)