fix javadoc errors and add javadocs build to CI build step

Author: JW Wesson

.github/workflows/build.yml

@@ -18,6 +18,9 @@ jobs:
         java-version: 1.8
     - name: Build with Maven
       run: mvn -B compile --file pom.xml
+    # generate the javadocs into the target/site/apidocs folder (default)
+    - name: Generate javadocs with Maven
+      run: mvn javadoc:javadoc
 
   unit-tests:
     runs-on: ubuntu-latest

src/main/java/com/textkernel/tx/models/api/matchV2/querying/Options.java

@@ -5,6 +5,7 @@
 
 package com.textkernel.tx.models.api.matchV2.querying;
 
+import com.textkernel.tx.models.api.matchV2.querying.results.SearchResult;
 import java.util.List;
 
 /** Options for a Search or Match request */

src/main/java/com/textkernel/tx/models/api/matchV2/querying/SearchQuery.java

@@ -8,6 +8,7 @@
 import java.util.List;
 
 import com.textkernel.tx.models.api.matchV2.querying.results.QueryPart;
+import com.textkernel.tx.models.api.matchV2.querying.results.SearchResult;
 
 /** A search query */
 public class SearchQuery {

src/main/java/com/textkernel/tx/services/AccountService.java

@@ -17,7 +17,11 @@
 /** See {@link TxClient#account()} */
 public class AccountService extends ServiceBase {
 
-    /** See {@link TxClient#account()} */
+    /**
+     * Do not use this. See {@link TxClient#account()}
+     * @param httpClient The http client for API calls
+     * @param settings environment settings
+     */
     public AccountService(OkHttpClient httpClient, EnvironmentSettings settings) {
         super(httpClient, settings);
     }

src/main/java/com/textkernel/tx/services/FormatterService.java

@@ -19,7 +19,11 @@
 /** See {@link TxClient#formatter()} */
 public class FormatterService extends ServiceBase {
 
-    /** See {@link TxClient#formatter()} */
+    /**
+     * Do not use this. See {@link TxClient#formatter()}
+     * @param httpClient The http client for API calls
+     * @param settings environment settings
+     */
     public FormatterService(OkHttpClient httpClient, EnvironmentSettings settings) {
         super(httpClient, settings);
     }

src/main/java/com/textkernel/tx/services/GeocoderService.java

@@ -35,7 +35,11 @@
 /** See {@link TxClient#geocoder()} */
 public class GeocoderService extends ServiceBase {
 
-    /** See {@link TxClient#geocoder()} */
+    /**
+     * Do not use this. See {@link TxClient#geocoder()}
+     * @param httpClient The http client for API calls
+     * @param settings environment settings
+     */
     public GeocoderService(OkHttpClient httpClient, EnvironmentSettings settings) {
         super(httpClient, settings);
     }

src/main/java/com/textkernel/tx/services/MatchV2Service.java

@@ -36,7 +36,11 @@
 /** See {@link TxClient#searchMatchV2()} */
 public class MatchV2Service extends ServiceBase {
 
-    /** See {@link TxClient#searchMatchV2()} */
+    /**
+     * Do not use this. See {@link TxClient#searchMatchV2()}
+     * @param httpClient The http client for API calls
+     * @param settings environment settings
+     */
     public MatchV2Service(OkHttpClient httpClient, EnvironmentSettings settings) {
         super(httpClient, settings);
     }
@@ -72,7 +76,7 @@ public AddCandidateResponse addCandidate(String documentId, ParsedResume resume,
     /**
      * Upload a job to the search and match V2 environment.
      * @param documentId The id to use for the document
-     * @param resume Parsed output from the Textkernel Job Parser
+     * @param job Parsed output from the Textkernel Job Parser
      * @param roles (optional) The roles associated with the request. Defaults to <code>["All"]</code> if none are provided.
      * @param customFields (optional) A collection of custom fields represented as key-value pairs
      * @return The API response body

src/main/java/com/textkernel/tx/services/ParserService.java

@@ -24,7 +24,11 @@
 /** See {@link TxClient#parser()} */
 public class ParserService extends ServiceBase {
 
-    /** See {@link TxClient#parser()} */
+    /**
+     * Do not use this. See {@link TxClient#parser()}
+     * @param httpClient The http client for API calls
+     * @param settings environment settings
+     */
     public ParserService(OkHttpClient httpClient, EnvironmentSettings settings) {
         super(httpClient, settings);
     }

src/main/java/com/textkernel/tx/services/SearchMatchService.java

@@ -58,7 +58,11 @@
 /** See {@link TxClient#searchMatchV1()} */
 public class SearchMatchService extends ServiceBase {
 
-    /** See {@link TxClient#searchMatchV1()} */
+    /**
+     * Do not use this. See {@link TxClient#searchMatchV1()}
+     * @param httpClient The http client for API calls
+     * @param settings environment settings
+     */
     public SearchMatchService(OkHttpClient httpClient, EnvironmentSettings settings) {
         super(httpClient, settings);
     }

src/main/java/com/textkernel/tx/services/SkillsIntelligenceService.java

@@ -64,7 +64,11 @@
 /** See {@link TxClient#skillsIntelligence()} */
 public class SkillsIntelligenceService extends ServiceBase {
 
-    /** See {@link TxClient#skillsIntelligence()} */
+    /**
+     * Do not use this. See {@link TxClient#skillsIntelligence()}
+     * @param httpClient The http client for API calls
+     * @param settings environment settings
+     */
     public SkillsIntelligenceService(OkHttpClient httpClient, EnvironmentSettings settings) {
         super(httpClient, settings);
     }