Skip to content

Commit a09587b

Browse files
bitwisemanbitwiseman
committed
Fix test javadocs
1 parent e2d129e commit a09587b

File tree

73 files changed

+2362
-702
lines changed

Some content is hidden

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

73 files changed

+2362
-702
lines changed

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

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

99
import javax.annotation.Nonnull;
1010

11+
// TODO: Auto-generated Javadoc
1112
/**
1213
* Pluggable strategy to determine what to do when the API abuse limit is hit.
1314
*

‎src/test/java/org/kohsuke/HookApp.java‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,14 @@
1616
* @author Kohsuke Kawaguchi
1717
*/
1818
public class HookApp {
19-
19+
2020
/**
2121
* The main method.
2222
*
23-
* @param args the arguments
24-
* @throws Exception the exception
23+
* @param args
24+
* the arguments
25+
* @throws Exception
26+
* the exception
2527
*/
2628
public static void main(String[] args) throws Exception {
2729
// GitHub.connect().getMyself().getRepository("sandbox").createWebHook(
@@ -34,8 +36,10 @@ public static void main(String[] args) throws Exception {
3436
/**
3537
* Do index.
3638
*
37-
* @param req the req
38-
* @throws IOException Signals that an I/O exception has occurred.
39+
* @param req
40+
* the req
41+
* @throws IOException
42+
* Signals that an I/O exception has occurred.
3943
*/
4044
public void doIndex(StaplerRequest req) throws IOException {
4145
String str = req.getParameter("payload");

‎src/test/java/org/kohsuke/github/AbstractGHAppInstallationTest.java‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ public class AbstractGHAppInstallationTest extends AbstractGitHubWireMockTest {
3333

3434
/** The jwt provider 1. */
3535
protected final AuthorizationProvider jwtProvider1;
36-
36+
3737
/** The jwt provider 2. */
3838
protected final AuthorizationProvider jwtProvider2;
39-
39+
4040
/** The jwt provider 3. */
4141
protected final AuthorizationProvider jwtProvider3;
4242

@@ -82,9 +82,11 @@ private String createJwtToken(String keyFileResouceName, String appId) {
8282
/**
8383
* Gets the app installation with token.
8484
*
85-
* @param jwtToken the jwt token
85+
* @param jwtToken
86+
* the jwt token
8687
* @return the app installation with token
87-
* @throws IOException Signals that an I/O exception has occurred.
88+
* @throws IOException
89+
* Signals that an I/O exception has occurred.
8890
*/
8991
protected GHAppInstallation getAppInstallationWithToken(String jwtToken) throws IOException {
9092
GitHub gitHub = getGitHubBuilder().withJwtToken(jwtToken)

‎src/test/java/org/kohsuke/github/AbstractGitHubWireMockTest.java‎

Lines changed: 38 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public abstract class AbstractGitHubWireMockTest {
3939

4040
/** The Constant STUBBED_USER_LOGIN. */
4141
final static String STUBBED_USER_LOGIN = "placeholder-user";
42-
42+
4343
/** The Constant STUBBED_USER_PASSWORD. */
4444
final static String STUBBED_USER_PASSWORD = "placeholder-password";
4545

@@ -58,7 +58,7 @@ public abstract class AbstractGitHubWireMockTest {
5858

5959
/** The base files class path. */
6060
protected final String baseFilesClassPath = this.getClass().getName().replace('.', '/');
61-
61+
6262
/** The base record path. */
6363
protected final String baseRecordPath = "src/test/resources/" + baseFilesClassPath + "/wiremock";
6464

@@ -136,7 +136,8 @@ protected GitHubBuilder getGitHubBuilder() {
136136
/**
137137
* Wire mock setup.
138138
*
139-
* @throws Exception the exception
139+
* @throws Exception
140+
* the exception
140141
*/
141142
@Before
142143
public void wireMockSetup() throws Exception {
@@ -164,7 +165,8 @@ protected void snapshotNotAllowed() {
164165
/**
165166
* Require proxy.
166167
*
167-
* @param reason the reason
168+
* @param reason
169+
* the reason
168170
*/
169171
protected void requireProxy(String reason) {
170172
assumeTrue("Test only valid when proxying (-Dtest.github.useProxy to enable): " + reason,
@@ -174,7 +176,8 @@ protected void requireProxy(String reason) {
174176
/**
175177
* Verify authenticated.
176178
*
177-
* @param instance the instance
179+
* @param instance
180+
* the instance
178181
*/
179182
protected void verifyAuthenticated(GitHub instance) {
180183
assertThat(
@@ -195,7 +198,8 @@ protected GHUser getUser() {
195198
/**
196199
* Gets the user.
197200
*
198-
* @param gitHub the git hub
201+
* @param gitHub
202+
* the git hub
199203
* @return the user
200204
*/
201205
protected static GHUser getUser(GitHub gitHub) {
@@ -255,7 +259,8 @@ protected GHRepository getTempRepository(String name) throws IOException {
255259
/**
256260
* Cleanup temp repositories.
257261
*
258-
* @throws IOException Signals that an I/O exception has occurred.
262+
* @throws IOException
263+
* Signals that an I/O exception has occurred.
259264
*/
260265
@Before
261266
@After
@@ -270,8 +275,10 @@ public void cleanupTempRepositories() throws IOException {
270275
/**
271276
* Cleanup repository.
272277
*
273-
* @param fullName the full name
274-
* @throws IOException Signals that an I/O exception has occurred.
278+
* @param fullName
279+
* the full name
280+
* @throws IOException
281+
* Signals that an I/O exception has occurred.
275282
*/
276283
protected void cleanupRepository(String fullName) throws IOException {
277284
if (mockGitHub.isUseProxy()) {
@@ -331,11 +338,12 @@ private String getOrganization() throws IOException {
331338
public static void fail() {
332339
Assert.fail();
333340
}
334-
341+
335342
/**
336343
* Fail.
337344
*
338-
* @param reason the reason
345+
* @param reason
346+
* the reason
339347
*/
340348
public static void fail(String reason) {
341349
Assert.fail(reason);
@@ -344,9 +352,12 @@ public static void fail(String reason) {
344352
/**
345353
* Assert that.
346354
*
347-
* @param <T> the generic type
348-
* @param actual the actual
349-
* @param matcher the matcher
355+
* @param <T>
356+
* the generic type
357+
* @param actual
358+
* the actual
359+
* @param matcher
360+
* the matcher
350361
*/
351362
public static <T> void assertThat(T actual, Matcher<? super T> matcher) {
352363
MatcherAssert.assertThat("", actual, matcher);
@@ -355,10 +366,14 @@ public static <T> void assertThat(T actual, Matcher<? super T> matcher) {
355366
/**
356367
* Assert that.
357368
*
358-
* @param <T> the generic type
359-
* @param reason the reason
360-
* @param actual the actual
361-
* @param matcher the matcher
369+
* @param <T>
370+
* the generic type
371+
* @param reason
372+
* the reason
373+
* @param actual
374+
* the actual
375+
* @param matcher
376+
* the matcher
362377
*/
363378
public static <T> void assertThat(String reason, T actual, Matcher<? super T> matcher) {
364379
MatcherAssert.assertThat(reason, actual, matcher);
@@ -367,8 +382,10 @@ public static <T> void assertThat(String reason, T actual, Matcher<? super T> ma
367382
/**
368383
* Assert that.
369384
*
370-
* @param reason the reason
371-
* @param assertion the assertion
385+
* @param reason
386+
* the reason
387+
* @param assertion
388+
* the assertion
372389
*/
373390
public static void assertThat(String reason, boolean assertion) {
374391
MatcherAssert.assertThat(reason, assertion);
@@ -378,7 +395,7 @@ public static void assertThat(String reason, boolean assertion) {
378395
* The Class TemplatingHelper.
379396
*/
380397
protected static class TemplatingHelper {
381-
398+
382399
/** The test start date. */
383400
public Date testStartDate = new Date();
384401

‎src/test/java/org/kohsuke/github/AbuseLimitHandlerTest.java‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ protected WireMockConfiguration getWireMockOptions() {
6161
/**
6262
* Test handler fail.
6363
*
64-
* @throws Exception the exception
64+
* @throws Exception
65+
* the exception
6566
*/
6667
@Test
6768
public void testHandler_Fail() throws Exception {
@@ -222,7 +223,8 @@ public void onError(IOException e, HttpURLConnection uc) throws IOException {
222223
/**
223224
* Test handler http status fail.
224225
*
225-
* @throws Exception the exception
226+
* @throws Exception
227+
* the exception
226228
*/
227229
@Test
228230
public void testHandler_HttpStatus_Fail() throws Exception {
@@ -254,7 +256,8 @@ public void testHandler_HttpStatus_Fail() throws Exception {
254256
/**
255257
* Test handler wait.
256258
*
257-
* @throws Exception the exception
259+
* @throws Exception
260+
* the exception
258261
*/
259262
@Test
260263
public void testHandler_Wait() throws Exception {
@@ -275,7 +278,8 @@ public void testHandler_Wait() throws Exception {
275278
/**
276279
* Test handler wait stuck.
277280
*
278-
* @throws Exception the exception
281+
* @throws Exception
282+
* the exception
279283
*/
280284
@Test
281285
public void testHandler_WaitStuck() throws Exception {

0 commit comments

Comments
 (0)