add scaladoc generation to CI and fix issues

Dwolla · Oct 18, 2021 · ff8abd8 · ff8abd8
1 parent 311a79c
commit ff8abd8
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 5 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -43,12 +43,22 @@ jobs:
             ~/Library/Caches/Coursier/v1
           key: ${{ runner.os }}-sbt-cache-v2-${{ hashFiles('**/*.sbt') }}-${{ hashFiles('project/build.properties') }}
 
+      - name: Build and test project
+        run: sbt "tests_${{ matrix.cats-effect }}${{ matrix.scala }} / test"
+
       - name: Check unused and undeclared dependencies
         run: |
-          sbt undeclaredCompileDependenciesTest unusedCompileDependenciesTest
+          sbt \
+            "fs2-pgp_${{ matrix.cats-effect }}${{ matrix.scala }} / undeclaredCompileDependenciesTest" \
+            "fs2-pgp_${{ matrix.cats-effect }}${{ matrix.scala }} / unusedCompileDependenciesTest" \
+            "pgp-testkit_${{ matrix.cats-effect }}${{ matrix.scala }} / undeclaredCompileDependenciesTest" \
+            "pgp-testkit_${{ matrix.cats-effect }}${{ matrix.scala }} / unusedCompileDependenciesTest"
 
-      - name: Build and test project
-        run: sbt "tests_${{ matrix.cats-effect }}${{ matrix.scala }} / test"
+      - name: Generate scaladoc
+        run: |
+          sbt \
+            "fs2-pgp_${{ matrix.cats-effect }}${{ matrix.scala }} / doc" \
+            "pgp-testkit_${{ matrix.cats-effect }}${{ matrix.scala }} / doc"
 
       - name: Compress target directories
         run: |

diff --git a/core/src/main/scala-ce2/com/dwolla/security/crypto/BouncyCastleResource.scala b/core/src/main/scala-ce2/com/dwolla/security/crypto/BouncyCastleResource.scala
@@ -16,7 +16,7 @@ object BouncyCastleResource {
       val previousCount = timesBouncyCastleHasBeenRegistered.getAndIncrement()
       val position = Security.addProvider(provider)
 
-      /**
+      /*
        * If BouncyCastle was already registered (as indicated by the returned
        * position being -1) but we didn't register it (as indicated
        * by the previous count being 0, then increment the counter so we

diff --git a/core/src/main/scala-ce3/com/dwolla/security/crypto/BouncyCastleResource.scala b/core/src/main/scala-ce3/com/dwolla/security/crypto/BouncyCastleResource.scala
@@ -16,7 +16,7 @@ object BouncyCastleResource {
       val previousCount = timesBouncyCastleHasBeenRegistered.getAndIncrement()
       val position = Security.addProvider(provider)
 
-      /**
+      /*
        * If BouncyCastle was already registered (as indicated by the returned
        * position being -1) but we didn't register it (as indicated
        * by the previous count being 0, then increment the counter so we