Merge pull request #15 from morganstanley/upload-docs

Include Javadocs in the uploaded build artifacts

Author: pantherdd

.github/workflows/push.yaml

@@ -35,5 +35,6 @@ jobs:
         with:
           name: build-artifacts
           path: |
+            build/docs/
             build/libs/
             build/reports/

.github/workflows/release.yaml

@@ -37,6 +37,7 @@ jobs:
         with:
           name: build-artifacts
           path: |
+            build/docs/
             build/libs/
             build/reports/
             build/local-publish/

src/main/java/com/ms/gradle/application/ApplicationJar.java

@@ -227,7 +227,7 @@ protected void configureArchiveDefaults() {
         //  - Leave the default `archiveFileName` pattern intact
         //  - Keep the defaults for `archiveAppendix`, `archiveVersion`, `archiveClassifier` and `archiveExtension`
         //  - Override the default value of `archiveBaseName` if we can set something that is meaningful and unique
-        //    (e.g. in our `Bound` subclass), leave it untouched otherwise
+        //    (e.g. in our `Bound` subclass), but leave it untouched otherwise
     }
 
     /**

src/main/java/com/ms/gradle/application/ApplicationName.java

@@ -13,6 +13,10 @@
  */
 @SuppressWarnings("PMD.ConstantsInInterface") // This approach is consistent with the rest of Gradle
 public interface ApplicationName extends Named {
+
+    /**
+     * The {@link Attribute} instance to be used as the key for {@link ApplicationName} values.
+     */
     Attribute<ApplicationName> APPLICATION_NAME_ATTRIBUTE =
             Attribute.of("com.ms.gradle.application.name", ApplicationName.class);
 }