Get rid of a bunch of Javadoc errors (#19209)

This commit is contained in:
Christian Beikov
2024-07-21 12:48:18 +02:00
committed by GitHub
parent e542b06869
commit b5d5e572e0
10 changed files with 236 additions and 236 deletions

View File

@@ -208,7 +208,7 @@ public class ApiClient extends JavaTimeFormatter {
* <p>Setter for the field <code>httpClient</code>.</p>
*
* @param httpClient a {@link javax.ws.rs.client.Client} object.
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setHttpClient(Client httpClient) {
this.httpClient = httpClient;
@@ -228,7 +228,7 @@ public class ApiClient extends JavaTimeFormatter {
* Sets the base URL to the location where the OpenAPI document is being served.
*
* @param basePath The base URL to the target host.
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setBasePath(String basePath) {
this.basePath = basePath;
@@ -248,7 +248,7 @@ public class ApiClient extends JavaTimeFormatter {
* <p>Setter for the field <code>servers</code>.</p>
*
* @param servers a {@link java.util.List} of servers.
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setServers(List<ServerConfiguration> servers) {
this.servers = servers;
@@ -269,7 +269,7 @@ public class ApiClient extends JavaTimeFormatter {
* <p>Setter for the field <code>serverIndex</code>.</p>
*
* @param serverIndex the server index
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setServerIndex(Integer serverIndex) {
this.serverIndex = serverIndex;
@@ -290,7 +290,7 @@ public class ApiClient extends JavaTimeFormatter {
* <p>Setter for the field <code>serverVariables</code>.</p>
*
* @param serverVariables a {@link java.util.Map} of server variables.
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setServerVariables(Map<String, String> serverVariables) {
this.serverVariables = serverVariables;
@@ -327,7 +327,7 @@ public class ApiClient extends JavaTimeFormatter {
* Helper method to set username for the first HTTP basic authentication.
*
* @param username Username
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setUsername(String username) {
for (Authentication auth : authentications.values()) {
@@ -343,7 +343,7 @@ public class ApiClient extends JavaTimeFormatter {
* Helper method to set password for the first HTTP basic authentication.
*
* @param password Password
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setPassword(String password) {
for (Authentication auth : authentications.values()) {
@@ -359,7 +359,7 @@ public class ApiClient extends JavaTimeFormatter {
* Helper method to set API key value for the first API key authentication.
*
* @param apiKey API key
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setApiKey(String apiKey) {
for (Authentication auth : authentications.values()) {
@@ -375,7 +375,7 @@ public class ApiClient extends JavaTimeFormatter {
* Helper method to configure authentications which respects aliases of API keys.
*
* @param secrets Hash map from authentication name to its secret.
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient configureApiKeys(Map<String, String> secrets) {
for (Map.Entry<String, Authentication> authEntry : authentications.entrySet()) {
@@ -397,7 +397,7 @@ public class ApiClient extends JavaTimeFormatter {
* Helper method to set API key prefix for the first API key authentication.
*
* @param apiKeyPrefix API key prefix
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setApiKeyPrefix(String apiKeyPrefix) {
for (Authentication auth : authentications.values()) {
@@ -413,7 +413,7 @@ public class ApiClient extends JavaTimeFormatter {
* Helper method to set bearer token for the first Bearer authentication.
*
* @param bearerToken Bearer token
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setBearerToken(String bearerToken) {
for (Authentication auth : authentications.values()) {
@@ -429,7 +429,7 @@ public class ApiClient extends JavaTimeFormatter {
* Set the User-Agent header's value (by adding to the default header map).
*
* @param userAgent Http user agent
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setUserAgent(String userAgent) {
this.userAgent = userAgent;
@@ -451,7 +451,7 @@ public class ApiClient extends JavaTimeFormatter {
*
* @param key The header's key
* @param value The header's value
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient addDefaultHeader(String key, String value) {
defaultHeaderMap.put(key, value);
@@ -463,7 +463,7 @@ public class ApiClient extends JavaTimeFormatter {
*
* @param key The cookie's key
* @param value The cookie's value
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient addDefaultCookie(String key, String value) {
defaultCookieMap.put(key, value);
@@ -483,7 +483,7 @@ public class ApiClient extends JavaTimeFormatter {
* Set the client config.
*
* @param clientConfig Set the client config
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setClientConfig(ClientConfig clientConfig) {
this.clientConfig = clientConfig;
@@ -505,7 +505,7 @@ public class ApiClient extends JavaTimeFormatter {
* Enable/disable debugging for this API client.
*
* @param debugging To enable (true) or disable (false) debugging
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setDebugging(boolean debugging) {
this.debugging = debugging;
@@ -529,7 +529,7 @@ public class ApiClient extends JavaTimeFormatter {
* Set temp folder path
*
* @param tempFolderPath Temp folder path
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setTempFolderPath(String tempFolderPath) {
this.tempFolderPath = tempFolderPath;
@@ -551,7 +551,7 @@ public class ApiClient extends JavaTimeFormatter {
* {@link Integer#MAX_VALUE}.
*
* @param connectionTimeout Connection timeout in milliseconds
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setConnectTimeout(int connectionTimeout) {
this.connectionTimeout = connectionTimeout;
@@ -574,7 +574,7 @@ public class ApiClient extends JavaTimeFormatter {
* {@link Integer#MAX_VALUE}.
*
* @param readTimeout Read timeout in milliseconds
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setReadTimeout(int readTimeout) {
this.readTimeout = readTimeout;
@@ -595,7 +595,7 @@ public class ApiClient extends JavaTimeFormatter {
* Set the date format used to parse/format date parameters.
*
* @param dateFormat Date format
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setDateFormat(DateFormat dateFormat) {
this.dateFormat = dateFormat;