fix: JavaDoc

asyncapi · Apr 20, 2024 · 90673aa · 90673aa
1 parent df17b80
commit 90673aa
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 67 deletions.
diff --git a/asyncapi-core/src/main/java/com/asyncapi/v3/schema/AsyncAPISchema.java b/asyncapi-core/src/main/java/com/asyncapi/v3/schema/AsyncAPISchema.java
@@ -26,8 +26,8 @@
  * <p>
  * The empty schema (which allows any instance to validate) MAY be represented by the boolean value true
  * and a schema which allows no instance to validate MAY be represented by the boolean value false.
- * <p>
- * <p>
+ * <br>
+ * <br>
  * 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>.
  * <p>
  * Unless stated otherwise, the property definitions follow the JSON Schema specification as referenced here.
@@ -37,7 +37,7 @@
  * @author Pavel Bodiachevskii
  * @version 3.0.0
  * @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#schemaObject">Schema Object</a>
- * @see <a href=https://www.asyncapi.com/docs/reference/specification/v3.0.0#multiFormatSchemaObject">Multi Format Schema Object</a>
+ * @see <a href="https://www.asyncapi.com/docs/reference/specification/v3.0.0#multiFormatSchemaObject">Multi Format Schema Object</a>
  */
 @Data
 @Builder
@@ -449,10 +449,7 @@ Validation Keywords for Numeric Instances (number and integer)
     public Map<String, AsyncAPISchema> patternProperties;
 
     /**
-     * <font color="red"><b>This property has been overwritten by AsyncAPI Specification - maybe boolean value</b></font>
-     * <p>
-     * <p>
-     * The value of "additionalProperties" MUST be a valid JSON Schema.
+     * The value of "additionalProperties" <b>MUST</b> be a valid JSON Schema or boolean
      * <p>
      * This keyword determines how child instances validate for objects, and does not directly validate the immediate
      * instance itself.
@@ -477,9 +474,9 @@ Validation Keywords for Numeric Instances (number and integer)
      * draft, we proposed dropping the keyword altogether, or dropping one of its forms, but we received feedback in support of
      * keeping it.  See issues #442 and #528 at https://github.com/json-schema-org/json-schema-spec/issues for further discussion.
      * Further feedback is encouraged.
-     * <p>
-     * <p>
-     * <p>
+     * <br>
+     * <br>
+     * <br>
      * This keyword specifies rules that are evaluated if the instance is an object and contains a certain property.
      * <p>
      * This keyword's value <b>MUST</b> be an object. Each property specifies a dependency. Each dependency value <b>MUST</b> be an array

diff --git a/asyncapi-core/src/main/java/com/asyncapi/v3/schema/JsonSchema.java b/asyncapi-core/src/main/java/com/asyncapi/v3/schema/JsonSchema.java
@@ -457,9 +457,9 @@ Validation Keywords for Numeric Instances (number and integer)
      * draft, we proposed dropping the keyword altogether, or dropping one of its forms, but we received feedback in support of
      * keeping it.  See issues #442 and #528 at https://github.com/json-schema-org/json-schema-spec/issues for further discussion.
      * Further feedback is encouraged.
-     * <p>
-     * <p>
-     * <p>
+     * <br>
+     * <br>
+     * <br>
      * This keyword specifies rules that are evaluated if the instance is an object and contains a certain property.
      * <p>
      * This keyword's value <b>MUST</b> be an object. Each property specifies a dependency. Each dependency value <b>MUST</b> be an array

diff --git a/asyncapi-core/src/main/java/com/asyncapi/v3/schema/avro/v1/_9_0/AvroSchemaUnion.java b/asyncapi-core/src/main/java/com/asyncapi/v3/schema/avro/v1/_9_0/AvroSchemaUnion.java
@@ -13,15 +13,15 @@
  * Unions, as mentioned above, are represented using JSON arrays.
  * <p>
  * For example, ["null", "string"] declares a schema which may be either a null or string.
- * <p>
- * <p>
+ * <br>
+ * <br>
  * Note that when a default value is specified for a record field whose type is a union,
  * the type of the default value must match the first element of the union.
  * <p>
  * Thus, for unions containing "null", the "null" is usually listed first,
  * since the default value of such unions is typically null.
- * <p>
- * <p>
+ * <br>
+ * <br>
  * Unions may not contain more than one schema with the same type, except for the named types record, fixed and enum.
  * <p>
  * For example, unions containing two array types or two map types are not permitted, but two types with different names are permitted.

diff --git a/asyncapi-core/src/main/java/com/asyncapi/v3/schema/openapi/v3/_0_0/OpenAPISchema.java b/asyncapi-core/src/main/java/com/asyncapi/v3/schema/openapi/v3/_0_0/OpenAPISchema.java
@@ -109,30 +109,28 @@ public class OpenAPISchema extends Extensions {
 
     /**
      * The word “exclusive” in {@link #exclusiveMinimum} and {@link #exclusiveMaximum} means the corresponding boundary is excluded:
-     * <pre>
-     *     <table>
-     *         <tr>
-     *             <th>Keyword</th>
-     *             <th>Description</th>
-     *         </tr>
-     *         <tr>
-     *             <td>exclusiveMinimum: false or not included</th>
-     *             <td>value ≥ minimum</th>
-     *         </tr>
-     *         <tr>
-     *             <td>exclusiveMinimum: true</th>
-     *             <td>value > minimum</th>
-     *         </tr>
-     *         <tr>
-     *             <td>exclusiveMaximum: false or not included</th>
-     *             <td>value ≤ maximum</th>
-     *         </tr>
-     *         <tr>
-     *             <td>exclusiveMaximum: true</th>
-     *             <td>value < maximum</th>
-     *         </tr>
-     *     </table>
-     * </pre>
+     * <table summary="exclusive description">
+     *     <tr>
+     *         <th>Keyword</th>
+     *         <th>Description</th>
+     *     </tr>
+     *     <tr>
+     *         <td>exclusiveMinimum: false or not included</td>
+     *         <td>value ≥ minimum</td>
+     *     </tr>
+     *     <tr>
+     *         <td>exclusiveMinimum: true</td>
+     *         <td>value &gt; minimum</td>
+     *     </tr>
+     *     <tr>
+     *         <td>exclusiveMaximum: false or not included</td>
+     *         <td>value ≤ maximum</td>
+     *     </tr>
+     *     <tr>
+     *         <td>exclusiveMaximum: true</td>
+     *         <td>value &lt; maximum</td>
+     *     </tr>
+     * </table>
      *
      * @see <a href="https://swagger.io/docs/specification/data-models/data-types/#range">range</a>
      */
