Skip to content

Commit

Permalink
Remove package comments
Browse files Browse the repository at this point in the history
  • Loading branch information
bitwiseman committed Nov 13, 2019
1 parent 5f59737 commit a3b1262
Show file tree
Hide file tree
Showing 60 changed files with 121 additions and 121 deletions.
30 changes: 15 additions & 15 deletions src/main/java/org/kohsuke/github/GHApp.java
Original file line number Diff line number Diff line change
Expand Up @@ -92,18 +92,18 @@ public void setPermissions(Map<String, String> permissions) {
this.permissions = permissions;
}

/* package */ GHApp wrapUp(GitHub root) {
GHApp wrapUp(GitHub root) {
this.root = root;
return this;
}

/**
* Obtains all the installations associated with this app.
*
* <p>
* You must use a JWT to access this endpoint.
*
* @see <a href="https://developer.github.com/v3/apps/#list-installations">List installations</a>
* @return a list of App installations
* @see <a href="https://developer.github.com/v3/apps/#list-installations">List installations</a>
*/
@Preview
@Deprecated
Expand All @@ -113,15 +113,15 @@ public PagedIterable<GHAppInstallation> listInstallations() {
}

/**
* Obtain an installation associated with this app. You must use a JWT to access this endpoint.
* Obtain an installation associated with this app.
* <p>
* You must use a JWT to access this endpoint.
*
* @param id
* Installation Id
*
* @return a GHAppInstallation
* @throws IOException
* on error
*
* @see <a href="https://developer.github.com/v3/apps/#get-an-installation">Get an installation</a>
*/
@Preview
Expand All @@ -132,15 +132,15 @@ public GHAppInstallation getInstallationById(long id) throws IOException {
}

/**
* Obtain an organization installation associated with this app. You must use a JWT to access this endpoint.
* Obtain an organization installation associated with this app.
* <p>
* You must use a JWT to access this endpoint.
*
* @param name
* Organization name
*
* @return a GHAppInstallation
* @throws IOException
* on error
*
* @see <a href="https://developer.github.com/v3/apps/#get-an-organization-installation">Get an organization
* installation</a>
*/
Expand All @@ -152,17 +152,17 @@ public GHAppInstallation getInstallationByOrganization(String name) throws IOExc
}

/**
* Obtain an repository installation associated with this app You must use a JWT to access this endpoint.
* Obtain an repository installation associated with this app.
* <p>
* You must use a JWT to access this endpoint.
*
* @param ownerName
* Organization or user name
* @param repositoryName
* Repository name
*
* @return a GHAppInstallation
* @throws IOException
* on error
*
* @see <a href="https://developer.github.com/v3/apps/#get-a-repository-installation">Get a repository
* installation</a>
*/
Expand All @@ -175,15 +175,15 @@ public GHAppInstallation getInstallationByRepository(String ownerName, String re
}

