Revize 8e87e631

Methods commented

src/main/java/cz/zcu/fav/kiv/antipatterndetectionapp/controller/AppController.java

@@ -197 +197 @@
     }
 
     /**
-     * Method of storing new configurations for individual AP.
+     * Method of saving changes of current configuration
      *
      * @param model object for passing data to the UI
      * @param thresholdValues changed configuration values
@@ -230 +230 @@
     }
 
     /**
-     * Method of storing new configurations for individual AP.
+     * Method for saving full new configuration
      *
      * @param model object for passing data to the UI
      * @param thresholdValues changed configuration values
@@ -276 +276 @@
     }
 
     /**
-     * Method for storing configuration values ​​for the respective AP.
+     * Method for saving changes of one AP in current configuration
      *
      * @param model object for passing data to the UI
      * @param id id of AP

src/main/java/cz/zcu/fav/kiv/antipatterndetectionapp/detecting/AntiPatternManager.java

@@ -7 +7 @@
 import java.util.Map;
 
 public interface AntiPatternManager {
-
+    /**
+     * Method for processing analysis of selected anti-patterns on selected project with certain configuration
+     *
+     * @param selectedProjects Projects to analyze
+     * @param selectedAntiPatterns Anti-patterns to detect
+     * @param configuration Current configuration
+     * @return Results of analysis stored in a list
+     */
     List<QueryResult> analyze(String[] selectedProjects, String[] selectedAntiPatterns, Map<String, Map<String, String>> configuration);
 }

src/main/java/cz/zcu/fav/kiv/antipatterndetectionapp/repository/AntiPatternRepository.java

@@ -4 +4 @@
 import cz.zcu.fav.kiv.antipatterndetectionapp.detecting.detectors.AntiPatternDetector;
 import cz.zcu.fav.kiv.antipatterndetectionapp.model.AntiPattern;
 import cz.zcu.fav.kiv.antipatterndetectionapp.model.Threshold;
-import cz.zcu.fav.kiv.antipatterndetectionapp.model.types.Percentage;
-import cz.zcu.fav.kiv.antipatterndetectionapp.model.types.PositiveFloat;
-import cz.zcu.fav.kiv.antipatterndetectionapp.model.types.PositiveInteger;
 import cz.zcu.fav.kiv.antipatterndetectionapp.utils.JsonParser;
 import org.reflections.Reflections;
 import org.slf4j.Logger;
@@ -86 +83 @@
     }
 
     /**
-     *
+     * Method for reading SQL queries from files
      */
     private void initSqlQueries(){
         LOGGER.info("-------START READING SQL FROM FILES-------");
@@ -134 +131 @@
     }
 
     /**
+     * Method for reading anti-pattern information from json files
      *
-     * @param jsonFileName
-     * @return
+     * @param jsonFileName Name of the file
+     * @return AntiPattern object
      */
     public AntiPattern getAntiPatternFromJsonFile(String jsonFileName){
         String json = "";   // json configuration file
@@ -213 +211 @@
     }
 
     /**
+     * Method for creating of the Threshold object from given parameters
      *
-     * @param thresholdType
-     * @param name
-     * @param printName
-     * @param description
-     * @param errorMessage
-     * @return
+     * @param thresholdType Type of the threshold
+     * @param name Threshold name
+     * @param printName Threshold name for print
+     * @param description Short description of the threshold
+     * @param errorMessage Error message to display if threshold's value is set wrong
+     * @return Threshold object
      */
     private Threshold getThreshold(String thresholdType, String name, String printName, String description, String errorMessage){
 

src/main/java/cz/zcu/fav/kiv/antipatterndetectionapp/repository/ConfigurationRepository.java

@@ -40 +40 @@
         loadConfigurations();
     }
 
+    /**
+     * Method for loading all configurations from json files in folder and saving them to map structure
+     */
     private void loadConfigurations(){
         LOGGER.info("-------START READING CONFIGURATIONS FROM FILES-------");
         Map<String, Map<String, Map<String, String>>> configurations = new HashMap<>();
@@ -120 +123 @@
         LOGGER.info("-------FINISHED READING CONFIGURATIONS FROM FILES-------");
     }
 
+    /**
+     * Method that creates json file from the given configuration
+     * @param configurationName Name of the json file
+     * @param newConfiguration Map with configuration values
+     */
     public void saveConfigurationToFile(String configurationName, Map<String, Map <String, String>> newConfiguration){
         ObjectNode root = JsonParser.getObjectMapper().createObjectNode();
 
@@ -154 +162 @@
 
     }
 
