Add actual Javadoc to package-info

This commit is contained in:
Rossen Stoyanchev
2021-05-14 16:26:01 +01:00
parent b1a4016132
commit 1a4ef20f8a
8 changed files with 36 additions and 73 deletions

View File

@@ -0,0 +1,9 @@
/**
* Provides instrumentation support.
*/
@NonNullApi
@NonNullFields
package org.springframework.graphql.boot.actuate.metrics;
import org.springframework.lang.NonNullApi;
import org.springframework.lang.NonNullFields;

View File

@@ -1,17 +1,8 @@
/*
* Copyright 2020-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
/**
* Auto-configuration classes to configure
* {@link org.springframework.graphql.execution.GraphQLSource},
* {@link org.springframework.graphql.GraphQLService}, and HTTP and WebSocket
* endpoints.
*/
@NonNullApi
@NonNullFields

View File

@@ -29,7 +29,10 @@ import org.springframework.util.Assert;
import org.springframework.util.CollectionUtils;
/**
* Container for a GraphQL request.
* Common representation for GraphQL request input. This can be converted to
* {@link ExecutionInput} via {@link #toExecutionInput()} and the
* {@code ExecutionInput} further customized via
* {@link #configureExecutionInput(BiFunction)}.
*/
public class RequestInput {

View File

@@ -1,6 +1,6 @@
/**
* Provides support for GraphQL request execution, including abstractions to
* configure and invoke {@link graphql.GraphQL}.
* Support for GraphQL request execution, including abstractions to configure
* and invoke {@link graphql.GraphQL}.
*/
@NonNullApi
@NonNullFields

View File

@@ -1,17 +1,8 @@
/*
* Copyright 2020-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
/**
* Top level abstractions for processing GraphQL requests including
* {@link org.springframework.graphql.GraphQLService} for executing a request and
* {@link org.springframework.graphql.RequestInput} to represent the input for
* a request.
*/
@NonNullApi
@NonNullFields

View File

@@ -1,17 +1,10 @@
/*
* Copyright 2020-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
/**
* Support for executing GraphQL requests over the Web, including handlers for
* HTTP and WebSocket. Handlers are provided for use in ether
* {@link org.springframework.graphql.web.webmvc Spring WebMvc} or
* {@link org.springframework.graphql.web.webflux Spring WebFlux} with a common
* {@link org.springframework.graphql.web.WebInterceptor interception} model
* that allows applications to customize request input and output.
*/
@NonNullApi
@NonNullFields

View File

@@ -1,17 +1,5 @@
/*
* Copyright 2020-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
/**
* HTTP and WebSocket handlers for use in a Spring WebFlux application.
*/
@NonNullApi
@NonNullFields

View File

@@ -1,17 +1,5 @@
/*
* Copyright 2020-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
/**
* HTTP and WebSocket handlers for use in a Spring WebMvc application.
*/
@NonNullApi
@NonNullFields