/**
* Obtain a user installation associated with this app You must use a JWT to access this endpoint.
* Obtain a user installation associated with this app.
* <p>
* You must use a JWT to access this endpoint.
*
* @param name
* user name
*
* @return a GHAppInstallation
* @throws IOException
* on error
*
* @see <a href="https://developer.github.com/v3/apps/#get-a-user-installation">Get a user installation</a>
*/
@Preview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ public class GHAppCreateTokenBuilder {

@Preview
@Deprecated
/* package */ GHAppCreateTokenBuilder(GitHub root, String apiUrlTail, Map<String, GHPermissionType> permissions) {
GHAppCreateTokenBuilder(GitHub root, String apiUrlTail, Map<String, GHPermissionType> permissions) {
this.root = root;
this.apiUrlTail = apiUrlTail;
this.builder = new Requester(root);
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/kohsuke/github/GHAppInstallation.java
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ public void setRepositorySelection(GHRepositorySelection repositorySelection) {
this.repositorySelection = repositorySelection;
}

/* package */ GHAppInstallation wrapUp(GitHub root) {
GHAppInstallation wrapUp(GitHub root) {
this.root = root;
return this;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ private Object expiresAtStr(Date id, Class type) {
return expires_at;
}

/* package */ GHAppInstallationToken wrapUp(GitHub root) {
GHAppInstallationToken wrapUp(GitHub root) {
this.root = root;
return this;
}
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/kohsuke/github/GHAuthorization.java
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ public String getFingerprint() {
return fingerprint;
}

/* package */ GHAuthorization wrap(GitHub root) {
GHAuthorization wrap(GitHub root) {
this.root = root;
return this;
}
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/kohsuke/github/GHBranch.java
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ public String toString() {
return "Branch:" + name + " in " + url;
}

/* package */ GHBranch wrap(GHRepository repo) {
GHBranch wrap(GHRepository repo) {
this.owner = repo;
this.root = repo.root;
return this;
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/kohsuke/github/GHCommitQueryBuilder.java
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public class GHCommitQueryBuilder {
private final Requester req;
private final GHRepository repo;

/* package */ GHCommitQueryBuilder(GHRepository repo) {
GHCommitQueryBuilder(GHRepository repo) {
this.repo = repo;
this.req = repo.root.retrieve(); // requester to build up
}
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/kohsuke/github/GHCommitSearchBuilder.java
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
@Preview
@Deprecated
public class GHCommitSearchBuilder extends GHSearchBuilder<GHCommit> {
/* package */ GHCommitSearchBuilder(GitHub root) {
GHCommitSearchBuilder(GitHub root) {
super(root, CommitSearchResult.class);
req.withPreview(Previews.CLOAK);
}
Expand Down Expand Up @@ -108,7 +108,7 @@ private static class CommitSearchResult extends SearchResult<GHCommit> {
private GHCommit[] items;

@Override
/* package */ GHCommit[] getItems(GitHub root) {
GHCommit[] getItems(GitHub root) {
for (GHCommit commit : items) {
String repoName = getRepoName(commit.url);
try {
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/kohsuke/github/GHCommitStatus.java
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public class GHCommitStatus extends GHObject {

private GitHub root;

/* package */ GHCommitStatus wrapUp(GitHub root) {
GHCommitStatus wrapUp(GitHub root) {
if (creator != null)
creator.wrapUp(root);
this.root = root;
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/kohsuke/github/GHContentSearchBuilder.java
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
* @see GitHub#searchContent()
*/
public class GHContentSearchBuilder extends GHSearchBuilder<GHContent> {
/* package */ GHContentSearchBuilder(GitHub root) {
GHContentSearchBuilder(GitHub root) {
super(root, ContentSearchResult.class);
}

Expand Down Expand Up @@ -59,7 +59,7 @@ private static class ContentSearchResult extends SearchResult<GHContent> {
private GHContent[] items;

@Override
/* package */ GHContent[] getItems(GitHub root) {
GHContent[] getItems(GitHub root) {
for (GHContent item : items)
item.wrap(root);
return items;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public class GHCreateRepositoryBuilder {
protected final Requester builder;
private final String apiUrlTail;

/* package */ GHCreateRepositoryBuilder(GitHub root, String apiUrlTail, String name) {
GHCreateRepositoryBuilder(GitHub root, String apiUrlTail, String name) {
this.root = root;
this.apiUrlTail = apiUrlTail;
this.builder = new Requester(root);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public GHDeploymentStatusBuilder(GHRepository repo, int deploymentId, GHDeployme
this(repo, (long) deploymentId, state);
}

/* package */ GHDeploymentStatusBuilder(GHRepository repo, long deploymentId, GHDeploymentState state) {
GHDeploymentStatusBuilder(GHRepository repo, long deploymentId, GHDeploymentState state) {
this.repo = repo;
this.deploymentId = deploymentId;
this.builder = new Requester(repo.root);
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/kohsuke/github/GHEventInfo.java
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public GHEvent getType() {
return null; // unknown event type
}

/* package */ GHEventInfo wrapUp(GitHub root) {
GHEventInfo wrapUp(GitHub root) {
this.root = root;
return this;
}
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/kohsuke/github/GHEventPayload.java
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public abstract class GHEventPayload {

private GHUser sender;

/* package */ GHEventPayload() {
GHEventPayload() {
}

/**
Expand All @@ -35,7 +35,7 @@ public void setSender(GHUser sender) {
this.sender = sender;
}

/* package */ void wrapUp(GitHub root) {
void wrapUp(GitHub root) {
this.root = root;
if (sender != null) {
sender.wrapUp(root);
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/kohsuke/github/GHGist.java
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ public Map<String, GHGistFile> getFiles() {
return Collections.unmodifiableMap(files);
}

/* package */ GHGist wrapUp(GHUser owner) {
GHGist wrapUp(GHUser owner) {
this.owner = owner;
this.root = owner.root;
wrapUp();
Expand All @@ -104,7 +104,7 @@ public Map<String, GHGistFile> getFiles() {
* Used when caller obtains {@link GHGist} without knowing its owner. A partially constructed owner object is
* interned.
*/
/* package */ GHGist wrapUp(GitHub root) {
GHGist wrapUp(GitHub root) {
this.owner = root.getUser(owner);
this.root = root;
wrapUp();
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/kohsuke/github/GHInvitation.java
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ public class GHInvitation extends GHObject {
private String permissions;
private String html_url;

/* package */ GHInvitation wrapUp(GitHub root) {
GHInvitation wrapUp(GitHub root) {
this.root = root;
return this;
}
Expand Down
6 changes: 3 additions & 3 deletions src/main/java/org/kohsuke/github/GHIssue.java
Original file line number Diff line number Diff line change
Expand Up @@ -79,14 +79,14 @@ public class GHIssue extends GHObject implements Reactable {
public static class Label extends GHLabel {
}

/* package */ GHIssue wrap(GHRepository owner) {
GHIssue wrap(GHRepository owner) {
this.owner = owner;
if (milestone != null)
milestone.wrap(owner);
return wrap(owner.root);
}

/* package */ GHIssue wrap(GitHub root) {
GHIssue wrap(GitHub root) {
this.root = root;
if (assignee != null)
assignee.wrapUp(root);
Expand All @@ -99,7 +99,7 @@ public static class Label extends GHLabel {
return this;
}

/* package */ static GHIssue[] wrap(GHIssue[] issues, GHRepository owner) {
static GHIssue[] wrap(GHIssue[] issues, GHRepository owner) {
for (GHIssue i : issues)
i.wrap(owner);
return issues;
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/kohsuke/github/GHIssueComment.java
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public class GHIssueComment extends GHObject implements Reactable {
private String body, gravatar_id, html_url, author_association;
private GHUser user; // not fully populated. beware.

/* package */ GHIssueComment wrapUp(GHIssue owner) {
GHIssueComment wrapUp(GHIssue owner) {
this.owner = owner;
return this;
}
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/kohsuke/github/GHIssueSearchBuilder.java
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
* @see GitHub#searchIssues()
*/
public class GHIssueSearchBuilder extends GHSearchBuilder<GHIssue> {
/* package */ GHIssueSearchBuilder(GitHub root) {
GHIssueSearchBuilder(GitHub root) {
super(root, IssueSearchResult.class);
}

Expand Down Expand Up @@ -57,7 +57,7 @@ private static class IssueSearchResult extends SearchResult<GHIssue> {
private GHIssue[] items;

@Override
/* package */ GHIssue[] getItems(GitHub root) {
GHIssue[] getItems(GitHub root) {
for (GHIssue i : items)
i.wrap(root);
return items;
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/kohsuke/github/GHKey.java
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public boolean isVerified() {
return verified;
}

/* package */ GHKey wrap(GitHub root) {
GHKey wrap(GitHub root) {
this.root = root;
return this;
}
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/kohsuke/github/GHLabel.java
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public String getDescription() {
return description;
}

/* package */ GHLabel wrapUp(GHRepository repo) {
GHLabel wrapUp(GHRepository repo) {
this.repo = repo;
return this;
}
Expand Down Expand Up @@ -70,7 +70,7 @@ public void setDescription(String newDescription) throws IOException {
.with("description", newDescription).to(url);
}

/* package */ static Collection<String> toNames(Collection<GHLabel> labels) {
static Collection<String> toNames(Collection<GHLabel> labels) {
List<String> r = new ArrayList<String>();
for (GHLabel l : labels) {
r.add(l.getName());
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/kohsuke/github/GHLicense.java
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ public int hashCode() {
return url.hashCode();
}

/* package */ GHLicense wrap(GitHub root) {
GHLicense wrap(GitHub root) {
this.root = root;
return this;
}
Expand Down
4 changes: 2 additions & 2 deletions src/main/java/org/kohsuke/github/GHMembership.java
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ public void activate() throws IOException {
root.retrieve().method("PATCH").with("state", State.ACTIVE).to(url, this);
}

/* package */ GHMembership wrap(GitHub root) {
GHMembership wrap(GitHub root) {
this.root = root;
if (user != null)
user = root.getUser(user.wrapUp(root));
Expand All @@ -57,7 +57,7 @@ public void activate() throws IOException {
return this;
}

/* package */ static void wrap(GHMembership[] page, GitHub root) {
static void wrap(GHMembership[] page, GitHub root) {
for (GHMembership m : page)
m.wrap(root);
}
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/kohsuke/github/GHNotificationStream.java
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public class GHNotificationStream implements Iterable<GHThread> {
private String apiUrl;
private boolean nonBlocking = false;

/* package */ GHNotificationStream(GitHub root, String apiUrl) {
GHNotificationStream(GitHub root, String apiUrl) {
this.root = root;
this.apiUrl = apiUrl;
}
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/kohsuke/github/GHObject.java
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public abstract class GHObject {
protected String created_at;
protected String updated_at;

/* package */ GHObject() {
GHObject() {
}

/**
Expand Down
Loading

0 comments on commit a3b1262

Please sign in to comment.