Skip to content

Commit 90673aa

Browse files
PakisanPakisan
committed
fix: JavaDoc
1 parent df17b80 commit 90673aa

File tree

5 files changed

+60
-67
lines changed

5 files changed

+60
-67
lines changed

‎asyncapi-core/src/main/java/com/asyncapi/v3/schema/AsyncAPISchema.java‎

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@
2626
* <p>
2727
* The empty schema (which allows any instance to validate) MAY be represented by the boolean value true
2828
* and a schema which allows no instance to validate MAY be represented by the boolean value false.
29-
* <p>
30-
* <p>
29+
* <br>
30+
* <br>
3131
* Further information about the properties can be found in <a href="https://tools.ietf.org/html/draft-handrews-json-schema-01">JSON Schema Core</a> and <a href="https://tools.ietf.org/html/draft-handrews-json-schema-validation-01">JSON Schema Validation</a>.
3232
* <p>
3333
* Unless stated otherwise, the property definitions follow the JSON Schema specification as referenced here.
@@ -37,7 +37,7 @@
3737
* @author Pavel Bodiachevskii
3838
* @version 3.0.0
3939
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#schemaObject">Schema Object</a>
40-
* @see <a href=https://www.asyncapi.com/docs/reference/specification/v3.0.0#multiFormatSchemaObject">Multi Format Schema Object</a>
40+
* @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#multiFormatSchemaObject">Multi Format Schema Object</a>
4141
*/
4242
@Data
4343
@Builder
@@ -449,10 +449,7 @@ Validation Keywords for Numeric Instances (number and integer)
449449
public Map<String, AsyncAPISchema> patternProperties;
450450

