fix: Fix existing javadoc comments (#363)

Fix existing javadoc comments Signed-off-by: Mykola Rudyk <[email protected]>
Samsung · Dec 18, 2023 · 7e89715 · 7e89715
1 parent 2cfc37e
commit 7e89715
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 12 deletions.
diff --git a/src/main/java/com/lpvs/entity/auth/LPVSMember.java b/src/main/java/com/lpvs/entity/auth/LPVSMember.java
@@ -66,7 +66,13 @@ public class LPVSMember {
     private String organization;
 
     /**
-     * Builder pattern for creating instances of LPVSMember.
+     * Constructs instances of LPVSMember using the Builder pattern.
+     *
+     * @param id       The identifier for the LPVSMember.
+     * @param name     The name associated with the LPVSMember.
+     * @param email    The email address of the LPVSMember.
+     * @param provider The provider associated with the LPVSMember.
+     * @param nickname The nickname of the LPVSMember.
      */
     @Builder
     public LPVSMember(Long id, String name, String email, String provider, String nickname) {

diff --git a/src/main/java/com/lpvs/service/LPVSDetectService.java b/src/main/java/com/lpvs/service/LPVSDetectService.java
@@ -88,9 +88,10 @@ public class LPVSDetectService {
     /**
      * Constructs an instance of LPVSDetectService with the specified parameters.
      *
-     * @param scannerType            The type of license detection scanner.
+     * @param scannerType             The type of license detection scanner.
      * @param gitHubConnectionService Service for connecting to the GitHub API.
-     * @param scanossDetectService   Service for license detection using ScanOSS.
+     * @param scanossDetectService    Service for license detection using ScanOSS.
+     * @param licenseService          Service for license conflict analysis.
      */
     @Autowired
     public LPVSDetectService(

diff --git a/src/main/java/com/lpvs/util/LPVSCommentUtil.java b/src/main/java/com/lpvs/util/LPVSCommentUtil.java
@@ -76,12 +76,12 @@ public static String getMatchedLinesAsLink(
     }
 
     /**
-     * Generates a formatted string for LPVS github comment.
+     * Generates a formatted string for an LPVS GitHub comment.
      *
      * @param webhookConfig The {@link LPVSQueue} configuration for the webhook.
-     * @param scanResults   The List<{@link LPVSFile}> contain preformatted scan results.
-     * @param conflicts     The List<{@link LPVSLicenseService}.Conflict<String, String>> contain license conflict information.
-     * @return A string containing scan result in github friendly format.
+     * @param scanResults   List containing preformatted scan results.
+     * @param conflicts     List of conflicts, containing license conflict information.
+     * @return A string containing scan results in GitHub-friendly format.
      */
     public static String reportCommentBuilder(
             LPVSQueue webhookConfig,
@@ -132,12 +132,12 @@ public static String reportCommentBuilder(
     }
 
     /**
-     * Generates a formatted string for html report with scan results.
+     * Generates a formatted string for an HTML report with scan results.
      *
      * @param webhookConfig The {@link LPVSQueue} configuration for the webhook.
-     * @param scanResults   The List<{@link LPVSFile}> contain preformatted scan results.
-     * @param conflicts     The List<{@link LPVSLicenseService}.Conflict<String, String>> contain license conflict information.
-     * @return A string containing scan result in html format.
+     * @param scanResults   List containing preformatted scan results.
+     * @param conflicts     List containing license conflict information.
+     * @return A string containing scan results in HTML format.
      */
     public static String buildHTMLComment(
             LPVSQueue webhookConfig,
@@ -204,7 +204,7 @@ public static String buildHTMLComment(
      * Saves HTML report to given location.
      *
      * @param htmlContent   The string, containing report in HTML format.
-     * @param scanResults   The path to expected html report file.
+     * @param filePath      The path to expected html report file.
      */
     public static void saveHTMLToFile(String htmlContent, String filePath) {
         try (BufferedWriter writer = new BufferedWriter(new FileWriter(filePath))) {