From 9ae1f0bb604e13496c284d67ef508c258d785122 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ruggero=20D=27Al=C3=B2?= Date: Sun, 1 Dec 2024 16:02:16 +0100 Subject: [PATCH] feat(core): Sort PropertyGroups by groupName --- .../core/generator/reader/MetadataReader.java | 2 + .../single-module-test/compact-mode.adoc | 30 ++-- .../single-module-test/compact-mode.html | 52 +++--- .../single-module-test/compact-mode.md | 12 +- .../exclude-group-sample.adoc | 94 +++++------ .../exclude-property-sample.adoc | 144 ++++++++-------- .../include-property-sample.adoc | 70 ++++---- .../single-module-example-property-docs.adoc | 144 ++++++++-------- .../single-module-example-property-docs.html | 156 +++++++++--------- .../single-module-example-property-docs.md | 42 ++--- .../without-type-and-deprecation.adoc | 126 +++++++------- .../without-type-and-deprecation.html | 114 ++++++------- .../without-type-and-deprecation.md | 42 ++--- 13 files changed, 515 insertions(+), 513 deletions(-) diff --git a/spring-configuration-property-documenter-core/src/main/java/org/rodnansol/core/generator/reader/MetadataReader.java b/spring-configuration-property-documenter-core/src/main/java/org/rodnansol/core/generator/reader/MetadataReader.java index d513a5a..c3d2732 100644 --- a/spring-configuration-property-documenter-core/src/main/java/org/rodnansol/core/generator/reader/MetadataReader.java +++ b/spring-configuration-property-documenter-core/src/main/java/org/rodnansol/core/generator/reader/MetadataReader.java @@ -14,6 +14,7 @@ import java.io.InputStream; import java.util.ArrayList; import java.util.Collection; +import java.util.Comparator; import java.util.List; import java.util.Map; import java.util.Objects; @@ -99,6 +100,7 @@ private List flattenValues(Map> prope return propertyGroupsByType.values() .stream() .flatMap(Collection::stream) + .sorted(Comparator.comparing(PropertyGroup::getGroupName)) .collect(Collectors.toList()); } diff --git a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/compact-mode.adoc b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/compact-mode.adoc index 0d0ff18..8250bfa 100644 --- a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/compact-mode.adoc +++ b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/compact-mode.adoc @@ -10,26 +10,11 @@ |Key |Type |Description |Default value |Deprecation -|this.is.your.property -|java.lang.String -|This is YOUR property. -| -| |this.is.a.bean.configuration.configuration-value |java.lang.String |A field inside a class that is not property by default by within a Configuration class. | | -|this.is.my.nested.nested-value -|java.lang.String -|Nested value. -| -| -|this.is.my.first-level-nested-property.second-level-nested-class.second-level-value -|java.lang.String -|Custom nested -| -| |this.is.my.another-variable |java.lang.String | @@ -70,6 +55,21 @@ |Name of the custom property. |ABC | +|this.is.my.first-level-nested-property.second-level-nested-class.second-level-value +|java.lang.String +|Custom nested +| +| +|this.is.my.nested.nested-value +|java.lang.String +|Nested value. +| +| +|this.is.your.property +|java.lang.String +|This is YOUR property. +| +| |=== diff --git a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/compact-mode.html b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/compact-mode.html index e2cba32..47d8445 100644 --- a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/compact-mode.html +++ b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/compact-mode.html @@ -139,17 +139,17 @@

