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

@@ -193,7 +193,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;
@@ -213,7 +213,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;
@@ -234,7 +234,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;
@@ -255,7 +255,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;
@@ -276,7 +276,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;
@@ -321,7 +321,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()) {
@@ -337,7 +337,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()) {
@@ -353,7 +353,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()) {
@@ -369,7 +369,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()) {
@@ -391,7 +391,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()) {
@@ -407,7 +407,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()) {
@@ -423,7 +423,7 @@ public class ApiClient extends JavaTimeFormatter {
* Helper method to set access token for the first OAuth2 authentication.
*
* @param accessToken Access token
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setAccessToken(String accessToken) {
for (Authentication auth : authentications.values()) {
@@ -440,7 +440,7 @@ public class ApiClient extends JavaTimeFormatter {
*
* @param clientId the client ID
* @param clientSecret the client secret
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setOauthCredentials(String clientId, String clientSecret) {
for (Authentication auth : authentications.values()) {
@@ -456,7 +456,7 @@ public class ApiClient extends JavaTimeFormatter {
* Helper method to set the credentials of a public client for the first OAuth2 authentication.
*
* @param clientId the client ID
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setOauthCredentialsForPublicClient(String clientId) {
for (Authentication auth : authentications.values()) {
@@ -473,7 +473,7 @@ public class ApiClient extends JavaTimeFormatter {
*
* @param username the user name
* @param password the user password
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setOauthPasswordFlow(String username, String password) {
for (Authentication auth : authentications.values()) {
@@ -489,7 +489,7 @@ public class ApiClient extends JavaTimeFormatter {
* Helper method to set the authorization code flow for the first OAuth2 authentication.
*
* @param code the authorization code
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setOauthAuthorizationCodeFlow(String code) {
for (Authentication auth : authentications.values()) {
@@ -505,7 +505,7 @@ public class ApiClient extends JavaTimeFormatter {
* Helper method to set the scopes for the first OAuth2 authentication.
*
* @param scope the oauth scope
* @return a {@link org.openapitools.client.ApiClient} object.
* @return a {@link ApiClient} object.
*/
public ApiClient setOauthScope(String scope) {
for (Authentication auth : authentications.values()) {
@@ -521,7 +521,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;
@@ -543,7 +543,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);
@@ -555,7 +555,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);
@@ -575,7 +575,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;
@@ -597,7 +597,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;
@@ -621,7 +621,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;
@@ -643,7 +643,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;
@@ -666,7 +666,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;
@@ -687,7 +687,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;