Skip to content

Commit c27a751

Browse files
docs: update format of javadoc to produce a functional link
1 parent 6e74355 commit c27a751

32 files changed

Lines changed: 59 additions & 57 deletions

modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Components.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
/**
1919
* Components
2020
*
21-
* @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#components-object"
22-
* @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#components-object"
21+
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#components-object">Components (OpenAPI 3.0 specification)</a>
22+
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#components-object">Components (OpenAPI 3.1 specification)</a>
2323
*/
2424

2525
public class Components {

modules/swagger-models/src/main/java/io/swagger/v3/oas/models/ExternalDocumentation.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
/**
88
* ExternalDocumentation
99
*
10-
* @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#external-documentation-object"
11-
* @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#external-documentation-object"
10+
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#external-documentation-object">ExternalDocumentation (OpenAPI 3.0 specification)</a>
11+
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#external-documentation-object">ExternalDocumentation (OpenAPI 3.1 specification)</a>
1212
*/
1313

1414
public class ExternalDocumentation {

modules/swagger-models/src/main/java/io/swagger/v3/oas/models/OpenAPI.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
/**
1919
* OpenAPI
2020
*
21-
* @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md"
22-
* @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md"
21+
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#openapi-object">OpenAPI (OpenAPI 3.0 specification)</a>
22+
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#openapi-object">OpenAPI (OpenAPI 3.1 specification)</a>
2323
*/
2424

2525
public class OpenAPI {

modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Operation.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
/**
1818
* Operation
1919
*
20-
* @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#operation-object"
21-
* @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#operation-object"
20+
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#operation-object">Operation (OpenAPI 3.0 specification)</a>
21+
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#operation-object">Operation (OpenAPI 3.1 specification)</a>
2222
*/
2323

2424
public class Operation {

modules/swagger-models/src/main/java/io/swagger/v3/oas/models/PathItem.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
/**
1313
* PathItem
1414
*
15-
* @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#path-item-object"
16-
* @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#path-item-object"
15+
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#path-item-object">PathItem (OpenAPI 3.0 specification)</a>
16+
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#path-item-object">PathItem (OpenAPI 3.1 specification)</a>
1717
*/
1818

1919
public class PathItem {

modules/swagger-models/src/main/java/io/swagger/v3/oas/models/Paths.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
/**
99
* Paths
1010
*
11-
* @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#paths-object"
12-
* @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#paths-object"
11+
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#paths-object">Paths (OpenAPI 3.0 specification)</a>
12+
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#paths-object">Paths (OpenAPI 3.1 specification)</a>
1313
*/
1414

1515
public class Paths extends LinkedHashMap<String, PathItem> {

modules/swagger-models/src/main/java/io/swagger/v3/oas/models/callbacks/Callback.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
/**
1010
* Callback
1111
*
12-
* @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#callback-object"
13-
* @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#callback-object"
12+
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#callback-object">Callback (OpenAPI 3.0 specification)</a>
13+
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#callback-object">Callback (OpenAPI 3.1 specification)</a>
1414
*/
1515

1616
public class Callback extends LinkedHashMap<String, PathItem> {

modules/swagger-models/src/main/java/io/swagger/v3/oas/models/examples/Example.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
/**
66
* Example
77
*
8-
* @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#example-object"
9-
* @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#example-object"
8+
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#example-object">Example (OpenAPI 3.0 specification)</a>
9+
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#example-object">Example (OpenAPI 3.1 specification)</a>
1010
*/
1111

1212
public class Example {

modules/swagger-models/src/main/java/io/swagger/v3/oas/models/headers/Header.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
/**
1212
* Header
1313
*
14-
* @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#header-object"
15-
* @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#header-object"
14+
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#header-object">Header (OpenAPI 3.0 specification)</a>
15+
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#header-object">Header (OpenAPI 3.1 specification)</a>
1616
*/
1717

1818
public class Header {

modules/swagger-models/src/main/java/io/swagger/v3/oas/models/info/Contact.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
/**
88
* Contact
99
*
10-
* @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#contact-object"
11-
* @see "https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#contact-object"
10+
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#contact-object">Contact (OpenAPI 3.0 specification)</a>
11+
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/3.1.1/versions/3.1.1.md#contact-object">Contact (OpenAPI 3.1 specification)</a>
1212
*/
1313

1414
public class Contact {

0 commit comments

Comments
 (0)