451451
/**
452-
* <font color="red"><b>This property has been overwritten by AsyncAPI Specification - maybe boolean value</b></font>
453-
* <p>
454-
* <p>
455-
* The value of "additionalProperties" MUST be a valid JSON Schema.
452+
* The value of "additionalProperties" <b>MUST</b> be a valid JSON Schema or boolean
456453
* <p>
457454
* This keyword determines how child instances validate for objects, and does not directly validate the immediate
458455
* instance itself.
@@ -477,9 +474,9 @@ Validation Keywords for Numeric Instances (number and integer)
477474
* draft, we proposed dropping the keyword altogether, or dropping one of its forms, but we received feedback in support of
478475
* keeping it. See issues #442 and #528 at https://github.com/json-schema-org/json-schema-spec/issues for further discussion.
479476
* Further feedback is encouraged.
480-
* <p>
481-
* <p>
482-
* <p>
477+
* <br>
478+
* <br>
479+
* <br>
483480
* This keyword specifies rules that are evaluated if the instance is an object and contains a certain property.
484481
* <p>
485482
* This keyword's value <b>MUST</b> be an object. Each property specifies a dependency. Each dependency value <b>MUST</b> be an array

‎asyncapi-core/src/main/java/com/asyncapi/v3/schema/JsonSchema.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -457,9 +457,9 @@ Validation Keywords for Numeric Instances (number and integer)
457457
* draft, we proposed dropping the keyword altogether, or dropping one of its forms, but we received feedback in support of
458458
* keeping it. See issues #442 and #528 at https://github.com/json-schema-org/json-schema-spec/issues for further discussion.
459459
* Further feedback is encouraged.
460-
* <p>
461-
* <p>
462-
* <p>
460+
* <br>
461+
* <br>
462+
* <br>
463463
* This keyword specifies rules that are evaluated if the instance is an object and contains a certain property.
464464
* <p>
465465
* This keyword's value <b>MUST</b> be an object. Each property specifies a dependency. Each dependency value <b>MUST</b> be an array

‎asyncapi-core/src/main/java/com/asyncapi/v3/schema/avro/v1/_9_0/AvroSchemaUnion.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@
1313
* Unions, as mentioned above, are represented using JSON arrays.
1414
* <p>
1515
* For example, ["null", "string"] declares a schema which may be either a null or string.
16-
* <p>
17-
* <p>
16+
* <br>
17+
* <br>
1818
* Note that when a default value is specified for a record field whose type is a union,
1919
* the type of the default value must match the first element of the union.
2020
* <p>
2121
* Thus, for unions containing "null", the "null" is usually listed first,
2222
* since the default value of such unions is typically null.
23-
* <p>
24-
* <p>
23+
* <br>
24+
* <br>
2525
* Unions may not contain more than one schema with the same type, except for the named types record, fixed and enum.
2626
* <p>
2727
* For example, unions containing two array types or two map types are not permitted, but two types with different names are permitted.

‎asyncapi-core/src/main/java/com/asyncapi/v3/schema/openapi/v3/_0_0/OpenAPISchema.java‎

Lines changed: 45 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -109,30 +109,28 @@ public class OpenAPISchema extends Extensions {
109109

110110
/**
111111
* The word “exclusive” in {@link #exclusiveMinimum} and {@link #exclusiveMaximum} means the corresponding boundary is excluded:
112-
* <pre>
113-
* <table>
114-
* <tr>
115-
* <th>Keyword</th>
116-
* <th>Description</th>
117-
* </tr>
118-
* <tr>
119-
* <td>exclusiveMinimum: false or not included</th>
120-
* <td>value ≥ minimum</th>
121-
* </tr>
122-
* <tr>
123-
* <td>exclusiveMinimum: true</th>
124-
* <td>value > minimum</th>
125-
* </tr>
126-
* <tr>
127-
* <td>exclusiveMaximum: false or not included</th>
128-
* <td>value ≤ maximum</th>
129-
* </tr>
130-
* <tr>
131-
* <td>exclusiveMaximum: true</th>
132-
* <td>value < maximum</th>
133-
* </tr>
134-
* </table>
135-
* </pre>
112+
* <table summary="exclusive description">
113+
* <tr>
114+
* <th>Keyword</th>
115+
* <th>Description</th>
116+
* </tr>
117+
* <tr>
118+
* <td>exclusiveMinimum: false or not included</td>
119+
* <td>value ≥ minimum</td>
120+
* </tr>
121+
* <tr>
122+
* <td>exclusiveMinimum: true</td>
123+
* <td>value &gt; minimum</td>
124+
* </tr>
125+
* <tr>
126+
* <td>exclusiveMaximum: false or not included</td>
127+
* <td>value ≤ maximum</td>
128+
* </tr>
129+
* <tr>
130+
* <td>exclusiveMaximum: true</td>
131+
* <td>value &lt; maximum</td>
132+
* </tr>
133+
* </table>
136134
*
137135
* @see <a href="https://swagger.io/docs/specification/data-models/data-types/#range">range</a>
138136
*/
@@ -168,30 +166,28 @@ public class OpenAPISchema extends Extensions {
168166

169167
/**
170168
* The word “exclusive” in {@link #exclusiveMinimum} and {@link #exclusiveMaximum} means the corresponding boundary is excluded:
171-
* <pre>
172-
* <table>
173-
* <tr>
174-
* <th>Keyword</th>
175-
* <th>Description</th>
176-
* </tr>
177-
* <tr>
178-
* <td>exclusiveMinimum: false or not included</th>
179-
* <td>value ≥ minimum</th>
180-
* </tr>
181-
* <tr>
182-
* <td>exclusiveMinimum: true</th>
183-
* <td>value > minimum</th>
184-
* </tr>
185-
* <tr>
186-
* <td>exclusiveMaximum: false or not included</th>
187-
* <td>value ≤ maximum</th>
188-
* </tr>
189-
* <tr>
190-
* <td>exclusiveMaximum: true</th>
191-
* <td>value < maximum</th>
192-
* </tr>
193-
* </table>
194-
* </pre>
169+
* <table summary="exclusive description">
170+
* <tr>
171+
* <th>Keyword</th>
172+
* <th>Description</th>
173+
* </tr>
174+
* <tr>
175+
* <td>exclusiveMinimum: false or not included</td>
176+
* <td>value ≥ minimum</td>
177+
* </tr>
178+
* <tr>
179+
* <td>exclusiveMinimum: true</td>
180+
* <td>value &gt; minimum</td>
181+
* </tr>
182+
* <tr>
183+
* <td>exclusiveMaximum: false or not included</td>
184+
* <td>value ≤ maximum</td>
185+
* </tr>
186+
* <tr>
187+
* <td>exclusiveMaximum: true</td>
188+
* <td>value &lt; maximum</td>
189+
* </tr>
190+
* </table>
195191
*
196192
* @see <a href="https://swagger.io/docs/specification/data-models/data-types/#range">range</a>
197193
*/
@@ -839,7 +835,7 @@ public class OpenAPISchema extends Extensions {
839835
* }</pre>
840836
*
841837
* — is represented in the following way in JSON and XML:
842-
* <br/>
838+
* <br>
843839
* <b>JSON</b>
844840
* <pre>{@code
845841
* {

‎asyncapi-core/src/main/java/com/asyncapi/v3/schema/openapi/v3/_0_0/properties/XML.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public class XML extends Extensions {
4646
public String namespace;
4747

4848
/**
49-
* The prefix to be used for the {@link #getName()}.
49+
* The prefix to be used for the {@link #name}.
5050
*
5151
* @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-22">XML Fixed Fields: prefix</a>
5252
*/

0 commit comments

Comments
 (0)