Skip to content

Commit

Permalink
Bow to javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
bitwiseman committed Sep 17, 2024
1 parent 2df18c1 commit e98ab11
Show file tree
Hide file tree
Showing 169 changed files with 1,639 additions and 16 deletions.
7 changes: 3 additions & 4 deletions src/main/java/org/kohsuke/github/AbstractBuilder.java
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;

// TODO: Auto-generated Javadoc
/**
* An abstract data object builder/updater.
*
Expand Down Expand Up @@ -42,7 +41,7 @@
* Intermediate return type for this builder returned by calls to {@link #with(String, Object)}. If {@link S}
* the same as {@link R}, this builder will commit changes after each call to {@link #with(String, Object)}.
*/
abstract class AbstractBuilder<R, S> extends GitHubInteractiveObject {
public abstract class AbstractBuilder<R, S> extends GitHubInteractiveObject {

@Nonnull
private final Class<R> returnType;
Expand All @@ -58,9 +57,9 @@ abstract class AbstractBuilder<R, S> extends GitHubInteractiveObject {

// TODO: Not sure how update-in-place behavior should be controlled
// However, it certainly can be controlled dynamically down to the instance level or inherited for all children of
// some
// some connection.

/** The update in place. */
// connection.
protected boolean updateInPlace;

/**
Expand Down
6 changes: 6 additions & 0 deletions src/main/java/org/kohsuke/github/GHApp.java
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@
*/
public class GHApp extends GHObject {

/**
* Create default GHApp instance
*/
public GHApp() {
}

private GHUser owner;
private String name;
private String slug;
Expand Down
6 changes: 6 additions & 0 deletions src/main/java/org/kohsuke/github/GHAppFromManifest.java
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@
*/
public class GHAppFromManifest extends GHApp {

/**
* Create default GHAppFromManifest instance
*/
public GHAppFromManifest() {
}

private String clientId;
private String clientSecret;
private String webhookSecret;
Expand Down
7 changes: 7 additions & 0 deletions src/main/java/org/kohsuke/github/GHAppInstallation.java
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,13 @@
* @see GHApp#getInstallationByUser(String) GHApp#getInstallationByUser(String)
*/
public class GHAppInstallation extends GHObject {

/**
* Create default GHAppInstallation instance
*/
public GHAppInstallation() {
}

private GHUser account;

@JsonProperty("access_tokens_url")
Expand Down
7 changes: 7 additions & 0 deletions src/main/java/org/kohsuke/github/GHAppInstallationToken.java
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@
* @see GHAppInstallation#createToken() GHAppInstallation#createToken()
*/
public class GHAppInstallationToken extends GitHubInteractiveObject {

/**
* Create default GHAppInstallationToken instance
*/
public GHAppInstallationToken() {
}

private String token;

/** The expires at. */
Expand Down
6 changes: 6 additions & 0 deletions src/main/java/org/kohsuke/github/GHArtifact.java
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@
*/
public class GHArtifact extends GHObject {

/**
* Create default GHArtifact instance
*/
public GHArtifact() {
}

// Not provided by the API.
@JsonIgnore
private GHRepository owner;
Expand Down
6 changes: 6 additions & 0 deletions src/main/java/org/kohsuke/github/GHAsset.java
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@
*/
public class GHAsset extends GHObject {

/**
* Create default GHAsset instance
*/
public GHAsset() {
}

/** The owner. */
GHRepository owner;
private String name;
Expand Down
6 changes: 6 additions & 0 deletions src/main/java/org/kohsuke/github/GHAuthorization.java
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@
*/
public class GHAuthorization extends GHObject {

/**
* Create default GHAuthorization instance
*/
public GHAuthorization() {
}

/** The Constant USER. */
public static final String USER = "user";

Expand Down
7 changes: 7 additions & 0 deletions src/main/java/org/kohsuke/github/GHBlob.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@
* @see <a href="https://developer.github.com/v3/git/blobs/#get-a-blob">Get a blob</a>
*/
public class GHBlob {

/**
* Create default GHBlob instance
*/
public GHBlob() {
}

private String content, encoding, url, sha;
private long size;

Expand Down
6 changes: 6 additions & 0 deletions src/main/java/org/kohsuke/github/GHBranch.java
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ public class GHBranch extends GitHubInteractiveObject {
*/
public static class Commit {

/**
* Create default Commit instance
*/
public Commit() {
}

/** The sha. */
String sha;

Expand Down
84 changes: 84 additions & 0 deletions src/main/java/org/kohsuke/github/GHBranchProtection.java
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@
"URF_UNREAD_FIELD" },
justification = "JSON API")
public class GHBranchProtection extends GitHubInteractiveObject {

/**
* Create default GHBranchProtection instance
*/
public GHBranchProtection() {
}

private static final String REQUIRE_SIGNATURES_URI = "/required_signatures";

@JsonProperty
Expand Down Expand Up @@ -204,6 +211,13 @@ private Requester requester() {
* The type AllowDeletions.
*/
public static class AllowDeletions {

/**
* Create default AllowDeletions instance
*/
public AllowDeletions() {
}

@JsonProperty
private boolean enabled;

Expand Down Expand Up @@ -270,6 +284,13 @@ public Integer getAppId() {
* The type AllowForcePushes.
*/
public static class AllowForcePushes {

/**
* Create default AllowForcePushes instance
*/
public AllowForcePushes() {
}

@JsonProperty
private boolean enabled;

Expand All @@ -287,6 +308,13 @@ public boolean isEnabled() {
* The type AllowForkSyncing.
*/
public static class AllowForkSyncing {

/**
* Create default AllowForkSyncing instance
*/
public AllowForkSyncing() {
}

@JsonProperty
private boolean enabled;

Expand All @@ -304,6 +332,13 @@ public boolean isEnabled() {
* The type BlockCreations.
*/
public static class BlockCreations {

/**
* Create default BlockCreations instance
*/
public BlockCreations() {
}

@JsonProperty
private boolean enabled;

Expand All @@ -321,6 +356,13 @@ public boolean isEnabled() {
* The type EnforceAdmins.
*/
public static class EnforceAdmins {

/**
* Create default EnforceAdmins instance
*/
public EnforceAdmins() {
}

@JsonProperty
private boolean enabled;

Expand Down Expand Up @@ -350,6 +392,13 @@ public boolean isEnabled() {
* The type LockBranch.
*/
public static class LockBranch {

/**
* Create default LockBranch instance
*/
public LockBranch() {
}

@JsonProperty
private boolean enabled;

Expand All @@ -367,6 +416,13 @@ public boolean isEnabled() {
* The type RequiredConversationResolution.
*/
public static class RequiredConversationResolution {

/**
* Create default RequiredConversationResolution instance
*/
public RequiredConversationResolution() {
}

@JsonProperty
private boolean enabled;

Expand All @@ -384,6 +440,13 @@ public boolean isEnabled() {
* The type RequiredLinearHistory.
*/
public static class RequiredLinearHistory {

/**
* Create default RequiredLinearHistory instance
*/
public RequiredLinearHistory() {
}

@JsonProperty
private boolean enabled;

Expand All @@ -401,6 +464,13 @@ public boolean isEnabled() {
* The type RequiredReviews.
*/
public static class RequiredReviews {

/**
* Create default RequiredReviews instance
*/
public RequiredReviews() {
}

@JsonProperty("dismissal_restrictions")
private Restrictions dismissalRestriction;

Expand Down Expand Up @@ -504,6 +574,13 @@ public boolean isEnabled() {
* The type RequiredStatusChecks.
*/
public static class RequiredStatusChecks {

/**
* Create default RequiredStatusChecks instance
*/
public RequiredStatusChecks() {
}

@JsonProperty
private Collection<String> contexts;

Expand Down Expand Up @@ -557,6 +634,13 @@ public boolean isRequiresBranchUpToDate() {
* The type Restrictions.
*/
public static class Restrictions {

/**
* Create default Restrictions instance
*/
public Restrictions() {
}

@JsonProperty
private Collection<GHTeam> teams;

Expand Down
6 changes: 6 additions & 0 deletions src/main/java/org/kohsuke/github/GHBranchSync.java
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@
*/
public class GHBranchSync extends GitHubInteractiveObject {

/**
* Create default GHBranchSync instance
*/
public GHBranchSync() {
}

/**
* The Repository that this branch is in.
*/
Expand Down
13 changes: 13 additions & 0 deletions src/main/java/org/kohsuke/github/GHCheckRun.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@
justification = "JSON API")
public class GHCheckRun extends GHObject {

/**
* Create default GHCheckRun instance
*/
public GHCheckRun() {
}

/** The owner. */
@JsonProperty("repository")
GHRepository owner;
Expand Down Expand Up @@ -312,6 +318,13 @@ public Output getOutput() {
* @see <a href="https://developer.github.com/v3/checks/runs/#output-object">documentation</a>
*/
public static class Output {

/**
* Create default Output instance
*/
public Output() {
}

private String title;
private String summary;
private String text;
Expand Down
13 changes: 13 additions & 0 deletions src/main/java/org/kohsuke/github/GHCheckSuite.java
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@
justification = "JSON API")
public class GHCheckSuite extends GHObject {

/**
* Create default GHCheckSuite instance
*/
public GHCheckSuite() {
}

/** The owner. */
@JsonProperty("repository")
GHRepository owner;
Expand Down Expand Up @@ -205,6 +211,13 @@ public List<GHPullRequest> getPullRequests() throws IOException {
* The Class HeadCommit.
*/
public static class HeadCommit {

/**
* Create default HeadCommit instance
*/
public HeadCommit() {
}

private String id;
private String treeId;
private String message;
Expand Down
7 changes: 7 additions & 0 deletions src/main/java/org/kohsuke/github/GHCodeownersError.java
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,13 @@
* @author Michael Grant
*/
public class GHCodeownersError {

/**
* Create default GHCodeownersError instance
*/
public GHCodeownersError() {
}

private int line, column;

private String kind, source, suggestion, message, path;
Expand Down
Loading

0 comments on commit e98ab11

Please sign in to comment.