+    /**
+     * Method that saves new configuration from given parameters to the map structure
+     * @param antiPatterns List of anti-pattern objects
+     * @param configurationName New configuration name
+     * @param antiPatternNames Array of anti-pattern names
+     * @param thresholdNames Array of threshold names
+     * @param thresholdValues Array pf threshold values
+     * @param fullNewConfiguration True, if the whole new configuration is created and False, if only some thresholds are updated
+     * @return List of the incorrectly set parameters
+     */
     public List<String> saveNewConfiguration(List<AntiPattern> antiPatterns, String configurationName, String[] antiPatternNames, String[] thresholdNames, String[] thresholdValues, boolean fullNewConfiguration){
         Map<String, Map<String, String>> newConfiguration = new HashMap<>();
         List<String> incorrectParameters = new ArrayList<>();

src/main/java/cz/zcu/fav/kiv/antipatterndetectionapp/service/AntiPatternService.java

@@ -36 +36 @@
 
     AntiPattern setErrorMessages(AntiPattern antiPattern, List<String> wrongParameters);
 
+    /**
+     * Method for getting description of the anti-pattern from online catalogue on Github
+     *
+     * @param id ID of the anti-pattern
+     * @return Description of the anti-pattern
+     */
     String getDescriptionFromCatalogue(long id);
 }

src/main/java/cz/zcu/fav/kiv/antipatterndetectionapp/service/ConfigurationService.java

@@ -2 +2 @@
 
 import cz.zcu.fav.kiv.antipatterndetectionapp.model.AntiPattern;
 
-import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
 public interface ConfigurationService {
 
+    /**
+     * Method for getting all configuration names
+     *
+     * @return List of the configuration
+     */
     List<String> getAllConfigurationNames();
 
+    /**
+     * Method for getting default configuration names
+     * Default configurations cannot be changed in the app
+     *
+     * @return List of the default configuration
+     */
     List<String> getDefaultConfigurationNames();
 
     Map<String, Map<String, String>> getConfigurationByName(String configurationName);
 
+    /**
+     * Method for saving new configuration to the map structure and json file
+     *
+     * @param antiPatterns List of all anti-patterns
+     * @param configurationName Configuration name
+     * @param antiPatternNames List of anti-pattern names
+     * @param thresholdNames List of threshold names
+     * @param thresholdValues List of threshold values
+     * @param fullNewConfiguration True if the whole new configuration is created
+     * @return List of incorrectly set values
+     */
     List<String> saveNewConfiguration(List<AntiPattern> antiPatterns, String configurationName, String[] antiPatternNames, String[] thresholdNames, String[] thresholdValues, boolean fullNewConfiguration);
 }

src/main/java/cz/zcu/fav/kiv/antipatterndetectionapp/service/UserAccountService.java

@@ -2 +2 @@
 
 public interface UserAccountService {
 
+    /**
+     * Checks if the given credentials are valid
+     * @param username Username
+     * @param password Password
+     * @return True if user credentials are valid
+     */
     boolean checkCredentials(String username, String password);
 
 }

src/main/java/cz/zcu/fav/kiv/antipatterndetectionapp/utils/JsonParser.java

@@ -11 +11 @@
 
     private static ObjectMapper objectMapper = getDefaultObjectMapper();
 
+    /**
+     * Method for getting Jackson ObjectMapper object
+     *
+     * @return ObjectMapper
+     */
     public static ObjectMapper getDefaultObjectMapper() {
         ObjectMapper defObjectMapper = new ObjectMapper();
 
@@ -19 +24 @@
         return defObjectMapper;
     }
 
+    /**
+     * Method for reading tree model from json
+     *
+     * @param src
+     * @return JsonNode
+     * @throws IOException
+     */
     public static JsonNode parse(String src) throws IOException {
         return objectMapper.readTree(src);
     }

src/main/webapp/resources/js/editor.js

@@ -146 +146 @@
 }
 
 /**
- * Wraping selected text by h2 tag
+ * Wrapping selected text by h2 tag
  */
 function headerH2() {
     let S=window.getSelection().toString();
@@ -163 +163 @@
 }
 
 /**
- * Wraping selected text by h3 tag
+ * Wrapping selected text by h3 tag
  */
 function headerH3() {
     let S=window.getSelection().toString();
@@ -179 +179 @@
     }
 }
 
+/**
+ * Wrapping selected text with pre tag
+ */
 function codeFormat() {
     let S=window.getSelection().toString();
     if(S.length == 0)