docs tweaks

- move javadoc settings to be global, not just in the "release" profile - move cmake-configure out of the "generate-sources" phase, so it doesn't run during javadoc generation (yay faster iteration)
awslabs · Sep 11, 2024 · cf326f3 · cf326f3
1 parent 814357b
commit cf326f3
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 18 deletions.
diff --git a/make-docs.sh b/make-docs.sh
@@ -2,14 +2,15 @@
 
 set -e
 
-pushd $(dirname $0) >/dev/null
+pushd $(dirname $0) > /dev/null
 
 # clean
 rm -rf docs/
 
 # build
-mvn clean javadoc:javadoc -Prelease
-# mvn generates the doc in target/site/apidocs/ by default, move it to our common doc folder
+mvn javadoc:javadoc -Dmaven.javadoc.failOnWarnings=true
+
+# copy to docs/
 cp -r target/site/apidocs/ docs/
 
-popd >/dev/null
+popd > /dev/null
diff --git a/pom.xml b/pom.xml
@@ -162,7 +162,7 @@
                             <!-- cmake configure -->
                             <execution>
                                 <id>cmake-configure</id>
-                                <phase>generate-sources</phase>
+                                <phase>generate-resources</phase>
                                 <goals>
                                     <goal>exec</goal>
                                 </goals>
@@ -293,19 +293,6 @@
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-javadoc-plugin</artifactId>
                         <version>3.4.0</version>
-                        <configuration>
-                            <windowtitle>AWS Common Runtime for Java/JVM</windowtitle>
-                            <doctitle>AWS Common Runtime for Java/JVM</doctitle>
-                            <header>AWS Common Runtime for Java/JVM</header>
-                            <bottom>Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.</bottom>
-                            <show>public</show>
-                            <sourcepath>src/main/java</sourcepath>
-                            <notimestamp>true</notimestamp>
-                            <quiet>true</quiet>
-                            <doclint>all</doclint>
-                            <failOnWarnings>true</failOnWarnings>
-                            <excludePackageNames>software.amazon.awssdk.crt.internal</excludePackageNames>
-                        </configuration>
                         <executions>
                             <execution>
                                 <id>attach-javadocs</id>
@@ -504,6 +491,23 @@
                     <forkCount>0</forkCount>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>3.4.0</version>
+                <configuration>
+                    <windowtitle>AWS Common Runtime for Java/JVM</windowtitle>
+                    <doctitle>AWS Common Runtime for Java/JVM</doctitle>
+                    <header>AWS Common Runtime for Java/JVM</header>
+                    <bottom>Copyright © Amazon.com, Inc. or its affiliates. All Rights Reserved.</bottom>
+                    <show>public</show>
+                    <sourcepath>src/main/java</sourcepath>
+                    <notimestamp>true</notimestamp>
+                    <quiet>true</quiet>
+                    <doclint>all</doclint>
+                    <excludePackageNames>software.amazon.awssdk.crt.internal</excludePackageNames>
+                </configuration>
+            </plugin>
         </plugins>
     </build>
 </project>