Merge pull request #4 from intergral/doc_build

fix(docs): fix doc error

Author: Umaaz

.github/workflows/on_push.yml

@@ -54,3 +54,19 @@ jobs:
           cache: 'maven'
       - name: Run PMD check
         run: mvn -U -B verify -Ppmd
+
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+          cache: 'maven'
+      - name: Run docs check
+        run: mvn -s .ci-settings.xml clean package javadoc:jar -DskipTests -P release-ossrh -B -U -pl agent,deep --also-make
+

deep/src/main/java/com/intergral/deep/Deep.java

@@ -34,7 +34,7 @@
  * <p>
  * To use a deep API use
  * <code>
- * Deep.getInstance().<IDeep>api()
+ * Deep.getInstance().&lt;IDeep&gt;api()
  * </code>
  */
 public class Deep {

pom.xml

@@ -191,6 +191,10 @@
                     <plugin>
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-javadoc-plugin</artifactId>
+                        <configuration>
+                            <!--force the java doc to use java 8-->
+                            <source>8</source>
+                        </configuration>
                         <executions>
                             <execution>
                                 <id>attach-javadocs</id>