Skip to content

Commit 532cb04

Browse files
nabeelmukhtarnabeelmukhtar
committed
JAutoDoc
1 parent 06294f6 commit 532cb04

69 files changed

Lines changed: 3896 additions & 1369 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.

‎.settings/net.sf.jautodoc.prefs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
#Thu Jun 17 12:36:56 GMT+05:00 2010
1+
#Wed Jul 14 18:06:56 GMT+05:00 2010
22
add_todo=false
33
eclipse.preferences.version=1
44
mode=mode_replace
55
project_specific_settings=true
66
replacements=<?xml version\="1.0" standalone\="yes"?>\n\n<replacements>\n<replacement key\="get" scope\="1" mode\="0">Gets the</replacement>\n<replacement key\="set" scope\="1" mode\="0">Sets the</replacement>\n<replacement key\="add" scope\="1" mode\="0">Adds the</replacement>\n<replacement key\="edit" scope\="1" mode\="0">Edits the</replacement>\n<replacement key\="remove" scope\="1" mode\="0">Removes the</replacement>\n<replacement key\="init" scope\="1" mode\="0">Inits the</replacement>\n<replacement key\="parse" scope\="1" mode\="0">Parses the</replacement>\n<replacement key\="create" scope\="1" mode\="0">Creates the</replacement>\n<replacement key\="build" scope\="1" mode\="0">Builds the</replacement>\n<replacement key\="is" scope\="1" mode\="0">Checks if is</replacement>\n<replacement key\="print" scope\="1" mode\="0">Prints the</replacement>\n<replacement key\="has" scope\="1" mode\="0">Checks for</replacement>\n</replacements>\n\n
7+
use_internal_formatter=true

‎core/src/main/java/com/github/api/v2/services/AsyncResponseHandler.java‎

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,27 +15,29 @@ public abstract class AsyncResponseHandler<T> {
1515
private Future<T> future;
1616

1717
/**
18-
* Sets the future.
19-
*
20-
* @param future the new future
21-
*/
18+
* Sets the future.
19+
*
20+
* @param future
21+
* the new future
22+
*/
2223
public void setFuture(Future<T> future) {
2324
this.future = future;
2425
}
2526

2627
/**
27-
* Gets the future.
28-
*
29-
* @return the future
30-
*/
28+
* Gets the future.
29+
*
30+
* @return the future
31+
*/
3132
public Future<T> getFuture() {
3233
return future;
3334
}
3435

3536
/**
36-
* Handle response.
37-
*
38-
* @param response the response
39-
*/
37+
* Handle response.
38+
*
39+
* @param response
40+
* the response
41+
*/
4042
public abstract void handleResponse(T response);
4143
}

‎core/src/main/java/com/github/api/v2/services/CommitService.java‎

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,51 @@
88
import com.github.api.v2.schema.Commit;
99

1010
/**
11-
* @author nmukhtar
12-
*
11+
* The Interface CommitService.
1312
*/
1413
public interface CommitService extends GitHubService {
14+
15+
/**
16+
* Gets the commits.
17+
*
18+
* @param userName
19+
* the user name
20+
* @param repositoryName
21+
* the repository name
22+
* @param branch
23+
* the branch
24+
*
25+
* @return the commits
26+
*/
1527
public List<Commit> getCommits(String userName, String repositoryName, String branch);
28+
29+
/**
30+
* Gets the commits.
31+
*
32+
* @param userName
33+
* the user name
34+
* @param repositoryName
35+
* the repository name
36+
* @param branch
37+
* the branch
38+
* @param filePath
39+
* the file path
40+
*
41+
* @return the commits
42+
*/
1643
public List<Commit> getCommits(String userName, String repositoryName, String branch, String filePath);
44+
45+
/**
46+
* Gets the commit.
47+
*
48+
* @param userName
49+
* the user name
50+
* @param repositoryName
51+
* the repository name
52+
* @param sha
53+
* the sha
54+
*
55+
* @return the commit
56+
*/
1757
public Commit getCommit(String userName, String repositoryName, String sha);
1858
}

‎core/src/main/java/com/github/api/v2/services/GistService.java‎

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,39 @@
99
import com.github.api.v2.schema.Gist;
1010

1111
/**
12-
* @author nmukhtar
13-
*
12+
* The Interface GistService.
1413
*/
1514
public interface GistService extends GitHubService {
15+
16+
/**
17+
* Gets the gist.
18+
*
19+
* @param gistId
20+
* the gist id
21+
*
22+
* @return the gist
23+
*/
1624
public Gist getGist(String gistId);
25+
26+
/**
27+
* Gets the gist content.
28+
*
29+
* @param gistId
30+
* the gist id
31+
* @param fileName
32+
* the file name
33+
*
34+
* @return the gist content
35+
*/
1736
public InputStream getGistContent(String gistId, String fileName);
37+
38+
/**
39+
* Gets the user gists.
40+
*
41+
* @param userName
42+
* the user name
43+
*
44+
* @return the user gists
45+
*/
1846
public List<Gist> getUserGists(String userName);
1947
}

