docs(autoconfigure): Follow Spring Boot JavaDoc guidelines

Signed-off-by: Thomas Vitale <[email protected]>

arconia-spring-boot-autoconfigure/src/main/java/io/arconia/autoconfigure/core/multitenancy/FixedTenantResolutionProperties.java

@@ -20,7 +20,7 @@ public class FixedTenantResolutionProperties {
  private boolean enabled = false;
 
  /**
- * The name of the fixed tenant to use in each context.
+ * Identifier of the fixed tenant to use in each context.
  */
  private String tenantId = FixedTenantResolver.DEFAULT_FIXED_TENANT;
 

arconia-spring-boot-autoconfigure/src/main/java/io/arconia/autoconfigure/core/multitenancy/TenantManagementProperties.java

@@ -41,7 +41,7 @@ public static class Mdc {
  private boolean enabled = true;
 
  /**
- * The key to use for including the tenant identifier information in MDC.
+ * Key to use for including the tenant identifier information in MDC.
  */
  private String key = MdcTenantContextEventListener.DEFAULT_TENANT_ID_KEY;
 
@@ -71,7 +71,7 @@ public static class Observations {
  private boolean enabled = true;
 
  /**
- * The key to use for including the tenant identifier information in observations.
+ * Key to use for including the tenant identifier information in observations.
  */
  private String key = ObservationTenantContextEventListener.DEFAULT_TENANT_ID_KEY;
 

arconia-spring-boot-autoconfigure/src/main/java/io/arconia/autoconfigure/web/multitenancy/HttpTenantResolutionProperties.java

@@ -23,7 +23,7 @@ public class HttpTenantResolutionProperties {
  private boolean enabled = true;
 
  /**
- * The HTTP type of resolution.
+ * Mode of HTTP resolution.
  */
  private HttpResolutionMode type = HttpResolutionMode.HEADER;
 
@@ -73,7 +73,7 @@ public Filter getFilter() {
  public static class Header {
 
  /**
- * The name of the HTTP header from which to resolve the current tenant.
+ * Name of the HTTP header from which to resolve the current tenant.
  */
  private String headerName = HeaderTenantResolver.DEFAULT_HEADER_NAME;
 
@@ -90,7 +90,7 @@ public void setHeaderName(String headerName) {
  public static class Cookie {
 
  /**
- * The name of the HTTP cookie from which to resolve the current tenant.
+ * Name of the HTTP cookie from which to resolve the current tenant.
  */
  private String cookieName = CookieTenantResolver.DEFAULT_COOKIE_NAME;
 
@@ -112,8 +112,8 @@ public static class Filter {
  private boolean enabled = true;
 
  /**
- * A list of HTTP request paths for which the tenant resolution will not be
- * performed.
+ * Comma-separated list of HTTP request paths for which the tenant resolution will
+ * not be performed.
  */
  private List<String> ignorePaths = List.of("/actuator/**", "/webjars/**", "/css/**", "/js/**", ".ico");