Skip to content

adds doc for public constructors to fix sonar issues #1012

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 23, 2024
Merged

adds doc for public constructors to fix sonar issues #1012

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions application/src/main/java/org/togetherjava/tjbot/commands/github/GitHubCommand.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,16 @@ public final class GitHubCommand extends SlashCommandAdapter {
private Instant lastCacheUpdate;
private List<String> autocompleteGHIssueCache;

/**
* Constructs an instance of GitHubCommand.
*
* This constructor initializes a new GitHubCommand with the specified GitHubReference. It also
* sets the command name to "github-search" and the command description to "Search configured
* GitHub repositories for an issue/pull request".
*
* @param reference The GitHubReference used for searching issue/pull request in configured
* repositories.
*/
public GitHubCommand(GitHubReference reference) {
super("github-search", "Search configured GitHub repositories for an issue/pull request",
CommandVisibility.GUILD);
Expand Down
8 changes: 8 additions & 0 deletions application/src/main/java/org/togetherjava/tjbot/commands/github/GitHubReference.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,14 @@ public final class GitHubReference extends MessageReceiverAdapter {
*/
private List<GHRepository> repositories;

/**
* Constructs an instance of GitHubReference.
*
* This constructor initializes a new GitHubReference with the specified Config. It also sets up
* a predicate for matching allowed channels for feature and acquires repositories.
*
* @param config The Config to get allowed channel pattern for feature.
*/
public GitHubReference(Config config) {
this.config = config;
this.hasGithubIssueReferenceEnabled =
Expand Down