loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

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

Browse Source
This commit is contained in:
Christian Beikov 2024-07-16 11:49:21 +02:00 committed by GitHub
parent a81b736b24
commit 94264e5598
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 52 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
modules/openapi-generator/src/main/resources/Java/libraries/jersey3/ApiClient.mustache vendored
View File

@ -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;
@ -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;
@ -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;
@ -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;
@ -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;
@ -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()) {
@ -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()) {
@ -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()) {
@ -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()) {
@ -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()) {
@ -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()) {
@ -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()) {
@ -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()) {
@ -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()) {
@ -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()) {
@ -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()) {
@ -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()) {
@ -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;
@ -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);
@ -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);
@ -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;
@ -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;
@ -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;
@ -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;
@ -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;
@ -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;

52
samples/client/petstore/java/jersey3/src/main/java/org/openapitools/client/ApiClient.java
View File

@ -275,7 +275,7 @@ public class ApiClient extends JavaTimeFormatter {
* <p>Setter for the field <code>httpClient</code>.</p>
*
* @param httpClient a {@link jakarta.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;
@ -295,7 +295,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;
@ -316,7 +316,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;
@ -337,7 +337,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;
@ -358,7 +358,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;
@ -403,7 +403,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()) {
@ -419,7 +419,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()) {
@ -435,7 +435,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()) {
@ -451,7 +451,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()) {
@ -473,7 +473,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()) {
@ -489,7 +489,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()) {
@ -505,7 +505,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()) {
@ -522,7 +522,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()) {
@ -538,7 +538,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()) {
@ -555,7 +555,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()) {
@ -571,7 +571,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()) {
@ -587,7 +587,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()) {
@ -603,7 +603,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;
@ -625,7 +625,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);
@ -637,7 +637,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);
@ -657,7 +657,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;
@ -679,7 +679,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;
@ -703,7 +703,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;
@ -725,7 +725,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;
@ -748,7 +748,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;
@ -769,7 +769,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;