@@ -168,30 +166,28 @@ public class OpenAPISchema extends Extensions {
 
     /**
      * The word “exclusive” in {@link #exclusiveMinimum} and {@link #exclusiveMaximum} means the corresponding boundary is excluded:
-     * <pre>
-     *     <table>
-     *         <tr>
-     *             <th>Keyword</th>
-     *             <th>Description</th>
-     *         </tr>
-     *         <tr>
-     *             <td>exclusiveMinimum: false or not included</th>
-     *             <td>value ≥ minimum</th>
-     *         </tr>
-     *         <tr>
-     *             <td>exclusiveMinimum: true</th>
-     *             <td>value > minimum</th>
-     *         </tr>
-     *         <tr>
-     *             <td>exclusiveMaximum: false or not included</th>
-     *             <td>value ≤ maximum</th>
-     *         </tr>
-     *         <tr>
-     *             <td>exclusiveMaximum: true</th>
-     *             <td>value < maximum</th>
-     *         </tr>
-     *     </table>
-     * </pre>
+     * <table summary="exclusive description">
+     *     <tr>
+     *         <th>Keyword</th>
+     *         <th>Description</th>
+     *     </tr>
+     *     <tr>
+     *         <td>exclusiveMinimum: false or not included</td>
+     *         <td>value ≥ minimum</td>
+     *     </tr>
+     *     <tr>
+     *         <td>exclusiveMinimum: true</td>
+     *         <td>value &gt; minimum</td>
+     *     </tr>
+     *     <tr>
+     *         <td>exclusiveMaximum: false or not included</td>
+     *         <td>value ≤ maximum</td>
+     *     </tr>
+     *     <tr>
+     *         <td>exclusiveMaximum: true</td>
+     *         <td>value &lt; maximum</td>
+     *     </tr>
+     * </table>
      *
      * @see <a href="https://swagger.io/docs/specification/data-models/data-types/#range">range</a>
      */
@@ -839,7 +835,7 @@ public class OpenAPISchema extends Extensions {
      * }</pre>
      *
      * — is represented in the following way in JSON and XML:
-     * <br/>
+     * <br>
      * <b>JSON</b>
      * <pre>{@code
      * {

diff --git a/asyncapi-core/src/main/java/com/asyncapi/v3/schema/openapi/v3/_0_0/properties/XML.java b/asyncapi-core/src/main/java/com/asyncapi/v3/schema/openapi/v3/_0_0/properties/XML.java
@@ -46,7 +46,7 @@ public class XML extends Extensions {
     public String namespace;
 
     /**
-     * The prefix to be used for the {@link #getName()}.
+     * The prefix to be used for the {@link #name}.
      *
      * @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#fixed-fields-22">XML Fixed Fields: prefix</a>
      */