Fix javadoc builder core (#144)

Thank you for the PR
This commit is contained in:
Varun Upadhyay
2023-03-28 00:36:40 -07:00
committed by GitHub
parent e12d359696
commit f3303c2386
3 changed files with 12 additions and 13 deletions

View File

@@ -27,16 +27,16 @@ public @interface RecordBuilder {
@Inherited
@interface Include {
/**
* @return list of classes to include
* @return collection of classes to include
*/
Class<?>[] value() default {};
/**
* Synonym for {@code value()}. When using the other attributes it maybe more clear to
* Synonym for {@code value()}. When using the other attributes it maybe clearer to
* use {@code classes()} instead of {@code value()}. Note: both attributes are applied
* (i.e. a union of classes from both attributes).
*
* @return list of classes
* @return collection of classes
*/
Class<?>[] classes() default {};
@@ -44,7 +44,7 @@ public @interface RecordBuilder {
* Optional list of package names. All records in the packages will get processed as
* if they were listed as classes to include.
*
* @return list of package names
* @return collection of package names
*/
String[] packages() default {};
@@ -126,7 +126,7 @@ public @interface RecordBuilder {
String fileIndent() default " ";
/**
* If the record is declared inside of another class, the outer class's name will
* If the record is declared inside another class, the outer class's name will
* be prefixed to the builder name if this returns true.
*/
boolean prefixEnclosingClassNames() default true;
@@ -230,7 +230,6 @@ public @interface RecordBuilder {
* contains getters for all the fields in the Record prefixed with the value supplied in
* {@link this.getterPrefix} and {@link this.booleanPrefix}. This interface can be
* implemented by the original Record to have proper bean-style prefixed getters.
*
* Please note that unless either of the aforementioned prefixes are set,
* this option does nothing.
*/

View File

@@ -17,6 +17,10 @@ package io.soabase.recordbuilder.core;
import java.lang.annotation.*;
/**
* An alternate form of {@code @RecordBuilder} that has most
* optional features turned on
*/
@RecordBuilder.Template(options = @RecordBuilder.Options(
interpretNotNulls = true,
useImmutableCollections = true,
@@ -27,9 +31,5 @@ import java.lang.annotation.*;
@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.TYPE)
@Inherited
/**
* An alternate form of {@code @RecordBuilder} that has most
* optional features turned on
*/
public @interface RecordBuilderFull {
}

View File

@@ -28,16 +28,16 @@ public @interface RecordInterface {
@Inherited
@interface Include {
/**
* @return list of classes to include
* @return collection of classes to include
*/
Class<?>[] value() default {};
/**
* Synonym for {@code value()}. When using the other attributes it maybe more clear to
* Synonym for {@code value()}. When using the other attributes it maybe clearer to
* use {@code classes()} instead of {@code value()}. Note: both attributes are applied
* (i.e. a union of classes from both attributes).
*
* @return list of classes
* @return collection of classes
*/
Class<?>[] classes() default {};