Skip to content

Commit 5fb9b02

Browse files
committed
Add @SInCE and @author where required.
Revert changes to RequestDocumentation.java since they were outside the scope of this change.
1 parent c2d4a71 commit 5fb9b02

13 files changed

+33
-25
lines changed

build.gradle

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,8 @@ subprojects {
105105

106106
compileJava {
107107
options.compilerArgs = [ '-Xlint:deprecation', '-Xlint:-options', '-Werror' ]
108-
options.encoding = "UTF-8"
108+
options.encoding = 'UTF-8'
109109
}
110-
111110
}
112111

113112
configure(subprojects - project(":docs")) { subproject ->
@@ -154,7 +153,7 @@ configure(subprojects - project(":docs")) { subproject ->
154153
options.docTitle = "${options.header} API"
155154
options.links = javadocLinks
156155
options.addStringOption '-quiet'
157-
options.encoding = 'UTF-8'
156+
options.encoding = 'UTF-8'
158157
}
159158

160159
task sourcesJar(type: Jar) {

spring-restdocs-core/src/main/java/org/springframework/restdocs/cookies/AbstractCookiesSnippet.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
*
3434
* @author Andreas Evers
3535
* @author Clyde Stubbs
36+
* @since 2.1
3637
*/
3738
public abstract class AbstractCookiesSnippet extends TemplatedSnippet {
3839

spring-restdocs-core/src/main/java/org/springframework/restdocs/cookies/CookieDescriptor.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
*
2424
* @author Andreas Evers
2525
* @author Clyde Stubbs
26+
* @since 2.1
2627
* @see CookieDocumentation#cookieWithName(String)
2728
*/
2829
public class CookieDescriptor extends IgnorableDescriptor<CookieDescriptor> {

spring-restdocs-core/src/main/java/org/springframework/restdocs/cookies/CookieDocumentation.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
* @author Andy Wilkinson
3030
* @author Marcel Overdijk
3131
* @author Clyde Stubbs
32+
* @since 2.1
3233
*/
3334
public abstract class CookieDocumentation {
3435

spring-restdocs-core/src/main/java/org/springframework/restdocs/cookies/RequestCookiesSnippet.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
* @author Andreas Evers
3434
* @author Andy Wilkinson
3535
* @author Clyde Stubbs
36+
* @since 2.1
3637
* @see CookieDocumentation#requestCookies(CookieDescriptor...)
3738
* @see CookieDocumentation#requestCookies(Map, CookieDescriptor...)
3839
*/

spring-restdocs-core/src/main/java/org/springframework/restdocs/cookies/ResponseCookiesSnippet.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
* @author Andreas Evers
3434
* @author Andy Wilkinson
3535
* @author Clyde Stubbs
36+
* @since 2.1
3637
* @see CookieDocumentation#responseCookies(CookieDescriptor...)
3738
* @see CookieDocumentation#responseCookies(Map, CookieDescriptor...)
3839
*/

spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/OperationResponse.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public interface OperationResponse {
6363
* Returns the {@link ResponseCookie cookies} returned with the response. If no
6464
* cookies were returned an empty collection is returned.
6565
* @return the cookies, never {@code null}
66-
* @since 2.0.4
66+
* @since 2.1
6767
*/
6868
Collection<ResponseCookie> getCookies();
6969

spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/OperationResponseFactory.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ public class OperationResponseFactory {
3939
* @param content the content of the request
4040
* @param cookies the cookies
4141
* @return the {@code OperationResponse}
42+
* @since 2.1
4243
*/
4344
public OperationResponse create(HttpStatus status, HttpHeaders headers,
4445
byte[] content, Collection<ResponseCookie> cookies) {

spring-restdocs-core/src/main/java/org/springframework/restdocs/operation/ResponseCookie.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
* A representation of a Cookie returned in a response.
2121
*
2222
* @author Clyde Stubbs
23-
* @since 2.0.4
23+
* @since 2.1
2424
*/
2525
public final class ResponseCookie {
2626

spring-restdocs-core/src/main/java/org/springframework/restdocs/request/RequestDocumentation.java

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ public static RequestPartDescriptor partWithName(String name) {
6565
* request path, a failure will also occur.
6666
* <p>
6767
* If you do not want to document a path parameter, a parameter descriptor can be
68-
* marked as {@link ParameterDescriptor#ignored()}. This will prevent it from
69-
* appearing in the generated snippet while avoiding the failure described above.
68+
* marked as {@link ParameterDescriptor#ignored}. This will prevent it from appearing
69+
* in the generated snippet while avoiding the failure described above.
7070
* @param descriptors the descriptions of the parameters in the request's path
7171
* @return the snippet that will document the parameters
7272
*/
@@ -86,8 +86,8 @@ public static PathParametersSnippet pathParameters(
8686
* request path, a failure will also occur.
8787
* <p>
8888
* If you do not want to document a path parameter, a parameter descriptor can be
89-
* marked as {@link ParameterDescriptor#ignored()}. This will prevent it from
90-
* appearing in the generated snippet while avoiding the failure described above.
89+
* marked as {@link ParameterDescriptor#ignored}. This will prevent it from appearing
90+
* in the generated snippet while avoiding the failure described above.
9191
* @param descriptors the descriptions of the parameters in the request's path
9292
* @return the snippet that will document the parameters
9393
*/
@@ -138,8 +138,8 @@ public static PathParametersSnippet relaxedPathParameters(
138138
* request path, a failure will also occur.
139139
* <p>
140140
* If you do not want to document a path parameter, a parameter descriptor can be
141-
* marked as {@link ParameterDescriptor#ignored()}. This will prevent it from
142-
* appearing in the generated snippet while avoiding the failure described above.
141+
* marked as {@link ParameterDescriptor#ignored}. This will prevent it from appearing
142+
* in the generated snippet while avoiding the failure described above.
143143
* @param attributes the attributes
144144
* @param descriptors the descriptions of the parameters in the request's path
145145
* @return the snippet that will document the parameters
@@ -161,8 +161,8 @@ public static PathParametersSnippet pathParameters(Map<String, Object> attribute
161161
* request path, a failure will also occur.
162162
* <p>
163163
* If you do not want to document a path parameter, a parameter descriptor can be
164-
* marked as {@link ParameterDescriptor#ignored()}. This will prevent it from
165-
* appearing in the generated snippet while avoiding the failure described above.
164+
* marked as {@link ParameterDescriptor#ignored}. This will prevent it from appearing
165+
* in the generated snippet while avoiding the failure described above.
166166
* @param attributes the attributes
167167
* @param descriptors the descriptions of the parameters in the request's path
168168
* @return the snippet that will document the parameters
@@ -217,8 +217,8 @@ public static PathParametersSnippet relaxedPathParameters(
217217
* request, a failure will also occur.
218218
* <p>
219219
* If you do not want to document a request parameter, a parameter descriptor can be
220-
* marked as {@link ParameterDescriptor#ignored()}. This will prevent it from
221-
* appearing in the generated snippet while avoiding the failure described above.
220+
* marked as {@link ParameterDescriptor#ignored}. This will prevent it from appearing
221+
* in the generated snippet while avoiding the failure described above.
222222
* @param descriptors the descriptions of the request's parameters
223223
* @return the snippet
224224
* @see OperationRequest#getParameters()
@@ -239,8 +239,8 @@ public static RequestParametersSnippet requestParameters(
239239
* request, a failure will also occur.
240240
* <p>
241241
* If you do not want to document a request parameter, a parameter descriptor can be
242-
* marked as {@link ParameterDescriptor#ignored()}. This will prevent it from
243-
* appearing in the generated snippet while avoiding the failure described above.
242+
* marked as {@link ParameterDescriptor#ignored}. This will prevent it from appearing
243+
* in the generated snippet while avoiding the failure described above.
244244
* @param descriptors the descriptions of the request's parameters
245245
* @return the snippet
246246
* @see OperationRequest#getParameters()
@@ -294,8 +294,8 @@ public static RequestParametersSnippet relaxedRequestParameters(
294294
* request, a failure will also occur.
295295
* <p>
296296
* If you do not want to document a request parameter, a parameter descriptor can be
297-
* marked as {@link ParameterDescriptor#ignored()}. This will prevent it from
298-
* appearing in the generated snippet while avoiding the failure described above.
297+
* marked as {@link ParameterDescriptor#ignored}. This will prevent it from appearing
298+
* in the generated snippet while avoiding the failure described above.
299299
* @param attributes the attributes
300300
* @param descriptors the descriptions of the request's parameters
301301
* @return the snippet that will document the parameters
@@ -318,8 +318,8 @@ public static RequestParametersSnippet requestParameters(
318318
* request, a failure will also occur.
319319
* <p>
320320
* If you do not want to document a request parameter, a parameter descriptor can be
321-
* marked as {@link ParameterDescriptor#ignored()}. This will prevent it from
322-
* appearing in the generated snippet while avoiding the failure described above.
321+
* marked as {@link ParameterDescriptor#ignored}. This will prevent it from appearing
322+
* in the generated snippet while avoiding the failure described above.
323323
* @param attributes the attributes
324324
* @param descriptors the descriptions of the request's parameters
325325
* @return the snippet that will document the parameters
@@ -376,7 +376,7 @@ public static RequestParametersSnippet relaxedRequestParameters(
376376
* failure will also occur.
377377
* <p>
378378
* If you do not want to document a part, a part descriptor can be marked as
379-
* {@link RequestPartDescriptor#ignored()}. This will prevent it from appearing in the
379+
* {@link RequestPartDescriptor#ignored}. This will prevent it from appearing in the
380380
* generated snippet while avoiding the failure described above.
381381
* @param descriptors the descriptions of the request's parts
382382
* @return the snippet
@@ -396,7 +396,7 @@ public static RequestPartsSnippet requestParts(RequestPartDescriptor... descript
396396
* failure will also occur.
397397
* <p>
398398
* If you do not want to document a part, a part descriptor can be marked as
399-
* {@link RequestPartDescriptor#ignored()}. This will prevent it from appearing in the
399+
* {@link RequestPartDescriptor#ignored}. This will prevent it from appearing in the
400400
* generated snippet while avoiding the failure described above.
401401
* @param descriptors the descriptions of the request's parts
402402
* @return the snippet
@@ -448,7 +448,7 @@ public static RequestPartsSnippet relaxedRequestParts(
448448
* failure will also occur.
449449
* <p>
450450
* If you do not want to document a part, a part descriptor can be marked as
451-
* {@link RequestPartDescriptor#ignored()}. This will prevent it from appearing in the
451+
* {@link RequestPartDescriptor#ignored}. This will prevent it from appearing in the
452452
* generated snippet while avoiding the failure described above.
453453
* @param attributes the attributes
454454
* @param descriptors the descriptions of the request's parts
@@ -471,7 +471,7 @@ public static RequestPartsSnippet requestParts(Map<String, Object> attributes,
471471
* failure will also occur.
472472
* <p>
473473
* If you do not want to document a part, a part descriptor can be marked as
474-
* {@link RequestPartDescriptor#ignored()}. This will prevent it from appearing in the
474+
* {@link RequestPartDescriptor#ignored}. This will prevent it from appearing in the
475475
* generated snippet while avoiding the failure described above.
476476
* @param attributes the attributes
477477
* @param descriptors the descriptions of the request's parts

spring-restdocs-core/src/test/java/org/springframework/restdocs/cookies/RequestCookiesSnippetFailureTests.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
* undocumented cookies.
3636
*
3737
* @author Andy Wilkinson
38+
* @author Clyde Stubbs
3839
*/
3940
public class RequestCookiesSnippetFailureTests {
4041

spring-restdocs-core/src/test/java/org/springframework/restdocs/cookies/ResponseCookiesSnippetFailureTests.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
* undocumented cookies.
3636
*
3737
* @author Andy Wilkinson
38+
* @author Clyde Stubbs
3839
*/
3940
public class ResponseCookiesSnippetFailureTests {
4041

spring-restdocs-core/src/test/java/org/springframework/restdocs/cookies/ResponseCookiesSnippetTests.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
*
4141
* @author Andreas Evers
4242
* @author Andy Wilkinson
43+
* @author Clyde Stubbs
4344
*/
4445
public class ResponseCookiesSnippetTests extends AbstractSnippetTests {
4546

0 commit comments

Comments
 (0)