diff --git a/build.gradle b/build.gradle index f4c19fa5..4d722783 100644 --- a/build.gradle +++ b/build.gradle @@ -122,6 +122,12 @@ tasks.named('jar') { archiveClassifier.set('') } +// Configure Javadoc to suppress warnings for missing constructor documentation +// This is necessary because Lombok generates constructors that cannot be documented +tasks.withType(Javadoc).configureEach { + options.addStringOption('Xdoclint:all,-missing', '-quiet') +} + def registerJdkTestTask(name, jdkVersion) { tasks.register(name, Test) { javaLauncher.set(javaToolchains.launcherFor { diff --git a/lombok.config b/lombok.config new file mode 100644 index 00000000..eabab1e3 --- /dev/null +++ b/lombok.config @@ -0,0 +1,6 @@ +# This file configures Lombok for the project +# See https://projectlombok.org/features/configuration + +# Add @Generated annotation to all Lombok-generated code +# This suppresses Javadoc warnings about missing constructor documentation +lombok.addLombokGeneratedAnnotation = true diff --git a/src/main/java/com/digitalsanctuary/spring/user/UserAutoConfigurationRegistrar.java b/src/main/java/com/digitalsanctuary/spring/user/UserAutoConfigurationRegistrar.java index 9a9ec2b1..8c7d8d94 100644 --- a/src/main/java/com/digitalsanctuary/spring/user/UserAutoConfigurationRegistrar.java +++ b/src/main/java/com/digitalsanctuary/spring/user/UserAutoConfigurationRegistrar.java @@ -6,12 +6,12 @@ import org.springframework.core.type.AnnotationMetadata; /** - * {@code UserAutoConfigurationRegistrar} dynamically registers the base package of this library with Spring Boot to ensure that its entities, + * Dynamically registers the base package of this library with Spring Boot to ensure that its entities, * repositories, and other Spring-managed components are properly detected and included in the application context. * *

- * This class is designed to simplify the integration of the library into Spring Boot applications by automatically registering the library's base - * package (com.digitalsanctuary.spring.user) for component scanning. It ensures that: + * This class simplifies integration by automatically registering the library's base + * package ({@code com.digitalsanctuary.spring.user}) for component scanning. It ensures that: *