‎core/src/main/java/com/github/api/v2/services/GitHubAuthenticator.java‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,31 @@
77

88

99
/**
10-
* The Interface GoogleSearchAuthenticationClient.
10+
* The Interface GitHubAuthenticator.
1111
*/
1212
public interface GitHubAuthenticator extends GitHubCommunicator {
1313

1414
/**
15-
* Sets the application key.
16-
* @param authentication TODO
17-
*/
15+
* Sets the authentication.
16+
*
17+
* @param authentication
18+
* the new authentication
19+
*/
1820
public void setAuthentication(Authentication authentication);
1921

2022
/**
2123
* Sets the user ip address.
2224
*
23-
* @param userIpAddress the new user ip address
25+
* @param userIpAddress
26+
* the new user ip address
2427
*/
2528
public void setUserIpAddress(String userIpAddress);
2629

2730
/**
2831
* Sets the referrer.
2932
*
30-
* @param referrer the new referrer
33+
* @param referrer
34+
* the new referrer
3135
*/
3236
public void setReferrer(String referrer);
3337
}

‎core/src/main/java/com/github/api/v2/services/GitHubCommunicator.java‎

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,36 +6,40 @@
66
import java.util.Map;
77

88
/**
9-
* The Interface GoogleSearchCommunicationClient.
9+
* The Interface GitHubCommunicator.
1010
*/
1111
public interface GitHubCommunicator {
1212

1313
/**
14-
* Sets the request headers.
15-
*
16-
* @param requestHeaders the request headers
17-
*/
14+
* Sets the request headers.
15+
*
16+
* @param requestHeaders
17+
* the request headers
18+
*/
1819
public void setRequestHeaders(Map<String, String> requestHeaders);
1920

2021
/**
21-
* Gets the request headers.
22-
*
23-
* @return the request headers
24-
*/
22+
* Gets the request headers.
23+
*
24+
* @return the request headers
25+
*/
2526
public Map<String, String> getRequestHeaders();
2627

2728
/**
28-
* Adds the request header.
29-
*
30-
* @param headerName the header name
31-
* @param headerValue the header value
32-
*/
29+
* Adds the request header.
30+
*
31+
* @param headerName
32+
* the header name
33+
* @param headerValue
34+
* the header value
35+
*/
3336
public void addRequestHeader(String headerName, String headerValue);
3437

3538
/**
36-
* Removes the request header.
37-
*
38-
* @param headerName the header name
39-
*/
39+
* Removes the request header.
40+
*
41+
* @param headerName
42+
* the header name
43+
*/
4044
public void removeRequestHeader(String headerName);
4145
}

‎core/src/main/java/com/github/api/v2/services/GitHubException.java‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,41 +4,45 @@
44
package com.github.api.v2.services;
55

66
/**
7-
* The Class GoogleSearchException.
7+
* The Class GitHubException.
88
*/
99
public class GitHubException extends RuntimeException {
1010

1111
/** The Constant serialVersionUID. */
1212
private static final long serialVersionUID = -2392119987027760999L;
1313

1414
/**
15-
* Instantiates a new google search exception.
15+
* Instantiates a new git hub exception.
1616
*/
1717
public GitHubException() {}
1818

1919
/**
20-
* Instantiates a new google search exception.
20+
* Instantiates a new git hub exception.
2121
*
22-
* @param message the message
22+
* @param message
23+
* the message
2324
*/
2425
public GitHubException(String message) {
2526
super(message);
2627
}
2728

2829
/**
29-
* Instantiates a new google search exception.
30+
* Instantiates a new git hub exception.
3031
*
31-
* @param cause the cause
32+
* @param cause
33+
* the cause
3234
*/
3335
public GitHubException(Throwable cause) {
3436
super(cause);
3537
}
3638

3739
/**
38-
* Instantiates a new google search exception.
40+
* Instantiates a new git hub exception.
3941
*
40-
* @param message the message
41-
* @param cause the cause
42+
* @param message
43+
* the message
44+
* @param cause
45+
* the cause
4246
*/
4347
public GitHubException(String message, Throwable cause) {
4448
super(message, cause);

‎core/src/main/java/com/github/api/v2/services/GitHubService.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@
44
package com.github.api.v2.services;
55

66
/**
7-
* @author nmukhtar
8-
*
7+
* The Interface GitHubService.
98
*/
109
public interface GitHubService extends GitHubAuthenticator {
1110

0 commit comments

Comments
 (0)