Skip to content

Commit

Permalink
Get rid of a bunch of Javadoc errors (OpenAPITools#19209)
Browse files Browse the repository at this point in the history
  • Loading branch information
beikov authored Jul 21, 2024
1 parent e542b06 commit b5d5e57
Show file tree
Hide file tree
Showing 10 changed files with 236 additions and 236 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* <p>Setter for the field <code>httpClient</code>.</p>
*
* @param httpClient a {@link {{javaxPackage}}.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;
Expand All @@ -298,7 +298,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* 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;
Expand All @@ -321,7 +321,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* <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;
Expand All @@ -342,7 +342,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* <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;
Expand All @@ -363,7 +363,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* <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;
Expand Down Expand Up @@ -410,7 +410,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* 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()) {
Expand All @@ -426,7 +426,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* 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()) {
Expand All @@ -442,7 +442,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* 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()) {
Expand All @@ -458,7 +458,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* 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()) {
Expand All @@ -480,7 +480,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* 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()) {
Expand All @@ -496,7 +496,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* 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()) {
Expand All @@ -513,7 +513,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* 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()) {
Expand All @@ -530,7 +530,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
*
* @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()) {
Expand All @@ -546,7 +546,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* 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()) {
Expand All @@ -563,7 +563,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
*
* @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()) {
Expand All @@ -579,7 +579,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* 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()) {
Expand All @@ -595,7 +595,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* 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()) {
Expand All @@ -612,7 +612,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* 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;
Expand All @@ -634,7 +634,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
*
* @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);
Expand All @@ -646,7 +646,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
*
* @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);
Expand All @@ -666,7 +666,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* 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;
Expand All @@ -688,7 +688,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* 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;
Expand All @@ -712,7 +712,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* 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;
Expand All @@ -734,7 +734,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* {@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;
Expand All @@ -757,7 +757,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* {@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;
Expand All @@ -778,7 +778,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} {
* 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;
Expand Down
Loading

0 comments on commit b5d5e57

Please sign in to comment.