Spring/spring-modulith
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

GH-317 - Fix Javadoc.

Browse Source
This commit is contained in:
Oliver Drotbohm
2023-10-16 08:28:16 +02:00
parent 9148a57b02
commit 86f745e5b7
3 changed files with 11 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
spring-modulith-core/src/main/java/org/springframework/modulith/core/ApplicationModules.java
View File

@@ -159,8 +159,9 @@ public class ApplicationModules implements Iterable<ApplicationModule> {
}
/**
* Creates a new {@link ApplicationModules} relative to the given modulith type. Will inspect the {@link Modulith}
* annotation on the class given for advanced customizations of the module setup.
* Creates a new {@link ApplicationModules} relative to the given modulith type. Will inspect the
* {@link org.springframework.modulith.Modulith} annotation on the class given for advanced customizations of the
* module setup.
*
* @param modulithType must not be {@literal null}.
* @return will never be {@literal null}.
@@ -172,8 +173,8 @@ public class ApplicationModules implements Iterable<ApplicationModule> {
/**
* Creates a new {@link ApplicationModules} relative to the given modulith type, a
* {@link ApplicationModuleDetectionStrategy} and a {@link DescribedPredicate} which types and packages to ignore.
* Will inspect the {@link Modulith} and {@link Modulithic} annotations on the class given for advanced customizations
* of the module setup.
* Will inspect the {@link org.springframework.modulith.Modulith} and {@link org.springframework.modulith.Modulithic}
* annotations on the class given for advanced customizations of the module setup.
*
* @param modulithType must not be {@literal null}.
* @param ignored must not be {@literal null}.
@@ -421,7 +422,8 @@ public class ApplicationModules implements Iterable<ApplicationModule> {
* Returns a {@link Comparator} that will sort objects based on their types' application module. In other words,
* objects of types in more fundamental modules will be ordered before ones residing in downstream modules. For
* example, if module A depends on B, objects of types residing in B will be ordered before ones in A. For objects
* residing in the same module, standard Spring-based ordering (via {@link Order} or {@link Ordered}) will be applied.
* residing in the same module, standard Spring-based ordering (via {@link org.springframework.core.annotation.Order}
* or {@link org.springframework.core.Ordered}) will be applied.
*
* @return will never be {@literal null}.
*/

4
spring-modulith-core/src/main/java/org/springframework/modulith/core/ArchitecturallyEvidentType.java
View File

@@ -56,8 +56,8 @@ public abstract class ArchitecturallyEvidentType {
}
/**
* Creates a new {@link ArchitecturallyEvidentType} for the given {@link JavaType} and {@link Classes} of Spring
* components.
* Creates a new {@link ArchitecturallyEvidentType} for the given {@link com.tngtech.archunit.core.domain.JavaType}
* and {@link Classes} of Spring components.
*
* @param type must not be {@literal null}.
* @param beanTypes must not be {@literal null}.

3
spring-modulith-core/src/main/java/org/springframework/modulith/core/Violations.java
View File

@@ -49,7 +49,8 @@ public class Violations extends RuntimeException {
}
/**
* A {@link Collector} to turn a {@link Stream} of {@link RuntimeException}s into a {@link Violations} instance.
* A {@link Collector} to turn a {@link java.util.stream.Stream} of {@link RuntimeException}s into a
* {@link Violations} instance.
*
* @return will never be {@literal null}.
*/