Skip to content

Commit edcd136

Browse files
DaySDayS
committed
Fix some other javadoc
1 parent c293583 commit edcd136

3 files changed

Lines changed: 13 additions & 4 deletions

File tree

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,15 @@
2020
import java.lang.annotation.RetentionPolicy;
2121
import java.lang.annotation.Target;
2222

23+
import org.androidannotations.api.rest.RestClientHeaders;
24+
2325
/**
2426
* Use on {@link Get}, {@link Post}, … annotated methods to use authentication
2527
* on the request.
2628
* <p/>
27-
* To set the current authentication object to use, yout MUST add the following
28-
* method to your interface :
29+
* To set the current authentication object to use, you MUST either let your
30+
* RestClient interface extends of {@link RestClientHeaders} or add the
31+
* following method to your interface :
2932
* <code>void setAuthentication(org.springframework.http.HttpAuthentication auth)</code>.
3033
* <p/>
3134
* You can also add this specific method for <a

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,17 @@
2020
import java.lang.annotation.RetentionPolicy;
2121
import java.lang.annotation.Target;
2222

23+
import org.androidannotations.api.rest.RestClientHeaders;
24+
2325
/**
2426
* Use on {@link Get}, {@link Post}, … annotated methods to inject a cookie in
2527
* the request.
2628
* <p/>
2729
* The annotation {@link #value()} is mandatory and define the cookie's name you
2830
* want to inject.
2931
* <p/>
30-
* To set a cookie's value you MUST add the following method to your interface :
32+
* To set a cookie's value you MUST either let your RestClient interface extends
33+
* of {@link RestClientHeaders} or add the following method to your interface :
3134
* <code>void setCookie(String name, String value)</code>.
3235
* <p/>
3336
* You can also add the getter version to read a cookie value :

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,17 @@
2020
import java.lang.annotation.RetentionPolicy;
2121
import java.lang.annotation.Target;
2222

23+
import org.androidannotations.api.rest.RestClientHeaders;
24+
2325
/**
2426
* Use on {@link Get}, {@link Post}, … annotated methods to inject a header in
2527
* the request.
2628
* <p/>
2729
* The annotation {@link #value()} is mandatory and define the header's name you
2830
* want to inject.
2931
* <p/>
30-
* To set a header's value you MUST add the following method to your interface :
32+
* To set a header's value you MUST either let your RestClient interface extends
33+
* of {@link RestClientHeaders} or add the following method to your interface :
3134
* <code>void setHeader(String name, String value)</code>.
3235
* <p/>
3336
* You can also add the getter version to read a header value :

0 commit comments

Comments
 (0)