clean up

Author: hauner

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/ApiOptions.kt

@@ -16,18 +16,18 @@ import io.openapiprocessor.core.support.Empty
 class ApiOptions: MappingSettings {
 
     /**
-     * the destination folder for generating interfaces & DTOs. This is the parent of the
+     * The destination folder for generating interfaces & DTOs. This is the parent of the
      * {@link #packageName} folder tree.
      */
     var targetDir: String? = null
 
     /**
-     * target-dir related options.
+     * target-dir-related options.
      */
     var targetDirOptions: TargetDirOptions = TargetDirOptions()
 
     /**
-     * the root package of the generated interfaces/model. The package folder tree will be created
+     * The root package of the generated interfaces/model. The package folder tree will be created
      * inside {@link #targetDir}. Interfaces and models will be placed into the "api" and "model"
      * subpackages of packageName:
      * - interfaces => "${packageName}.api"
@@ -47,7 +47,7 @@ class ApiOptions: MappingSettings {
     val packageValidation get() = "${packageName}.${packageNameValidation}"
 
     /**
-     * enable Bean Validation (JSR303) annotations. Default is false (disabled)
+     * Enable Bean Validation (JSR303) annotations. Default is false (disabled)
      */
     var beanValidation = false
 
@@ -57,7 +57,7 @@ class ApiOptions: MappingSettings {
     var beanValidationFormat: String? = null
 
     /**
-     * enable/disable generation of javadoc comments based on the `description` OpenAPI property.
+     * enable/disable generation of Javadoc comments based on the `description` OpenAPI property.
      *
      * *experimental*
      */
@@ -121,12 +121,12 @@ class ApiOptions: MappingSettings {
     var generatedDate = true
 
     /**
-     * add json property annotation: always/auto (optional).
+     * add JSON property annotation: always/auto (optional).
      */
     var jsonPropertyAnnotation = JsonPropertyAnnotationMode.Always
 
     /**
-     * base path related options
+     * base path-related options
      */
     var basePathOptions: BasePathOptions = BasePathOptions()
 
@@ -154,7 +154,7 @@ class ApiOptions: MappingSettings {
     // compatibility options
 
     /**
-     * add @Valid on reactive type and not on the wrapped type
+     * add @Valid on the reactive type and not on the wrapped type
      */
     var beanValidationValidOnReactive = true
 

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/processor/mapping/v2/Mapping.kt

@@ -10,7 +10,7 @@ import com.fasterxml.jackson.annotation.JsonProperty
 import io.openapiprocessor.core.processor.mapping.MappingVersion
 
 /**
- * *the* v2 Schema of the mapping yaml
+ * *the* v2 Schema of the mapping YAML
  */
 data class Mapping(
 

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/processor/mapping/v2/Options.kt

@@ -13,7 +13,7 @@ import io.openapiprocessor.core.support.Empty
 data class Options(
 
     /**
-     * the root package name of the generated interfaces & models (required)
+     * The root package name of the generated interfaces and models (required)
      *
      * Interfaces and models will be generated into the `api` and `model` subpackages of
      * `packageName`.
@@ -33,7 +33,7 @@ data class Options(
     val clearTargetDir: Boolean = true,
 
     /**
-     * target-dir related options.
+     * target-dir-related options.
      */
     val targetDir: TargetDir = TargetDir(),
 
@@ -68,7 +68,7 @@ data class Options(
     val modelNameSuffix: String = String.Empty,
 
     /**
-     * base path related options (optional)
+     * base path-related options (optional)
      */
     val basePath: BasePath = BasePath(),
 
@@ -78,7 +78,7 @@ data class Options(
     val oneOfInterface: Boolean = false,
 
     /**
-     * generate common interface for different responses of same content type (optional)
+     * generate a common interface for different responses of the same content type (optional)
      */
     val responseInterface: Boolean = false,
 

openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/support/OpenApiParser.kt

@@ -13,7 +13,7 @@ import io.openapiprocessor.test.parser.openapi4j.parse as parseWithOpenApi4j
 import io.openapiprocessor.test.parser.swagger.parse as parseWithSwagger
 
 /**
- * OpenAPI parser to read yaml from memory using the given parser.
+ * OpenAPI parser to read YAML from memory using the given parser.
  *
  * extract individual Schemas with the get...Schema() functions on the [ParserOpenApi] result.
  */