diff --git a/src/main/java/org/jenkinsci/plugins/fodupload/FodApiConnection.java b/src/main/java/org/jenkinsci/plugins/fodupload/FodApiConnection.java index 39cb22d8..ac868c95 100644 --- a/src/main/java/org/jenkinsci/plugins/fodupload/FodApiConnection.java +++ b/src/main/java/org/jenkinsci/plugins/fodupload/FodApiConnection.java @@ -94,7 +94,7 @@ void retireToken() throws IOException { /** * Creates a okHttp client to connect with. * - * @return returns a client object + * at_return returns a client object */ private OkHttpClient Create() { OkHttpClient.Builder baseClient = new OkHttpClient().newBuilder() @@ -165,7 +165,7 @@ private String getTokenFromCache() throws IOException { /** * @deprecated * Use the {@link FodApiConnection#request(Request)} method instead - * @return + * at_return */ @Deprecated public String getToken() { @@ -191,7 +191,7 @@ public String getApiUrl() { /** * @deprecated * Use the {@link FodApiConnection#request(Request)} method instead - * @return + * at_return */ @Deprecated public OkHttpClient getClient() { @@ -254,7 +254,7 @@ public String getRawBody(Response response) { /** * @deprecated * Use the {@link FodApiConnection#request(Request)} method instead - * @return + * at_return */ public Request reauthenticateRequest(Request request) { return request.newBuilder() diff --git a/src/main/java/org/jenkinsci/plugins/fodupload/Utils.java b/src/main/java/org/jenkinsci/plugins/fodupload/Utils.java index c531ebf6..4019d014 100644 --- a/src/main/java/org/jenkinsci/plugins/fodupload/Utils.java +++ b/src/main/java/org/jenkinsci/plugins/fodupload/Utils.java @@ -156,7 +156,7 @@ public static String getFileExpressionPatternString(String technologyStack) { * @param techStack technology stack of the folder to zip * @param workspace location of the files to zip * @param logger logger to write status text to - * @return a File object + * at_return a File object * @throws IOException no files */ public static File createZipFile(String techStack, FilePath workspace, PrintStream logger) throws IOException { diff --git a/src/main/java/org/jenkinsci/plugins/fodupload/controllers/ApplicationsController.java b/src/main/java/org/jenkinsci/plugins/fodupload/controllers/ApplicationsController.java index ce0e59d2..20d1db5a 100644 --- a/src/main/java/org/jenkinsci/plugins/fodupload/controllers/ApplicationsController.java +++ b/src/main/java/org/jenkinsci/plugins/fodupload/controllers/ApplicationsController.java @@ -40,7 +40,7 @@ public ApplicationsController(final FodApiConnection apiConnection, final PrintS /** * GET given enum * - * @return array of enum values and text or null + * at_return array of enum values and text or null * @throws java.io.IOException in some circumstances */ public GenericListResponse getApplicationList(String searchTerm, Integer offset, Integer limit) throws IOException { @@ -117,7 +117,7 @@ public Result getReleaseById(Integer releaseId) throws IOExc * * @param releaseListApplicationId ApplicationId for query * @param microserviceId (0 = null) - * @return list of Releases + * at_return list of Releases * @throws java.io.IOException in some circumstances */ public GenericListResponse getReleaseListByApplication(int releaseListApplicationId, int microserviceId, String searchTerm, Integer offset, Integer limit) throws IOException { @@ -160,7 +160,7 @@ public GenericListResponse getReleaseListByApplication(int r * GET given enum * * @param microserviceListApplicationId ApplicationId for query - * @return array of enum values and text or null + * at_return array of enum values and text or null * @throws java.io.IOException in some circumstances */ public List getMicroserviceListByApplication(int microserviceListApplicationId) throws IOException { diff --git a/src/main/java/org/jenkinsci/plugins/fodupload/controllers/LookupItemsController.java b/src/main/java/org/jenkinsci/plugins/fodupload/controllers/LookupItemsController.java index 58cc6d21..7159eb91 100644 --- a/src/main/java/org/jenkinsci/plugins/fodupload/controllers/LookupItemsController.java +++ b/src/main/java/org/jenkinsci/plugins/fodupload/controllers/LookupItemsController.java @@ -32,7 +32,7 @@ public LookupItemsController(final FodApiConnection apiConnection, final PrintSt * GET given enum * * @param type enum to look up - * @return array of enum values and text or null + * at_return array of enum values and text or null * @throws java.io.IOException in some circumstances */ public List getLookupItems(FodEnums.APILookupItemTypes type) throws IOException { diff --git a/src/main/java/org/jenkinsci/plugins/fodupload/controllers/ReleaseController.java b/src/main/java/org/jenkinsci/plugins/fodupload/controllers/ReleaseController.java index 9c4980a3..1c3cff73 100644 --- a/src/main/java/org/jenkinsci/plugins/fodupload/controllers/ReleaseController.java +++ b/src/main/java/org/jenkinsci/plugins/fodupload/controllers/ReleaseController.java @@ -39,7 +39,7 @@ public ReleaseController(final FodApiConnection apiConnection, final PrintStream * * @param releaseId release to get * @param fields fields to return - * @return ReleaseDTO object with given fields + * at_return ReleaseDTO object with given fields * @throws java.io.IOException in some circumstances */ public ReleaseDTO getRelease(final int releaseId, final String fields) throws IOException { @@ -95,7 +95,7 @@ public ReleaseDTO getRelease(final int releaseId, final String fields) throws IO * * @param releaseId release to get * @param scanId scanId to find specific scan result - * @return ScanSummaryDTO object + * at_return ScanSummaryDTO object * @throws java.io.IOException in some circumstances */ public ScanSummaryDTO getRelease(final int releaseId, final int scanId) throws IOException { @@ -156,7 +156,7 @@ public ScanSummaryDTO getRelease(final int releaseId, final int scanId) throws I * * @param releaseId release to get * @param scanId scanId to find specific scan result - * @return ScanSummaryDTO object + * at_return ScanSummaryDTO object * @throws java.io.IOException in some circumstances */ public PollingSummaryDTO getReleaseByScanId(final int releaseId, final int scanId) throws IOException { @@ -210,7 +210,7 @@ public PollingSummaryDTO getReleaseByScanId(final int releaseId, final int scanI * Get Assessment Type from bsi url * * @param model JobModel - * @return returns assessment type obj + * at_return returns assessment type obj */ ReleaseAssessmentTypeDTO getAssessmentType(final JobModel model) throws IOException, URISyntaxException { diff --git a/src/main/java/org/jenkinsci/plugins/fodupload/controllers/StaticScanController.java b/src/main/java/org/jenkinsci/plugins/fodupload/controllers/StaticScanController.java index 5d4f8d68..4582f6bf 100644 --- a/src/main/java/org/jenkinsci/plugins/fodupload/controllers/StaticScanController.java +++ b/src/main/java/org/jenkinsci/plugins/fodupload/controllers/StaticScanController.java @@ -46,7 +46,7 @@ public StaticScanController(final FodApiConnection apiConnection, final PrintStr * @param releaseId id of release being targeted * @param uploadRequest zip file to upload * @param notes notes - * @return true if the scan succeeded + * at_return true if the scan succeeded */ @SuppressFBWarnings(value = "REC_CATCH_EXCEPTION", justification = "The intent of the catch-all is to make sure that the Jenkins user and logs show the plugin's problem in the build log.") public StartScanResponse startStaticScan(Integer releaseId, final JobModel uploadRequest, final String notes) { diff --git a/src/main/java/org/jenkinsci/plugins/fodupload/controllers/StaticScanSummaryController.java b/src/main/java/org/jenkinsci/plugins/fodupload/controllers/StaticScanSummaryController.java index 74749471..6ffade36 100644 --- a/src/main/java/org/jenkinsci/plugins/fodupload/controllers/StaticScanSummaryController.java +++ b/src/main/java/org/jenkinsci/plugins/fodupload/controllers/StaticScanSummaryController.java @@ -25,7 +25,7 @@ public StaticScanSummaryController(final FodApiConnection apiConnection, final P /** * @param releaseId releaseId is used in url query string * @param scanId scanId is used in url query string - * @return ScanSummaryDTO + * at_return ScanSummaryDTO * @throws java.io.IOException in some circumstances */ public ScanSummaryDTO getReleaseScanSummary(final int releaseId, final int scanId) throws IOException { diff --git a/src/main/java/org/jenkinsci/plugins/fodupload/polling/ScanStatusPoller.java b/src/main/java/org/jenkinsci/plugins/fodupload/polling/ScanStatusPoller.java index 4b27a675..d8de0ea3 100644 --- a/src/main/java/org/jenkinsci/plugins/fodupload/polling/ScanStatusPoller.java +++ b/src/main/java/org/jenkinsci/plugins/fodupload/polling/ScanStatusPoller.java @@ -44,7 +44,7 @@ public ScanStatusPoller(FodApiConnection apiConnection, int pollingInterval, Pri * @param releaseId release id * @param scanId scan id of the release * @param correlationId correlation id related to scan id - * @return true if status is completed | cancelled. + * at_return true if status is completed | cancelled. * @throws java.io.IOException in certain cases * @throws InterruptedException in certain cases */ diff --git a/src/main/webapp/Common.js b/src/main/webapp/Common.js index 36db4c4c..90b36ecc 100644 --- a/src/main/webapp/Common.js +++ b/src/main/webapp/Common.js @@ -5,7 +5,7 @@ /** * @callback jQueryFunc * @param {string|Object} selector - * @return {jQueryExtended} + * at_return {jQueryExtended} * */ /** @type {jQueryFunc} */ const jq = jQuery;