Skip to content

Commit 78c2998

Browse files
yDelouisyDelouis
committed
Merge pull request androidannotations#1458 from WonderCsabo/restclientHeadersDoc
Expand some @rest doc
2 parents 2b5b74b + cba0a7f commit 78c2998

5 files changed

Lines changed: 29 additions & 2 deletions

File tree

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/annotations/rest/RequiresAuthentication.java‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,12 @@
3434
* .
3535
* </p>
3636
* <p>
37-
* You can also add this specific method for <a
37+
* You can also add a specific method for <a
3838
* href="https://en.wikipedia.org/wiki/Basic_access_authentication">Basic
3939
* Authentication</a> :
40-
* <code>setHttpBasicAuth(String username, String password)</code>.
40+
* <code>setHttpBasicAuth(String username, String password)</code> or <a
41+
* href="https://tools.ietf.org/html/rfc6750" >Bearer (OAuth) authentication</a>
42+
* : <code>setBearerAuth(String token)</code>.
4143
* </p>
4244
* <blockquote>
4345
*

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/api/rest/RestClientErrorHandling.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
/**
1919
* A @Rest interface implementing this interface will automatically have the
2020
* implementations of this method generated.
21+
*
22+
* @see org.androidannotations.annotations.rest.Rest
2123
*/
2224
public interface RestClientErrorHandling {
2325
/**

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/api/rest/RestClientHeaders.java‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,11 @@
2020
/**
2121
* A @Rest interface implementing this interface will automatically have the
2222
* implementations of these methods generated.
23+
*
24+
* @see org.androidannotations.annotations.rest.Rest
25+
* @see org.androidannotations.annotations.rest.RequiresCookie
26+
* @see org.androidannotations.annotations.rest.RequiresHeader
27+
* @see org.androidannotations.annotations.rest.RequiresAuthentication
2328
*/
2429
public interface RestClientHeaders {
2530

@@ -29,6 +34,8 @@ public interface RestClientHeaders {
2934
* @param name
3035
* Name of the cookie
3136
* @return the cookie value.
37+
*
38+
* @see org.androidannotations.annotations.rest.RequiresCookie
3239
*/
3340
String getCookie(String name);
3441

@@ -39,6 +46,8 @@ public interface RestClientHeaders {
3946
* Name of the cookie
4047
* @param value
4148
* Value of the cookie
49+
*
50+
* @see org.androidannotations.annotations.rest.RequiresCookie
4251
*/
4352
void setCookie(String name, String value);
4453

@@ -48,6 +57,8 @@ public interface RestClientHeaders {
4857
* @param name
4958
* Name of the header
5059
* @return the header value.
60+
*
61+
* @see org.androidannotations.annotations.rest.RequiresHeader
5162
*/
5263
String getHeader(String name);
5364

@@ -58,6 +69,8 @@ public interface RestClientHeaders {
5869
* Name of the header
5970
* @param value
6071
* Value of the header
72+
*
73+
* @see org.androidannotations.annotations.rest.RequiresHeader
6174
*/
6275
void setHeader(String name, String value);
6376

@@ -66,6 +79,8 @@ public interface RestClientHeaders {
6679
*
6780
* @param auth
6881
* Authentication data
82+
*
83+
* @see org.androidannotations.annotations.rest.RequiresAuthentication
6984
*/
7085
void setAuthentication(HttpAuthentication auth);
7186

@@ -76,6 +91,8 @@ public interface RestClientHeaders {
7691
* Name of the user
7792
* @param password
7893
* Password of the user
94+
*
95+
* @see org.androidannotations.annotations.rest.RequiresAuthentication
7996
*/
8097
void setHttpBasicAuth(String user, String password);
8198

@@ -84,6 +101,8 @@ public interface RestClientHeaders {
84101
*
85102
* @param token
86103
* Token used for authentication
104+
*
105+
* @see org.androidannotations.annotations.rest.RequiresAuthentication
87106
*/
88107
void setBearerAuth(String token);
89108
}

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/api/rest/RestClientRootUrl.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
/**
1919
* A @Rest interface implementing this interface will automatically have the
2020
* implementations of these methods generated.
21+
*
22+
* @see org.androidannotations.annotations.rest.Rest
2123
*/
2224
public interface RestClientRootUrl {
2325
/**

‎AndroidAnnotations/androidannotations-api/src/main/java/org/androidannotations/api/rest/RestClientSupport.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020
/**
2121
* A @Rest interface implementing this interface will automatically have the
2222
* implementations of these methods generated.
23+
*
24+
* @see org.androidannotations.annotations.rest.Rest
2325
*/
2426
public interface RestClientSupport {
2527
/**

0 commit comments

Comments
 (0)