single-module-example

  • Unknown group - Unknown
    • -
  • this.is.your - org.rodnansol.YourProperties
    • -
  • this.is.a.bean.configuration - org.rodnansol.PropertiesForConfiguration
    • -
  • this.is.my.nested - org.rodnansol.TopLevelClassNestedProperty
    • +
  • this.is.my - org.rodnansol.MyProperties
    • + +
  • this.is.my.first-level-nested-property - org.rodnansol.FirstLevelNestedProperty
  • this.is.my.first-level-nested-property.second-level-nested-class - org.rodnansol.FirstLevelNestedProperty$SecondLevelNestedClass
    • -
  • this.is.my - org.rodnansol.MyProperties
    • +
  • this.is.my.nested - org.rodnansol.TopLevelClassNestedProperty
    • -
  • this.is.my.first-level-nested-property - org.rodnansol.FirstLevelNestedProperty
    • +
  • this.is.your - org.rodnansol.YourProperties
    • @@ -171,13 +171,6 @@

    single-module-example

    - - this.is.your.property - java.lang.String - This is YOUR property. - - - this.is.a.bean.configuration.configuration-value java.lang.String @@ -185,20 +178,6 @@

    single-module-example

    - - this.is.my.nested.nested-value - java.lang.String - Nested value. - - - - - this.is.my.first-level-nested-property.second-level-nested-class.second-level-value - java.lang.String - Custom nested - - - this.is.my.another-variable java.lang.String @@ -255,6 +234,27 @@

    single-module-example

    ABC + + this.is.my.first-level-nested-property.second-level-nested-class.second-level-value + java.lang.String + Custom nested + + + + + this.is.my.nested.nested-value + java.lang.String + Nested value. + + + + + this.is.your.property + java.lang.String + This is YOUR property. + + +
    diff --git a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/compact-mode.md b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/compact-mode.md index 5040be3..160a23c 100644 --- a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/compact-mode.md +++ b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/compact-mode.md @@ -1,19 +1,16 @@ # single-module-example ## Table of Contents * [**Unknown group** - `Unknown`](#Unknown group) -* [**this.is.your** - `org.rodnansol.YourProperties`](#this.is.your) * [**this.is.a.bean.configuration** - `org.rodnansol.PropertiesForConfiguration`](#this.is.a.bean.configuration) -* [**this.is.my.nested** - `org.rodnansol.TopLevelClassNestedProperty`](#this.is.my.nested) -* [**this.is.my.first-level-nested-property.second-level-nested-class** - `org.rodnansol.FirstLevelNestedProperty$SecondLevelNestedClass`](#this.is.my.first-level-nested-property.second-level-nested-class) * [**this.is.my** - `org.rodnansol.MyProperties`](#this.is.my) * [**this.is.my.first-level-nested-property** - `org.rodnansol.FirstLevelNestedProperty`](#this.is.my.first-level-nested-property) +* [**this.is.my.first-level-nested-property.second-level-nested-class** - `org.rodnansol.FirstLevelNestedProperty$SecondLevelNestedClass`](#this.is.my.first-level-nested-property.second-level-nested-class) +* [**this.is.my.nested** - `org.rodnansol.TopLevelClassNestedProperty`](#this.is.my.nested) +* [**this.is.your** - `org.rodnansol.YourProperties`](#this.is.your) |Key|Type|Description|Default value|Deprecation| |---|----|-----------|-------------|-----------| -| this.is.your.property| java.lang.String| This is YOUR property.| | | | this.is.a.bean.configuration.configuration-value| java.lang.String| A field inside a class that is not property by default by within a Configuration class.| | | -| this.is.my.nested.nested-value| java.lang.String| Nested value.| | | -| this.is.my.first-level-nested-property.second-level-nested-class.second-level-value| java.lang.String| Custom nested| | | | this.is.my.another-variable| java.lang.String| | with default value| Reason: null, use for replacement: null| | this.is.my.date| java.time.LocalDate| | | | | this.is.my.date-time| java.time.LocalDateTime| | | | @@ -22,4 +19,7 @@ | this.is.my.variable| java.lang.String| This is my variable.| | | | this.is.my.first-level-nested-property.desc| java.lang.String| Description of this thing.| 123| | | this.is.my.first-level-nested-property.name| java.lang.String| Name of the custom property.| ABC| | +| this.is.my.first-level-nested-property.second-level-nested-class.second-level-value| java.lang.String| Custom nested| | | +| this.is.my.nested.nested-value| java.lang.String| Nested value.| | | +| this.is.your.property| java.lang.String| This is YOUR property.| | | diff --git a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/exclude-group-sample.adoc b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/exclude-group-sample.adoc index 7dae794..b5a57c3 100644 --- a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/exclude-group-sample.adoc +++ b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/exclude-group-sample.adoc @@ -22,30 +22,6 @@ endif::[] |=== // end::Unknown group[] -// tag::this.is.your[] -ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.your +] -ifdef::property-group-simple-title[.*_this.is.your_* +] -ifdef::property-group-discrete-heading[] -[discrete] -=== this.is.your -endif::[] -*Class:* `org.rodnansol.YourProperties` -[cols="2,1,3,1,1,1"] -|=== -|Key |Type |Description |Default value |Deprecation|Environment variable - - -|property -|java.lang.String -|This is YOUR property. -| -| -|`THIS_IS_YOUR_PROPERTY` - - -|=== -// end::this.is.your[] - // tag::this.is.a.bean.configuration[] ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.a.bean.configuration +] ifdef::property-group-simple-title[.*_this.is.a.bean.configuration_* +] @@ -70,29 +46,36 @@ endif::[] |=== // end::this.is.a.bean.configuration[] -// tag::this.is.my.nested[] -ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.nested +] -ifdef::property-group-simple-title[.*_this.is.my.nested_* +] +// tag::this.is.my.first-level-nested-property[] +ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.first-level-nested-property +] +ifdef::property-group-simple-title[.*_this.is.my.first-level-nested-property_* +] ifdef::property-group-discrete-heading[] [discrete] -=== this.is.my.nested +=== this.is.my.first-level-nested-property endif::[] -*Class:* `org.rodnansol.TopLevelClassNestedProperty` +*Class:* `org.rodnansol.FirstLevelNestedProperty` [cols="2,1,3,1,1,1"] |=== |Key |Type |Description |Default value |Deprecation|Environment variable -|nested-value +|desc |java.lang.String -|Nested value. +|Description of this thing. +|123 | +|`THIS_IS_MY_FIRSTLEVELNESTEDPROPERTY_DESC` + +|name +|java.lang.String +|Name of the custom property. +|ABC | -|`THIS_IS_MY_NESTED_NESTEDVALUE` +|`THIS_IS_MY_FIRSTLEVELNESTEDPROPERTY_NAME` |=== -// end::this.is.my.nested[] +// end::this.is.my.first-level-nested-property[] // tag::this.is.my.first-level-nested-property.second-level-nested-class[] ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.first-level-nested-property.second-level-nested-class +] @@ -118,35 +101,52 @@ endif::[] |=== // end::this.is.my.first-level-nested-property.second-level-nested-class[] -// tag::this.is.my.first-level-nested-property[] -ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.first-level-nested-property +] -ifdef::property-group-simple-title[.*_this.is.my.first-level-nested-property_* +] +// tag::this.is.my.nested[] +ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.nested +] +ifdef::property-group-simple-title[.*_this.is.my.nested_* +] ifdef::property-group-discrete-heading[] [discrete] -=== this.is.my.first-level-nested-property +=== this.is.my.nested endif::[] -*Class:* `org.rodnansol.FirstLevelNestedProperty` +*Class:* `org.rodnansol.TopLevelClassNestedProperty` [cols="2,1,3,1,1,1"] |=== |Key |Type |Description |Default value |Deprecation|Environment variable -|desc +|nested-value |java.lang.String -|Description of this thing. -|123 +|Nested value. | -|`THIS_IS_MY_FIRSTLEVELNESTEDPROPERTY_DESC` +| +|`THIS_IS_MY_NESTED_NESTEDVALUE` -|name + +|=== +// end::this.is.my.nested[] + +// tag::this.is.your[] +ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.your +] +ifdef::property-group-simple-title[.*_this.is.your_* +] +ifdef::property-group-discrete-heading[] +[discrete] +=== this.is.your +endif::[] +*Class:* `org.rodnansol.YourProperties` +[cols="2,1,3,1,1,1"] +|=== +|Key |Type |Description |Default value |Deprecation|Environment variable + + +|property |java.lang.String -|Name of the custom property. -|ABC +|This is YOUR property. | -|`THIS_IS_MY_FIRSTLEVELNESTEDPROPERTY_NAME` +| +|`THIS_IS_YOUR_PROPERTY` |=== -// end::this.is.my.first-level-nested-property[] +// end::this.is.your[] diff --git a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/exclude-property-sample.adoc b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/exclude-property-sample.adoc index ad6f3cc..ecf87f4 100644 --- a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/exclude-property-sample.adoc +++ b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/exclude-property-sample.adoc @@ -22,30 +22,6 @@ endif::[] |=== // end::Unknown group[] -// tag::this.is.your[] -ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.your +] -ifdef::property-group-simple-title[.*_this.is.your_* +] -ifdef::property-group-discrete-heading[] -[discrete] -=== this.is.your -endif::[] -*Class:* `org.rodnansol.YourProperties` -[cols="2,1,3,1,1,1"] -|=== -|Key |Type |Description |Default value |Deprecation|Environment variable - - -|property -|java.lang.String -|This is YOUR property. -| -| -|`THIS_IS_YOUR_PROPERTY` - - -|=== -// end::this.is.your[] - // tag::this.is.a.bean.configuration[] ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.a.bean.configuration +] ifdef::property-group-simple-title[.*_this.is.a.bean.configuration_* +] @@ -63,54 +39,6 @@ endif::[] |=== // end::this.is.a.bean.configuration[] -// tag::this.is.my.nested[] -ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.nested +] -ifdef::property-group-simple-title[.*_this.is.my.nested_* +] -ifdef::property-group-discrete-heading[] -[discrete] -=== this.is.my.nested -endif::[] -*Class:* `org.rodnansol.TopLevelClassNestedProperty` -[cols="2,1,3,1,1,1"] -|=== -|Key |Type |Description |Default value |Deprecation|Environment variable - - -|nested-value -|java.lang.String -|Nested value. -| -| -|`THIS_IS_MY_NESTED_NESTEDVALUE` - - -|=== -// end::this.is.my.nested[] - -// tag::this.is.my.first-level-nested-property.second-level-nested-class[] -ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.first-level-nested-property.second-level-nested-class +] -ifdef::property-group-simple-title[.*_this.is.my.first-level-nested-property.second-level-nested-class_* +] -ifdef::property-group-discrete-heading[] -[discrete] -=== this.is.my.first-level-nested-property.second-level-nested-class -endif::[] -*Class:* `org.rodnansol.FirstLevelNestedProperty$SecondLevelNestedClass` -[cols="2,1,3,1,1,1"] -|=== -|Key |Type |Description |Default value |Deprecation|Environment variable - - -|second-level-value -|java.lang.String -|Custom nested -| -| -|`THIS_IS_MY_FIRSTLEVELNESTEDPROPERTY_SECONDLEVELNESTEDCLASS_SECONDLEVELVALUE` - - -|=== -// end::this.is.my.first-level-nested-property.second-level-nested-class[] - // tag::this.is.my[] ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my +] ifdef::property-group-simple-title[.*_this.is.my_* +] @@ -201,4 +129,76 @@ endif::[] |=== // end::this.is.my.first-level-nested-property[] +// tag::this.is.my.first-level-nested-property.second-level-nested-class[] +ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.first-level-nested-property.second-level-nested-class +] +ifdef::property-group-simple-title[.*_this.is.my.first-level-nested-property.second-level-nested-class_* +] +ifdef::property-group-discrete-heading[] +[discrete] +=== this.is.my.first-level-nested-property.second-level-nested-class +endif::[] +*Class:* `org.rodnansol.FirstLevelNestedProperty$SecondLevelNestedClass` +[cols="2,1,3,1,1,1"] +|=== +|Key |Type |Description |Default value |Deprecation|Environment variable + + +|second-level-value +|java.lang.String +|Custom nested +| +| +|`THIS_IS_MY_FIRSTLEVELNESTEDPROPERTY_SECONDLEVELNESTEDCLASS_SECONDLEVELVALUE` + + +|=== +// end::this.is.my.first-level-nested-property.second-level-nested-class[] + +// tag::this.is.my.nested[] +ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.nested +] +ifdef::property-group-simple-title[.*_this.is.my.nested_* +] +ifdef::property-group-discrete-heading[] +[discrete] +=== this.is.my.nested +endif::[] +*Class:* `org.rodnansol.TopLevelClassNestedProperty` +[cols="2,1,3,1,1,1"] +|=== +|Key |Type |Description |Default value |Deprecation|Environment variable + + +|nested-value +|java.lang.String +|Nested value. +| +| +|`THIS_IS_MY_NESTED_NESTEDVALUE` + + +|=== +// end::this.is.my.nested[] + +// tag::this.is.your[] +ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.your +] +ifdef::property-group-simple-title[.*_this.is.your_* +] +ifdef::property-group-discrete-heading[] +[discrete] +=== this.is.your +endif::[] +*Class:* `org.rodnansol.YourProperties` +[cols="2,1,3,1,1,1"] +|=== +|Key |Type |Description |Default value |Deprecation|Environment variable + + +|property +|java.lang.String +|This is YOUR property. +| +| +|`THIS_IS_YOUR_PROPERTY` + + +|=== +// end::this.is.your[] + diff --git a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/include-property-sample.adoc b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/include-property-sample.adoc index 491bf7d..5354207 100644 --- a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/include-property-sample.adoc +++ b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/include-property-sample.adoc @@ -22,23 +22,6 @@ endif::[] |=== // end::Unknown group[] -// tag::this.is.your[] -ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.your +] -ifdef::property-group-simple-title[.*_this.is.your_* +] -ifdef::property-group-discrete-heading[] -[discrete] -=== this.is.your -endif::[] -*Class:* `org.rodnansol.YourProperties` -[cols="2,1,3,1,1,1"] -|=== -|Key |Type |Description |Default value |Deprecation|Environment variable - - - -|=== -// end::this.is.your[] - // tag::this.is.a.bean.configuration[] ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.a.bean.configuration +] ifdef::property-group-simple-title[.*_this.is.a.bean.configuration_* +] @@ -63,14 +46,14 @@ endif::[] |=== // end::this.is.a.bean.configuration[] -// tag::this.is.my.nested[] -ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.nested +] -ifdef::property-group-simple-title[.*_this.is.my.nested_* +] +// tag::this.is.my[] +ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my +] +ifdef::property-group-simple-title[.*_this.is.my_* +] ifdef::property-group-discrete-heading[] [discrete] -=== this.is.my.nested +=== this.is.my endif::[] -*Class:* `org.rodnansol.TopLevelClassNestedProperty` +*Class:* `org.rodnansol.MyProperties` [cols="2,1,3,1,1,1"] |=== |Key |Type |Description |Default value |Deprecation|Environment variable @@ -78,7 +61,24 @@ endif::[] |=== -// end::this.is.my.nested[] +// end::this.is.my[] + +// tag::this.is.my.first-level-nested-property[] +ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.first-level-nested-property +] +ifdef::property-group-simple-title[.*_this.is.my.first-level-nested-property_* +] +ifdef::property-group-discrete-heading[] +[discrete] +=== this.is.my.first-level-nested-property +endif::[] +*Class:* `org.rodnansol.FirstLevelNestedProperty` +[cols="2,1,3,1,1,1"] +|=== +|Key |Type |Description |Default value |Deprecation|Environment variable + + + +|=== +// end::this.is.my.first-level-nested-property[] // tag::this.is.my.first-level-nested-property.second-level-nested-class[] ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.first-level-nested-property.second-level-nested-class +] @@ -97,14 +97,14 @@ endif::[] |=== // end::this.is.my.first-level-nested-property.second-level-nested-class[] -// tag::this.is.my[] -ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my +] -ifdef::property-group-simple-title[.*_this.is.my_* +] +// tag::this.is.my.nested[] +ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.nested +] +ifdef::property-group-simple-title[.*_this.is.my.nested_* +] ifdef::property-group-discrete-heading[] [discrete] -=== this.is.my +=== this.is.my.nested endif::[] -*Class:* `org.rodnansol.MyProperties` +*Class:* `org.rodnansol.TopLevelClassNestedProperty` [cols="2,1,3,1,1,1"] |=== |Key |Type |Description |Default value |Deprecation|Environment variable @@ -112,16 +112,16 @@ endif::[] |=== -// end::this.is.my[] +// end::this.is.my.nested[] -// tag::this.is.my.first-level-nested-property[] -ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.first-level-nested-property +] -ifdef::property-group-simple-title[.*_this.is.my.first-level-nested-property_* +] +// tag::this.is.your[] +ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.your +] +ifdef::property-group-simple-title[.*_this.is.your_* +] ifdef::property-group-discrete-heading[] [discrete] -=== this.is.my.first-level-nested-property +=== this.is.your endif::[] -*Class:* `org.rodnansol.FirstLevelNestedProperty` +*Class:* `org.rodnansol.YourProperties` [cols="2,1,3,1,1,1"] |=== |Key |Type |Description |Default value |Deprecation|Environment variable @@ -129,6 +129,6 @@ endif::[] |=== -// end::this.is.my.first-level-nested-property[] +// end::this.is.your[] diff --git a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/property-docs/single-module-example-property-docs.adoc b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/property-docs/single-module-example-property-docs.adoc index a8e4e0a..1fa585c 100644 --- a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/property-docs/single-module-example-property-docs.adoc +++ b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/property-docs/single-module-example-property-docs.adoc @@ -22,30 +22,6 @@ endif::[] |=== // end::Random name for the Unknown group[] -// tag::this.is.your[] -ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.your +] -ifdef::property-group-simple-title[.*_this.is.your_* +] -ifdef::property-group-discrete-heading[] -[discrete] -=== this.is.your -endif::[] -*Class:* `org.rodnansol.YourProperties` -[cols="2,1,3,1,1,1"] -|=== -|Key |Type |Description |Default value |Deprecation|Environment variable - - -|property -|java.lang.String -|This is YOUR property. -| -| -|`THIS_IS_YOUR_PROPERTY` - - -|=== -// end::this.is.your[] - // tag::this.is.a.bean.configuration[] ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.a.bean.configuration +] ifdef::property-group-simple-title[.*_this.is.a.bean.configuration_* +] @@ -70,54 +46,6 @@ endif::[] |=== // end::this.is.a.bean.configuration[] -// tag::this.is.my.nested[] -ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.nested +] -ifdef::property-group-simple-title[.*_this.is.my.nested_* +] -ifdef::property-group-discrete-heading[] -[discrete] -=== this.is.my.nested -endif::[] -*Class:* `org.rodnansol.TopLevelClassNestedProperty` -[cols="2,1,3,1,1,1"] -|=== -|Key |Type |Description |Default value |Deprecation|Environment variable - - -|nested-value -|java.lang.String -|Nested value. -| -| -|`THIS_IS_MY_NESTED_NESTEDVALUE` - - -|=== -// end::this.is.my.nested[] - -// tag::this.is.my.first-level-nested-property.second-level-nested-class[] -ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.first-level-nested-property.second-level-nested-class +] -ifdef::property-group-simple-title[.*_this.is.my.first-level-nested-property.second-level-nested-class_* +] -ifdef::property-group-discrete-heading[] -[discrete] -=== this.is.my.first-level-nested-property.second-level-nested-class -endif::[] -*Class:* `org.rodnansol.FirstLevelNestedProperty$SecondLevelNestedClass` -[cols="2,1,3,1,1,1"] -|=== -|Key |Type |Description |Default value |Deprecation|Environment variable - - -|second-level-value -|java.lang.String -|Custom nested -| -| -|`THIS_IS_MY_FIRSTLEVELNESTEDPROPERTY_SECONDLEVELNESTEDCLASS_SECONDLEVELVALUE` - - -|=== -// end::this.is.my.first-level-nested-property.second-level-nested-class[] - // tag::this.is.my[] ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my +] ifdef::property-group-simple-title[.*_this.is.my_* +] @@ -208,4 +136,76 @@ endif::[] |=== // end::this.is.my.first-level-nested-property[] +// tag::this.is.my.first-level-nested-property.second-level-nested-class[] +ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.first-level-nested-property.second-level-nested-class +] +ifdef::property-group-simple-title[.*_this.is.my.first-level-nested-property.second-level-nested-class_* +] +ifdef::property-group-discrete-heading[] +[discrete] +=== this.is.my.first-level-nested-property.second-level-nested-class +endif::[] +*Class:* `org.rodnansol.FirstLevelNestedProperty$SecondLevelNestedClass` +[cols="2,1,3,1,1,1"] +|=== +|Key |Type |Description |Default value |Deprecation|Environment variable + + +|second-level-value +|java.lang.String +|Custom nested +| +| +|`THIS_IS_MY_FIRSTLEVELNESTEDPROPERTY_SECONDLEVELNESTEDCLASS_SECONDLEVELVALUE` + + +|=== +// end::this.is.my.first-level-nested-property.second-level-nested-class[] + +// tag::this.is.my.nested[] +ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.nested +] +ifdef::property-group-simple-title[.*_this.is.my.nested_* +] +ifdef::property-group-discrete-heading[] +[discrete] +=== this.is.my.nested +endif::[] +*Class:* `org.rodnansol.TopLevelClassNestedProperty` +[cols="2,1,3,1,1,1"] +|=== +|Key |Type |Description |Default value |Deprecation|Environment variable + + +|nested-value +|java.lang.String +|Nested value. +| +| +|`THIS_IS_MY_NESTED_NESTEDVALUE` + + +|=== +// end::this.is.my.nested[] + +// tag::this.is.your[] +ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.your +] +ifdef::property-group-simple-title[.*_this.is.your_* +] +ifdef::property-group-discrete-heading[] +[discrete] +=== this.is.your +endif::[] +*Class:* `org.rodnansol.YourProperties` +[cols="2,1,3,1,1,1"] +|=== +|Key |Type |Description |Default value |Deprecation|Environment variable + + +|property +|java.lang.String +|This is YOUR property. +| +| +|`THIS_IS_YOUR_PROPERTY` + + +|=== +// end::this.is.your[] + diff --git a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/property-docs/single-module-example-property-docs.html b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/property-docs/single-module-example-property-docs.html index 3b43fea..7eb3a65 100644 --- a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/property-docs/single-module-example-property-docs.html +++ b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/property-docs/single-module-example-property-docs.html @@ -139,17 +139,17 @@

    single-module-example

  • Unknown group - Unknown
    • -
  • this.is.your - org.rodnansol.YourProperties
    • -
  • this.is.a.bean.configuration - org.rodnansol.PropertiesForConfiguration
    • -
  • this.is.my.nested - org.rodnansol.TopLevelClassNestedProperty
    • +
  • this.is.my - org.rodnansol.MyProperties
    • + +
  • this.is.my.first-level-nested-property - org.rodnansol.FirstLevelNestedProperty
  • this.is.my.first-level-nested-property.second-level-nested-class - org.rodnansol.FirstLevelNestedProperty$SecondLevelNestedClass
    • -
  • this.is.my - org.rodnansol.MyProperties
    • +
  • this.is.my.nested - org.rodnansol.TopLevelClassNestedProperty
    • -
  • this.is.my.first-level-nested-property - org.rodnansol.FirstLevelNestedProperty
    • +
  • this.is.your - org.rodnansol.YourProperties
    • @@ -177,8 +177,8 @@

    Unknown group

    -

    this.is.your

    - Class: org.rodnansol.YourProperties +

    this.is.a.bean.configuration

    + Class: org.rodnansol.PropertiesForConfiguration @@ -192,18 +192,18 @@

    this.is.your

    - + - + - +
    propertyconfiguration-value java.lang.StringThis is YOUR property.A field inside a class that is not property by default by within a Configuration class. THIS_IS_YOUR_PROPERTYTHIS_IS_A_BEAN_CONFIGURATION_CONFIGURATIONVALUE
    -

    this.is.a.bean.configuration

    - Class: org.rodnansol.PropertiesForConfiguration +

    this.is.my

    + Class: org.rodnansol.MyProperties @@ -217,18 +217,58 @@

    this.is.a.bean.configuration

    - + - + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    configuration-valueanother-variable java.lang.StringA field inside a class that is not property by default by within a Configuration class. with default valueReason: null, use for replacement: nullTHIS_IS_MY_ANOTHERVARIABLE
    datejava.time.LocalDate THIS_IS_A_BEAN_CONFIGURATION_CONFIGURATIONVALUETHIS_IS_MY_DATE
    date-timejava.time.LocalDateTimeTHIS_IS_MY_DATETIME
    durationjava.time.DurationA duration.2dReason: Because it is deprecated, use for replacement: instantTHIS_IS_MY_DURATION
    instantjava.time.Instant123THIS_IS_MY_INSTANT
    variablejava.lang.StringThis is my variable.THIS_IS_MY_VARIABLE
    -

    this.is.my.nested

    - Class: org.rodnansol.TopLevelClassNestedProperty +

    this.is.my.first-level-nested-property

    + Class: org.rodnansol.FirstLevelNestedProperty @@ -242,12 +282,20 @@

    this.is.my.nested

    - + - + + + + + + + + + - +
    nested-valuedesc java.lang.StringNested value.Description of this thing.123 THIS_IS_MY_FIRSTLEVELNESTEDPROPERTY_DESC
    namejava.lang.StringName of the custom property.ABC THIS_IS_MY_NESTED_NESTEDVALUETHIS_IS_MY_FIRSTLEVELNESTEDPROPERTY_NAME
    @@ -277,8 +325,8 @@

    this.i
    -

    this.is.my

    - Class: org.rodnansol.MyProperties +

    this.is.my.nested

    + Class: org.rodnansol.TopLevelClassNestedProperty @@ -292,58 +340,18 @@

    this.is.my

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - +
    another-variablejava.lang.Stringwith default valueReason: null, use for replacement: nullTHIS_IS_MY_ANOTHERVARIABLE
    datejava.time.LocalDateTHIS_IS_MY_DATE
    date-timejava.time.LocalDateTimeTHIS_IS_MY_DATETIME
    durationjava.time.DurationA duration.2dReason: Because it is deprecated, use for replacement: instantTHIS_IS_MY_DURATION
    instantjava.time.Instant123THIS_IS_MY_INSTANT
    variablenested-value java.lang.StringThis is my variable.Nested value. THIS_IS_MY_VARIABLETHIS_IS_MY_NESTED_NESTEDVALUE
    -

    this.is.my.first-level-nested-property

    - Class: org.rodnansol.FirstLevelNestedProperty +

    this.is.your

    + Class: org.rodnansol.YourProperties @@ -357,20 +365,12 @@

    this.is.my.first-level-nested-pr

    - + - - + - - - - - - - - +
    descproperty java.lang.StringDescription of this thing.123This is YOUR property. THIS_IS_MY_FIRSTLEVELNESTEDPROPERTY_DESC
    namejava.lang.StringName of the custom property.ABC THIS_IS_MY_FIRSTLEVELNESTEDPROPERTY_NAMETHIS_IS_YOUR_PROPERTY
    diff --git a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/property-docs/single-module-example-property-docs.md b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/property-docs/single-module-example-property-docs.md index c5a3d53..7fa72ed 100644 --- a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/property-docs/single-module-example-property-docs.md +++ b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/property-docs/single-module-example-property-docs.md @@ -1,42 +1,24 @@ # single-module-example ## Table of Contents * [**Unknown group** - `Unknown`](#Unknown group) -* [**this.is.your** - `org.rodnansol.YourProperties`](#this.is.your) * [**this.is.a.bean.configuration** - `org.rodnansol.PropertiesForConfiguration`](#this.is.a.bean.configuration) -* [**this.is.my.nested** - `org.rodnansol.TopLevelClassNestedProperty`](#this.is.my.nested) -* [**this.is.my.first-level-nested-property.second-level-nested-class** - `org.rodnansol.FirstLevelNestedProperty$SecondLevelNestedClass`](#this.is.my.first-level-nested-property.second-level-nested-class) * [**this.is.my** - `org.rodnansol.MyProperties`](#this.is.my) * [**this.is.my.first-level-nested-property** - `org.rodnansol.FirstLevelNestedProperty`](#this.is.my.first-level-nested-property) +* [**this.is.my.first-level-nested-property.second-level-nested-class** - `org.rodnansol.FirstLevelNestedProperty$SecondLevelNestedClass`](#this.is.my.first-level-nested-property.second-level-nested-class) +* [**this.is.my.nested** - `org.rodnansol.TopLevelClassNestedProperty`](#this.is.my.nested) +* [**this.is.your** - `org.rodnansol.YourProperties`](#this.is.your) ### Unknown group **Class:** `Unknown` |Key|Type|Description|Default value|Deprecation|Environment variable | |---|----|-----------|-------------|-----------|----------------------| -### this.is.your -**Class:** `org.rodnansol.YourProperties` - -|Key|Type|Description|Default value|Deprecation|Environment variable | -|---|----|-----------|-------------|-----------|----------------------| -| property| java.lang.String| This is YOUR property.| | | `THIS_IS_YOUR_PROPERTY`| ### this.is.a.bean.configuration **Class:** `org.rodnansol.PropertiesForConfiguration` |Key|Type|Description|Default value|Deprecation|Environment variable | |---|----|-----------|-------------|-----------|----------------------| | configuration-value| java.lang.String| A field inside a class that is not property by default by within a Configuration class.| | | `THIS_IS_A_BEAN_CONFIGURATION_CONFIGURATIONVALUE`| -### this.is.my.nested -**Class:** `org.rodnansol.TopLevelClassNestedProperty` - -|Key|Type|Description|Default value|Deprecation|Environment variable | -|---|----|-----------|-------------|-----------|----------------------| -| nested-value| java.lang.String| Nested value.| | | `THIS_IS_MY_NESTED_NESTEDVALUE`| -### this.is.my.first-level-nested-property.second-level-nested-class -**Class:** `org.rodnansol.FirstLevelNestedProperty$SecondLevelNestedClass` - -|Key|Type|Description|Default value|Deprecation|Environment variable | -|---|----|-----------|-------------|-----------|----------------------| -| second-level-value| java.lang.String| Custom nested| | | `THIS_IS_MY_FIRSTLEVELNESTEDPROPERTY_SECONDLEVELNESTEDCLASS_SECONDLEVELVALUE`| ### this.is.my **Class:** `org.rodnansol.MyProperties` @@ -55,6 +37,24 @@ |---|----|-----------|-------------|-----------|----------------------| | desc| java.lang.String| Description of this thing.| 123| | `THIS_IS_MY_FIRSTLEVELNESTEDPROPERTY_DESC`| | name| java.lang.String| Name of the custom property.| ABC| | `THIS_IS_MY_FIRSTLEVELNESTEDPROPERTY_NAME`| +### this.is.my.first-level-nested-property.second-level-nested-class +**Class:** `org.rodnansol.FirstLevelNestedProperty$SecondLevelNestedClass` + +|Key|Type|Description|Default value|Deprecation|Environment variable | +|---|----|-----------|-------------|-----------|----------------------| +| second-level-value| java.lang.String| Custom nested| | | `THIS_IS_MY_FIRSTLEVELNESTEDPROPERTY_SECONDLEVELNESTEDCLASS_SECONDLEVELVALUE`| +### this.is.my.nested +**Class:** `org.rodnansol.TopLevelClassNestedProperty` + +|Key|Type|Description|Default value|Deprecation|Environment variable | +|---|----|-----------|-------------|-----------|----------------------| +| nested-value| java.lang.String| Nested value.| | | `THIS_IS_MY_NESTED_NESTEDVALUE`| +### this.is.your +**Class:** `org.rodnansol.YourProperties` + +|Key|Type|Description|Default value|Deprecation|Environment variable | +|---|----|-----------|-------------|-----------|----------------------| +| property| java.lang.String| This is YOUR property.| | | `THIS_IS_YOUR_PROPERTY`| diff --git a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/without-type-and-deprecation.adoc b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/without-type-and-deprecation.adoc index ec2da95..62ac60c 100644 --- a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/without-type-and-deprecation.adoc +++ b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/without-type-and-deprecation.adoc @@ -22,27 +22,6 @@ endif::[] |=== // end::Unknown group[] -// tag::this.is.your[] -ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.your +] -ifdef::property-group-simple-title[.*_this.is.your_* +] -ifdef::property-group-discrete-heading[] -[discrete] -=== this.is.your -endif::[] -*Class:* `org.rodnansol.YourProperties` -[cols="2,3,1"] -|=== -|Key |Description |Default value - - -|property -|This is YOUR property. -| - - -|=== -// end::this.is.your[] - // tag::this.is.a.bean.configuration[] ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.a.bean.configuration +] ifdef::property-group-simple-title[.*_this.is.a.bean.configuration_* +] @@ -64,48 +43,6 @@ endif::[] |=== // end::this.is.a.bean.configuration[] -// tag::this.is.my.nested[] -ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.nested +] -ifdef::property-group-simple-title[.*_this.is.my.nested_* +] -ifdef::property-group-discrete-heading[] -[discrete] -=== this.is.my.nested -endif::[] -*Class:* `org.rodnansol.TopLevelClassNestedProperty` -[cols="2,3,1"] -|=== -|Key |Description |Default value - - -|nested-value -|Nested value. -| - - -|=== -// end::this.is.my.nested[] - -// tag::this.is.my.first-level-nested-property.second-level-nested-class[] -ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.first-level-nested-property.second-level-nested-class +] -ifdef::property-group-simple-title[.*_this.is.my.first-level-nested-property.second-level-nested-class_* +] -ifdef::property-group-discrete-heading[] -[discrete] -=== this.is.my.first-level-nested-property.second-level-nested-class -endif::[] -*Class:* `org.rodnansol.FirstLevelNestedProperty$SecondLevelNestedClass` -[cols="2,3,1"] -|=== -|Key |Description |Default value - - -|second-level-value -|Custom nested -| - - -|=== -// end::this.is.my.first-level-nested-property.second-level-nested-class[] - // tag::this.is.my[] ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my +] ifdef::property-group-simple-title[.*_this.is.my_* +] @@ -172,4 +109,67 @@ endif::[] |=== // end::this.is.my.first-level-nested-property[] +// tag::this.is.my.first-level-nested-property.second-level-nested-class[] +ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.first-level-nested-property.second-level-nested-class +] +ifdef::property-group-simple-title[.*_this.is.my.first-level-nested-property.second-level-nested-class_* +] +ifdef::property-group-discrete-heading[] +[discrete] +=== this.is.my.first-level-nested-property.second-level-nested-class +endif::[] +*Class:* `org.rodnansol.FirstLevelNestedProperty$SecondLevelNestedClass` +[cols="2,3,1"] +|=== +|Key |Description |Default value + + +|second-level-value +|Custom nested +| + + +|=== +// end::this.is.my.first-level-nested-property.second-level-nested-class[] + +// tag::this.is.my.nested[] +ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.my.nested +] +ifdef::property-group-simple-title[.*_this.is.my.nested_* +] +ifdef::property-group-discrete-heading[] +[discrete] +=== this.is.my.nested +endif::[] +*Class:* `org.rodnansol.TopLevelClassNestedProperty` +[cols="2,3,1"] +|=== +|Key |Description |Default value + + +|nested-value +|Nested value. +| + + +|=== +// end::this.is.my.nested[] + +// tag::this.is.your[] +ifndef::property-group-simple-title,property-group-discrete-heading[=== this.is.your +] +ifdef::property-group-simple-title[.*_this.is.your_* +] +ifdef::property-group-discrete-heading[] +[discrete] +=== this.is.your +endif::[] +*Class:* `org.rodnansol.YourProperties` +[cols="2,3,1"] +|=== +|Key |Description |Default value + + +|property +|This is YOUR property. +| + + +|=== +// end::this.is.your[] + diff --git a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/without-type-and-deprecation.html b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/without-type-and-deprecation.html index 34eb9d6..1b6c8f7 100644 --- a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/without-type-and-deprecation.html +++ b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/without-type-and-deprecation.html @@ -139,17 +139,17 @@

    single-module-example

  • Unknown group - Unknown
    • -
  • this.is.your - org.rodnansol.YourProperties
    • -
  • this.is.a.bean.configuration - org.rodnansol.PropertiesForConfiguration
    • -
  • this.is.my.nested - org.rodnansol.TopLevelClassNestedProperty
    • +
  • this.is.my - org.rodnansol.MyProperties
    • + +
  • this.is.my.first-level-nested-property - org.rodnansol.FirstLevelNestedProperty
  • this.is.my.first-level-nested-property.second-level-nested-class - org.rodnansol.FirstLevelNestedProperty$SecondLevelNestedClass
    • -
  • this.is.my - org.rodnansol.MyProperties
    • +
  • this.is.my.nested - org.rodnansol.TopLevelClassNestedProperty
    • -
  • this.is.my.first-level-nested-property - org.rodnansol.FirstLevelNestedProperty
    • +
  • this.is.your - org.rodnansol.YourProperties
    • @@ -177,8 +177,8 @@

    Unknown group

    -

    this.is.your

    - Class: org.rodnansol.YourProperties +

    this.is.a.bean.configuration

    + Class: org.rodnansol.PropertiesForConfiguration @@ -192,15 +192,15 @@

    this.is.your

    - - + +
    propertyThis is YOUR property.configuration-valueA field inside a class that is not property by default by within a Configuration class.
    -

    this.is.a.bean.configuration

    - Class: org.rodnansol.PropertiesForConfiguration +

    this.is.my

    + Class: org.rodnansol.MyProperties @@ -214,15 +214,40 @@

    this.is.a.bean.configuration

    - - + + + + + + + + + + + + + + + + + + + + + + + + + + +
    configuration-valueA field inside a class that is not property by default by within a Configuration class.another-variablewith default value
    date
    date-time
    durationA duration.2d
    instant123
    variableThis is my variable.
    -

    this.is.my.nested

    - Class: org.rodnansol.TopLevelClassNestedProperty +

    this.is.my.first-level-nested-property

    + Class: org.rodnansol.FirstLevelNestedProperty @@ -236,9 +261,14 @@

    this.is.my.nested

    - - - + + + + + + + +
    nested-valueNested value.descDescription of this thing.123
    nameName of the custom property.ABC
    @@ -265,8 +295,8 @@

    this.i
    -

    this.is.my

    - Class: org.rodnansol.MyProperties +

    this.is.my.nested

    + Class: org.rodnansol.TopLevelClassNestedProperty @@ -280,40 +310,15 @@

    this.is.my

    - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
    another-variablewith default value
    date
    date-time
    durationA duration.2d
    instant123
    variableThis is my variable.nested-valueNested value.
    -

    this.is.my.first-level-nested-property

    - Class: org.rodnansol.FirstLevelNestedProperty +

    this.is.your

    + Class: org.rodnansol.YourProperties @@ -327,14 +332,9 @@

    this.is.my.first-level-nested-pr

    - - - - - - - - + + +
    descDescription of this thing.123
    nameName of the custom property.ABCpropertyThis is YOUR property.
    diff --git a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/without-type-and-deprecation.md b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/without-type-and-deprecation.md index 9eb393b..c7cac56 100644 --- a/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/without-type-and-deprecation.md +++ b/spring-configuration-property-documenter-maven-plugin/src/test/resources/single-module-test/without-type-and-deprecation.md @@ -1,42 +1,24 @@ # single-module-example ## Table of Contents * [**Unknown group** - `Unknown`](#Unknown group) -* [**this.is.your** - `org.rodnansol.YourProperties`](#this.is.your) * [**this.is.a.bean.configuration** - `org.rodnansol.PropertiesForConfiguration`](#this.is.a.bean.configuration) -* [**this.is.my.nested** - `org.rodnansol.TopLevelClassNestedProperty`](#this.is.my.nested) -* [**this.is.my.first-level-nested-property.second-level-nested-class** - `org.rodnansol.FirstLevelNestedProperty$SecondLevelNestedClass`](#this.is.my.first-level-nested-property.second-level-nested-class) * [**this.is.my** - `org.rodnansol.MyProperties`](#this.is.my) * [**this.is.my.first-level-nested-property** - `org.rodnansol.FirstLevelNestedProperty`](#this.is.my.first-level-nested-property) +* [**this.is.my.first-level-nested-property.second-level-nested-class** - `org.rodnansol.FirstLevelNestedProperty$SecondLevelNestedClass`](#this.is.my.first-level-nested-property.second-level-nested-class) +* [**this.is.my.nested** - `org.rodnansol.TopLevelClassNestedProperty`](#this.is.my.nested) +* [**this.is.your** - `org.rodnansol.YourProperties`](#this.is.your) ### Unknown group **Class:** `Unknown` |Key|Description|Default value| |---|-----------|-------------| -### this.is.your -**Class:** `org.rodnansol.YourProperties` - -|Key|Description|Default value| -|---|-----------|-------------| -| property| This is YOUR property.| | ### this.is.a.bean.configuration **Class:** `org.rodnansol.PropertiesForConfiguration` |Key|Description|Default value| |---|-----------|-------------| | configuration-value| A field inside a class that is not property by default by within a Configuration class.| | -### this.is.my.nested -**Class:** `org.rodnansol.TopLevelClassNestedProperty` - -|Key|Description|Default value| -|---|-----------|-------------| -| nested-value| Nested value.| | -### this.is.my.first-level-nested-property.second-level-nested-class -**Class:** `org.rodnansol.FirstLevelNestedProperty$SecondLevelNestedClass` - -|Key|Description|Default value| -|---|-----------|-------------| -| second-level-value| Custom nested| | ### this.is.my **Class:** `org.rodnansol.MyProperties` @@ -55,6 +37,24 @@ |---|-----------|-------------| | desc| Description of this thing.| 123| | name| Name of the custom property.| ABC| +### this.is.my.first-level-nested-property.second-level-nested-class +**Class:** `org.rodnansol.FirstLevelNestedProperty$SecondLevelNestedClass` + +|Key|Description|Default value| +|---|-----------|-------------| +| second-level-value| Custom nested| | +### this.is.my.nested +**Class:** `org.rodnansol.TopLevelClassNestedProperty` + +|Key|Description|Default value| +|---|-----------|-------------| +| nested-value| Nested value.| | +### this.is.your +**Class:** `org.rodnansol.YourProperties` + +|Key|Description|Default value| +|---|-----------|-------------| +| property| This is YOUR property.| |