Add JavaDocs

Do using IntelliJ JavaDocs plugin. Better to have something than nothing.
This commit is contained in:
Liam Newman
2019-11-14 13:24:28 -08:00
parent f6a01551fd
commit 757b9b2118
125 changed files with 7379 additions and 251 deletions

View File

@@ -32,7 +32,7 @@ import java.net.URL;
* Commit detail inside a {@link GHPullRequest}.
*
* @author Luca Milanesio
* @see GHPullRequest#listCommits()
* @see GHPullRequest#listCommits() GHPullRequest#listCommits()
*/
@SuppressFBWarnings(value = { "UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD", "UWF_UNWRITTEN_FIELD", "NP_UNWRITTEN_FIELD",
"URF_UNREAD_FIELD" }, justification = "JSON API")
@@ -44,24 +44,42 @@ public class GHPullRequestCommitDetail {
}
/**
* The type Authorship.
*
* @deprecated Use {@link GitUser}
*/
public static class Authorship extends GitUser {
}
/**
* The type Tree.
*/
public static class Tree {
String sha;
String url;
/**
* Gets sha.
*
* @return the sha
*/
public String getSha() {
return sha;
}
/**
* Gets url.
*
* @return the url
*/
public URL getUrl() {
return GitHub.parseURL(url);
}
}
/**
* The type Commit.
*/
public static class Commit {
Authorship author;
Authorship committer;
@@ -70,46 +88,94 @@ public class GHPullRequestCommitDetail {
String url;
int comment_count;
/**
* Gets author.
*
* @return the author
*/
@WithBridgeMethods(value = Authorship.class, castRequired = true)
public GitUser getAuthor() {
return author;
}
/**
* Gets committer.
*
* @return the committer
*/
@WithBridgeMethods(value = Authorship.class, castRequired = true)
public GitUser getCommitter() {
return committer;
}
/**
* Gets message.
*
* @return the message
*/
public String getMessage() {
return message;
}
/**
* Gets url.
*
* @return the url
*/
public URL getUrl() {
return GitHub.parseURL(url);
}
/**
* Gets comment count.
*
* @return the comment count
*/
public int getComment_count() {
return comment_count;
}
/**
* Gets tree.
*
* @return the tree
*/
public Tree getTree() {
return tree;
}
}
/**
* The type CommitPointer.
*/
public static class CommitPointer {
String sha;
String url;
String html_url;
/**
* Gets url.
*
* @return the url
*/
public URL getUrl() {
return GitHub.parseURL(url);
}
/**
* Gets html url.
*
* @return the html url
*/
public URL getHtml_url() {
return GitHub.parseURL(html_url);
}
/**
* Gets sha.
*
* @return the sha
*/
public String getSha() {
return sha;
}
@@ -122,26 +188,56 @@ public class GHPullRequestCommitDetail {
String comments_url;
CommitPointer[] parents;
/**
* Gets sha.
*
* @return the sha
*/
public String getSha() {
return sha;
}
/**
* Gets commit.
*
* @return the commit
*/
public Commit getCommit() {
return commit;
}
/**
* Gets api url.
*
* @return the api url
*/
public URL getApiUrl() {
return GitHub.parseURL(url);
}
/**
* Gets url.
*
* @return the url
*/
public URL getUrl() {
return GitHub.parseURL(html_url);
}
/**
* Gets comments url.
*
* @return the comments url
*/
public URL getCommentsUrl() {
return GitHub.parseURL(comments_url);
}
/**
* Get parents commit pointer [ ].
*
* @return the commit pointer [ ]
*/
public CommitPointer[] getParents() {
CommitPointer[] newValue = new CommitPointer[parents.length];
System.arraycopy(parents, 0, newValue, 0, parents.length);