Light Mode

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 03b11ac

Browse files
Merge pull request #72 from textkernel/fix-docs
fix javadoc errors and add javadocs build to CI build step
2 parents ace8aeb + e0c346a commit 03b11ac

File tree

12 files changed

+45
-12
lines changed
  • .github/workflows
    • build.yml
  • README.md
  • pom.xml
  • src/main/java/com/textkernel/tx
    • models/api/matchV2/querying
      • Options.java
      • SearchQuery.java
    • services
      • AccountService.java
      • FormatterService.java
      • GeocoderService.java
      • MatchV2Service.java
      • ParserService.java
      • SearchMatchService.java
      • SkillsIntelligenceService.java

12 files changed

+45
-12
lines changed

.github/workflows/build.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ jobs:
1818
java-version: 1.8
1919
- name: Build with Maven
2020
run: mvn -B compile --file pom.xml
21+
# generate the javadocs into the target/site/apidocs folder (default)
22+
- name: Generate javadocs with Maven
23+
run: mvn javadoc:javadoc
2124

2225
unit-tests:
2326
runs-on: ubuntu-latest

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The official Java SDK for the Textkernel Tx v10 API for resume/CV and job parsin
1313
### Gradle Users
1414
Add this dependency to your project's build file:
1515
```
16-
implementation "com.textkernel:tx-java:3.0.0"
16+
implementation "com.textkernel:tx-java:3.0.1"
1717
```
1818

1919
### Maven Users
@@ -22,13 +22,13 @@ Add this dependency to your project's POM:
2222
<dependency>
2323
<groupId>com.textkernelgroupId>
2424
<artifactId>tx-javaartifactId>
25-
<version>3.0.0version>
25+
<version>3.0.1version>
2626
dependency>
2727
```
2828

2929
### Others
3030
You'll need to manually install the following JARs:
31-
- The Textkernel Tx JAR from https://repo1.maven.org/maven2/com/textkernel/tx-java/3.0.0/tx-java-3.0.0.jar
31+
- The Textkernel Tx JAR from https://repo1.maven.org/maven2/com/textkernel/tx-java/3.0.1/tx-java-3.0.1.jar
3232
- [Google Gson][gson_url] from https://repo1.maven.org/maven2/com/google/code/gson/gson/2.9.0/gson-2.9.0.jar
3333
- [Square OkHttp][okhttp_url] from https://repo1.maven.org/maven2/com/squareup/okhttp3/okhttp/4.12.0/okhttp-4.12.0.jar
3434

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<groupId>com.textkernelgroupId>
55
<artifactId>tx-javaartifactId>
66

7-
<version>3.0.0version>
7+
<version>3.0.1version>
88

99
<packaging>jarpackaging>
1010
<name>Textkernel Tx Java SDKname>

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
package com.textkernel.tx.models.api.matchV2.querying;
77

8+
import com.textkernel.tx.models.api.matchV2.querying.results.SearchResult;
89
import java.util.List;
910

1011
/** Options for a Search or Match request */

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
import java.util.List;
99

1010
import com.textkernel.tx.models.api.matchV2.querying.results.QueryPart;
11+
import com.textkernel.tx.models.api.matchV2.querying.results.SearchResult;
1112

1213
/** A search query */
1314
public class SearchQuery {

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,11 @@
1717
/** See {@link TxClient#account()} */
1818
public class AccountService extends ServiceBase {
1919

20-
/** See {@link TxClient#account()} */
20+
/**
21+
* Do not use this. See {@link TxClient#account()}
22+
* @param httpClient The http client for API calls
23+
* @param settings environment settings
24+
*/
2125
public AccountService(OkHttpClient httpClient, EnvironmentSettings settings) {
2226
super(httpClient, settings);
2327
}

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,11 @@
1919
/** See {@link TxClient#formatter()} */
2020
public class FormatterService extends ServiceBase {
2121

22-
/** See {@link TxClient#formatter()} */
22+
/**
23+
* Do not use this. See {@link TxClient#formatter()}
24+
* @param httpClient The http client for API calls
25+
* @param settings environment settings
26+
*/
2327
public FormatterService(OkHttpClient httpClient, EnvironmentSettings settings) {
2428
super(httpClient, settings);
2529
}

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,11 @@
3535
/** See {@link TxClient#geocoder()} */
3636
public class GeocoderService extends ServiceBase {
3737

38-
/** See {@link TxClient#geocoder()} */
38+
/**
39+
* Do not use this. See {@link TxClient#geocoder()}
40+
* @param httpClient The http client for API calls
41+
* @param settings environment settings
42+
*/
3943
public GeocoderService(OkHttpClient httpClient, EnvironmentSettings settings) {
4044
super(httpClient, settings);
4145
}

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,11 @@
3636
/** See {@link TxClient#searchMatchV2()} */
3737
public class MatchV2Service extends ServiceBase {
3838

39-
/** See {@link TxClient#searchMatchV2()} */
39+
/**
40+
* Do not use this. See {@link TxClient#searchMatchV2()}
41+
* @param httpClient The http client for API calls
42+
* @param settings environment settings
43+
*/
4044
public MatchV2Service(OkHttpClient httpClient, EnvironmentSettings settings) {
4145
super(httpClient, settings);
4246
}
@@ -72,7 +76,7 @@ public AddCandidateResponse addCandidate(String documentId, ParsedResume resume,
7276
/**
7377
* Upload a job to the search and match V2 environment.
7478
* @param documentId The id to use for the document
75-
* @param resume Parsed output from the Textkernel Job Parser
79+
* @param job Parsed output from the Textkernel Job Parser
7680
* @param roles (optional) The roles associated with the request. Defaults to ["All"] if none are provided.
7781
* @param customFields (optional) A collection of custom fields represented as key-value pairs
7882
* @return The API response body

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,11 @@
2424
/** See {@link TxClient#parser()} */
2525
public class ParserService extends ServiceBase {
2626

27-
/** See {@link TxClient#parser()} */
27+
/**
28+
* Do not use this. See {@link TxClient#parser()}
29+
* @param httpClient The http client for API calls
30+
* @param settings environment settings
31+
*/
2832
public ParserService(OkHttpClient httpClient, EnvironmentSettings settings) {
2933
super(httpClient, settings);
3034
}

0 commit comments

Comments
(0)