From 06c3e645a72fed914b2e60cd30a1e96a595e64c3 Mon Sep 17 00:00:00 2001
From: Ben Donnelly <ben_donnelly@intergral.com>
Date: Mon, 26 Jun 2023 15:27:46 +0100
Subject: [PATCH] fix(docs): fix doc error

add doc check to PR
---
 .github/workflows/on_push.yml                   | 16 ++++++++++++++++
 deep/src/main/java/com/intergral/deep/Deep.java |  2 +-
 pom.xml                                         |  4 ++++
 3 files changed, 21 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/on_push.yml b/.github/workflows/on_push.yml
index 373c07a..2bee699 100644
--- a/.github/workflows/on_push.yml
+++ b/.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
+
diff --git a/deep/src/main/java/com/intergral/deep/Deep.java b/deep/src/main/java/com/intergral/deep/Deep.java
index de4391f..16dfe70 100644
--- a/deep/src/main/java/com/intergral/deep/Deep.java
+++ b/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 {
diff --git a/pom.xml b/pom.xml
index 797fe86..42da979 100644
--- a/pom.xml
+++ b/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>