Merge branch 'dev_v1' of https://gitlab2.istic.univ-rennes1.fr/tuvu/cartailor into dev_v1

src/fr/api/Configuration.java

@@ -7,12 +7,38 @@ public interface Configuration {
      * @return true if there is no compatibility issue between PartType else false
      */
     boolean isValid();
-
-
+    
+    /*
+     * @return true if the configuration is valid and done
+     */
     boolean isComplete();
+
+    /*
+     * @return the list of the PartType in the configuration
+     */
     Set<PartType> getSelectedParts();
+    
+    /*
+     * Select a PartType to add to the configuration
+     * @param chosenPart : the PartType that we wish to add to the configuration
+     */
     void selectPart(PartType chosenPart);
+
+    /*
+     * @return the PartType that we chose earlier which has Category we choose
+     * @param catgeory : Category that we want to know about the PartType can be null
+     */
     PartType getSelectionForCategory(Category category);
+
+    /*
+     * DeSelect PartType has Catgerory catgoryToClear to delete from the configuration
+     * @param categoryToClear : the PartType has categoryToClear Category
+     * that we wish to delete from the configuration
+     */
     void unselectPartType(Category categoryToClear);
+
+    /*
+     * Remove all PartType from configuation
+     */
     void clear();
 }

src/fr/api/Configurator.java

@@ -1,8 +1,24 @@
 package src.fr.api;
 import java.util.Set;
 public interface Configurator {
+    /*
+     * @return the list of the Category in the configurator
+     */
     Set<Category> getCategories();
+    
+    /*
+     * @return the list of the Category in the configurator
+     * @param category: category that we want to see all PartType in that category
+     */
     Set<PartType> getVariants(Category category);
+        
+    /*
+     * @return the configuration
+     */
     Configuration getConfiguration();
+
+    /*
+     * @return compabilitychecker
+     */
     CompatibilityChecker getCompatibilityChecker();
 }

src/fr/api/PartType.java

@@ -1,5 +1,12 @@
 package src.fr.api;
 public interface PartType {
+    /*
+     * @return name of this PartType
+     */
     String getName();
+
+    /*
+     * @return the category of this PartType
+     */
     Category getCategory();
 }

src/fr/impl/CompatibilityCheckerImpl.java

@@ -22,6 +22,4 @@ public class CompatibilityCheckerImpl implements CompatibilityChecker {
     public Set<PartType> getRequirements(PartType reference) {
         return this.compatibilityManager.getRequirements(reference);
     }
-
-
 }