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

@@ -7,8 +7,8 @@ import java.util.Date;
* Represents your subscribing to a repository / conversation thread..
*
* @author Kohsuke Kawaguchi
* @see GHRepository#getSubscription()
* @see GHThread#getSubscription()
* @see GHRepository#getSubscription() GHRepository#getSubscription()
* @see GHThread#getSubscription() GHThread#getSubscription()
*/
public class GHSubscription {
private String created_at, url, repository_url, reason;
@@ -17,36 +17,74 @@ public class GHSubscription {
private GitHub root;
private GHRepository repo;
/**
* Gets created at.
*
* @return the created at
*/
public Date getCreatedAt() {
return GitHub.parseDate(created_at);
}
/**
* Gets url.
*
* @return the url
*/
public String getUrl() {
return url;
}
/**
* Gets repository url.
*
* @return the repository url
*/
public String getRepositoryUrl() {
return repository_url;
}
/**
* Gets reason.
*
* @return the reason
*/
public String getReason() {
return reason;
}
/**
* Is subscribed boolean.
*
* @return the boolean
*/
public boolean isSubscribed() {
return subscribed;
}
/**
* Is ignored boolean.
*
* @return the boolean
*/
public boolean isIgnored() {
return ignored;
}
/**
* Gets repository.
*
* @return the repository
*/
public GHRepository getRepository() {
return repo;
}
/**
* Removes this subscription.
*
* @throws IOException
* the io exception
*/
public void delete() throws IOException {
new Requester(root).method("DELETE").to(repo.getApiTailUrl("subscription"));