Skip to content

Commit d237ccd

Browse files
committed
Fix Javadoc issues in RESTEasy Reactive
1 parent 02eab8b commit d237ccd

File tree

6 files changed

+6
-10
lines changed

6 files changed

+6
-10
lines changed

extensions/resteasy-reactive/quarkus-resteasy-reactive-common/deployment/src/main/java/io/quarkus/resteasy/reactive/common/deployment/VetoingAnnotationTransformer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
* then we need to make sure that Arc doesn't create a bean for it automatically (as it will fail validation because
1414
* there is no way to pass the parameter).
1515
* For these resources we add {@link jakarta.enterprise.inject.Vetoed}, and we generate custom CDI producers under the hood
16-
* in {@link CustomResourceProducersGenerator#generate}.
16+
* in {@code io.quarkus.resteasy.reactive.server.deployment.CustomResourceProducersGenerator#generate}.
1717
*/
1818
public class VetoingAnnotationTransformer implements AnnotationsTransformer {
1919

extensions/resteasy-reactive/quarkus-resteasy-reactive-common/runtime/src/main/java/io/quarkus/resteasy/reactive/common/runtime/JaxRsSecurityConfig.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public interface JaxRsSecurityConfig {
2323
* If no security annotations are affecting a method then they will default to requiring these roles,
2424
* (equivalent to adding an @RolesAllowed annotation with the roles to every endpoint class).
2525
*
26-
* The role of '**' means any authenticated user, which is equivalent to the {@link io.quarkus.security.Authenticated}
26+
* The role of '**' means any authenticated user, which is equivalent to the {@code io.quarkus.security.Authenticated}
2727
* annotation.
2828
*/
2929
Optional<List<String>> defaultRolesAllowed();

extensions/resteasy-reactive/quarkus-resteasy-reactive-kotlin/deployment/src/main/java/io/quarkus/resteasy/reactive/kotlin/deployment/KotlinCoroutineIntegrationProcessor.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ public boolean isMethodSignatureAsync(MethodInfo info) {
125125
* This method generates the same invocation code as for the standard invoker but also passes along the implicit
126126
* {@code Continuation} argument provided by kotlinc and the coroutines library.
127127
*
128-
* @see io.quarkus.resteasy.reactive.server.deployment.QuarkusInvokerFactory#create(ResourceMethod, ClassInfo, MethodInfo)
128+
* See: io.quarkus.resteasy.reactive.server.deployment.QuarkusInvokerFactory#create(ResourceMethod, ClassInfo, MethodInfo)
129129
*/
130130
private Supplier<EndpointInvoker> createCoroutineInvoker(ClassInfo currentClassInfo,
131131
MethodInfo info, BuildProducer<GeneratedClassBuildItem> generatedClassBuildItemBuildProducer,

independent-projects/resteasy-reactive/common/runtime/src/main/java/org/jboss/resteasy/reactive/PathPart.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public class PathPart {
2828
/**
2929
* Create a new partial {@link Path} object.
3030
*
31-
* @param path The file to send
31+
* @param file The file to send
3232
* @param offset The starting byte of the file (must be >= 0)
3333
* @param count The number of bytes to send (must be >= 0 and offset+count <= file size)
3434
*/

independent-projects/resteasy-reactive/server/runtime/src/main/java/org/jboss/resteasy/reactive/server/core/multipart/FormDataParser.java

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
import java.io.Closeable;
44
import java.io.IOException;
55

6-
import org.jboss.resteasy.reactive.server.core.ResteasyReactiveRequestContext;
7-
86
/**
97
* Parser for form data. This can be used by down-stream handlers to parse
108
* form data.
@@ -25,9 +23,7 @@ public interface FormDataParser extends Closeable {
2523
void parse() throws Exception;
2624

2725
/**
28-
* Parse the data, blocking the current thread until parsing is complete. For blocking handlers this method is
29-
* more efficient than {@link #parse(ResteasyReactiveRequestContext next)}, as the calling thread should do that
30-
* actual parsing, rather than the read thread
26+
* Parse the data, blocking the current thread until parsing is complete.
3127
*
3228
* @return The parsed form data
3329
* @throws IOException If the data could not be read

independent-projects/resteasy-reactive/server/runtime/src/main/java/org/jboss/resteasy/reactive/server/spi/EndpointInvoker.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/**
44
* Base interface implemented by the synthetic beans that represent rest endpoints.
55
*
6-
* @see CoroutineEndpointInvoker
6+
* See org.jboss.resteasy.reactive.server.runtime.kotlin.CoroutineEndpointInvoker
77
*/
88
public interface EndpointInvoker {
99

0 commit comments

Comments
 (0)