Skip to content

Commit 2f12c2d

Browse files
clydebarrowwilkinsona
authored andcommitted
Fix links to ignored() in RequestDocumentation's javadoc
See gh-595
1 parent 91653a3 commit 2f12c2d

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

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 appearing
69-
* in the generated snippet while avoiding the failure described above.
68+
* marked as {@link ParameterDescriptor#ignored()}. This will prevent it from
69+
* appearing 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 appearing
90-
* in the generated snippet while avoiding the failure described above.
89+
* marked as {@link ParameterDescriptor#ignored()}. This will prevent it from
90+
* appearing 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 appearing
142-
* in the generated snippet while avoiding the failure described above.
141+
* marked as {@link ParameterDescriptor#ignored()}. This will prevent it from
142+
* appearing 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 appearing
165-
* in the generated snippet while avoiding the failure described above.
164+
* marked as {@link ParameterDescriptor#ignored()}. This will prevent it from
165+
* appearing 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 appearing
221-
* in the generated snippet while avoiding the failure described above.
220+
* marked as {@link ParameterDescriptor#ignored()}. This will prevent it from
221+
* appearing 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 appearing
243-
* in the generated snippet while avoiding the failure described above.
242+
* marked as {@link ParameterDescriptor#ignored()}. This will prevent it from
243+
* appearing 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 appearing
298-
* in the generated snippet while avoiding the failure described above.
297+
* marked as {@link ParameterDescriptor#ignored()}. This will prevent it from
298+
* appearing 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 appearing
322-
* in the generated snippet while avoiding the failure described above.
321+
* marked as {@link ParameterDescriptor#ignored()}. This will prevent it from
322+
* appearing 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

0 commit comments

Comments
 (0)