Skip to content

Commit 757b9b2

Browse files
bitwisemanbitwiseman
committed
Add JavaDocs
Do using IntelliJ JavaDocs plugin. Better to have something than nothing.
1 parent f6a0155 commit 757b9b2

125 files changed

Lines changed: 7379 additions & 251 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎src/main/java/org/kohsuke/github/AbuseLimitHandler.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
* Pluggable strategy to determine what to do when the API abuse limit is hit.
99
*
1010
* @author Kohsuke Kawaguchi
11-
* @see GitHubBuilder#withAbuseLimitHandler(AbuseLimitHandler)
11+
* @see GitHubBuilder#withAbuseLimitHandler(AbuseLimitHandler) GitHubBuilder#withAbuseLimitHandler(AbuseLimitHandler)
1212
* @see <a href="https://developer.github.com/v3/#abuse-rate-limits">documentation</a>
1313
* @see RateLimitHandler
1414
*/
@@ -21,14 +21,14 @@ public abstract class AbuseLimitHandler {
2121
* an exception. If this method returns normally, another request will be attempted. For that to make sense, the
2222
* implementation needs to wait for some time.
2323
*
24-
* @see <a href="https://developer.github.com/v3/#abuse-rate-limits">API documentation from GitHub</a>
2524
* @param e
2625
* Exception from Java I/O layer. If you decide to fail the processing, you can throw this exception (or
2726
* wrap this exception into another exception and throw it).
2827
* @param uc
2928
* Connection that resulted in an error. Useful for accessing other response headers.
3029
* @throws IOException
3130
* on failure
31+
* @see <a href="https://developer.github.com/v3/#abuse-rate-limits">API documentation from GitHub</a>
3232
*/
3333
public abstract void onError(IOException e, HttpURLConnection uc) throws IOException;
3434

‎src/main/java/org/kohsuke/github/GHApp.java‎

Lines changed: 78 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,8 @@
1313
* A Github App.
1414
*
1515
* @author Paulo Miguel Almeida
16-
*
17-
* @see GitHub#getApp()
16+
* @see GitHub#getApp() GitHub#getApp()
1817
*/
19-
2018
public class GHApp extends GHObject {
2119

2220
private GitHub root;
@@ -32,50 +30,116 @@ public class GHApp extends GHObject {
3230
@JsonProperty("html_url")
3331
private String htmlUrl;
3432

33+
/**
34+
* Gets owner.
35+
*
36+
* @return the owner
37+
*/
3538
public GHUser getOwner() {
3639
return owner;
3740
}
3841

42+
/**
43+
* Sets owner.
44+
*
45+
* @param owner
46+
* the owner
47+
*/
3948
public void setOwner(GHUser owner) {
4049
this.owner = owner;
4150
}
4251

52+
/**
53+
* Gets name.
54+
*
55+
* @return the name
56+
*/
4357
public String getName() {
4458
return name;
4559
}
4660

61+
/**
62+
* Sets name.
63+
*
64+
* @param name
65+
* the name
66+
*/
4767
public void setName(String name) {
4868
this.name = name;
4969
}
5070

71+
/**
72+
* Gets description.
73+
*
74+
* @return the description
75+
*/
5176
public String getDescription() {
5277
return description;
5378
}
5479

80+
/**
81+
* Sets description.
82+
*
83+
* @param description
84+
* the description
85+
*/
5586
public void setDescription(String description) {
5687
this.description = description;
5788
}
5889

90+
/**
91+
* Gets external url.
92+
*
93+
* @return the external url
94+
*/
5995
public String getExternalUrl() {
6096
return externalUrl;
6197
}
6298

99+
/**
100+
* Sets external url.
101+
*
102+
* @param externalUrl
103+
* the external url
104+
*/
63105
public void setExternalUrl(String externalUrl) {
64106
this.externalUrl = externalUrl;
65107
}
66108

109+
/**
110+
* Gets events.
111+
*
112+
* @return the events
113+
*/
67114
public List<GHEvent> getEvents() {
68115
return events;
69116
}
70117

118+
/**
119+
* Sets events.
120+
*
121+
* @param events
122+
* the events
123+
*/
71124
public void setEvents(List<GHEvent> events) {
72125
this.events = events;
73126
}
74127

128+
/**
129+
* Gets installations count.
130+
*
131+
* @return the installations count
132+
*/
75133
public long getInstallationsCount() {
76134
return installationsCount;
77135
}
78136

137+
/**
138+
* Sets installations count.
139+
*
140+
* @param installationsCount
141+
* the installations count
142+
*/
79143
public void setInstallationsCount(long installationsCount) {
80144
this.installationsCount = installationsCount;
81145
}
@@ -84,10 +148,21 @@ public URL getHtmlUrl() {
84148
return GitHub.parseURL(htmlUrl);
85149
}
86150

151+
/**
152+
* Gets permissions.
153+
*
154+
* @return the permissions
155+
*/
87156
public Map<String, String> getPermissions() {
88157
return permissions;
89158
}
90159

160+
/**
161+
* Sets permissions.
162+
*
163+
* @param permissions
164+
* the permissions
165+
*/
91166
public void setPermissions(Map<String, String> permissions) {
92167
this.permissions = permissions;
93168
}

‎src/main/java/org/kohsuke/github/GHAppCreateTokenBuilder.java‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@
1010
* Creates a access token for a GitHub App Installation
1111
*
1212
* @author Paulo Miguel Almeida
13-
*
14-
* @see GHAppInstallation#createToken(Map)
13+
* @see GHAppInstallation#createToken(Map) GHAppInstallation#createToken(Map)
1514
*/
1615
public class GHAppCreateTokenBuilder {
1716
private final GitHub root;
@@ -34,7 +33,6 @@ public class GHAppCreateTokenBuilder {
3433
*
3534
* @param repositoryIds
3635
* Array containing the repositories Ids
37-
*
3836
* @return a GHAppCreateTokenBuilder
3937
*/
4038
@Preview
@@ -46,9 +44,9 @@ public GHAppCreateTokenBuilder repositoryIds(List<Long> repositoryIds) {
4644

4745
/**
4846
* Creates an app token with all the parameters.
49-
*
47+
* <p>
5048
* You must use a JWT to access this endpoint.
51-
*
49+
*
5250
* @return a GHAppInstallationToken
5351
* @throws IOException
5452
* on error

0 commit comments

Comments
 (0)