Skip to content

Commit 79c4646

Browse files
Document UpdateChecker
1 parent 03f4de3 commit 79c4646

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

src/main/java/parallelmc/parallelutils/versionchecker/UpdateChecker.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@
1212
import java.util.regex.Matcher;
1313
import java.util.regex.Pattern;
1414

15+
/**
16+
* This class handles checking for updates and other update functionality
17+
*/
1518
public class UpdateChecker {
1619

1720
private final OkHttpClient client;
@@ -22,11 +25,19 @@ public class UpdateChecker {
2225

2326
private final String token;
2427

28+
/**
29+
* Create a new UpdateChecker with the given github personal access token
30+
* @param token The Github Personal Access Token to use
31+
*/
2532
public UpdateChecker(String token) {
2633
client = new OkHttpClient();
2734
this.token = token;
2835
}
2936

37+
/**
38+
* Retrieve the latest released version of ParallelUtils from Github
39+
* @return The latest version of ParallelUtils
40+
*/
3041
public Version getLatestVersion() {
3142
Request request = new Request.Builder()
3243
.url(GITHUB_URL)

0 commit comments

Comments
 (0)