Ignore:
Timestamp:
09/05/14 20:20:29 (10 years ago)
Author:
rkrimmel
Message:

Added automatically created javadoc, still needs to be commented properly though

File:
1 edited

Legend:

Unmodified
Added
Removed

  • branches/autoquest-core-tasktrees-alignment/src/main/java/de/ugoe/cs/autoquest/tasktrees/treeimpl/Task.java

    r1733 r1734  
    3030import de.ugoe.cs.autoquest.tasktrees.treeifc.ITaskVisitor; 
    3131 
     32// TODO: Auto-generated Javadoc 
    3233/** 
    3334 * <p> 
    … …  
    5859        } 
    5960 
    60         /** 
    61          * <p> 
    62          * default serial version UID 
    63          * </p> 
    64          */ 
     61        /** <p> default serial version UID </p>. */ 
    6562        private static final long serialVersionUID = 1L; 
    6663 
    … …  
    8178        private final int id; 
    8279 
    83         /** 
    84          * <p> 
    85          * a human readable type of the task (used for visualization purposes) 
    86          * </p> 
    87          */ 
     80        /** <p> a human readable type of the task (used for visualization purposes) </p>. */ 
    8881        private final String type; 
    8982 
    90         /** 
    91          * <p> 
    92          * a human readable description of the task 
    93          * </p> 
    94          */ 
     83        /** <p> a human readable description of the task </p>. */ 
    9584        private String description; 
    9685 
    97         /** 
    98          * <p> 
    99          * the instances of this task 
    100          * </p> 
    101          */ 
     86        /** <p> the instances of this task </p>. */ 
    10287        private final Collection<ITaskInstance> instances = new HashSet<ITaskInstance>(); 
    10388 
    104         /** 
    105          * <p> 
    106          * the execution variants of this task 
    107          * </p> 
    108          */ 
     89        /** <p> the execution variants of this task </p>. */ 
    10990        private Collection<Collection<ITaskInstance>> executionVariants; 
    11091 
    … …  
    11495         * {@link #getNewId()} method 
    11596         * </p> 
    116          *  
    117          * @param type 
    118          *            the human readable type of the task 
    119          *  
    120          * @throws IllegalArgumentException 
    121          *             in the case the provided type is null 
     97         * 
     98         * @param type            the human readable type of the task 
    12299         */ 
    123100        Task(String type) { 
    … …  
    143120         * <p> 
    144121         * internally used to add an instance to this task 
    145          * </p> 
    146          *  
    147          * @param instance 
    148          *            the instance belonging to this task 
     122         * </p>. 
     123         * 
     124         * @param instance            the instance belonging to this task 
    149125         */ 
    150126        synchronized void addInstance(ITaskInstance instance) { 
    … …  
    172148 
    173149        /** 
    174          * 
     150         * Determine execution variants. 
     151         * 
     152         * @param executionVariants the execution variants 
    175153         */ 
    176154        private void determineExecutionVariants( 
    … …  
    273251 
    274252        /** 
    275          * 
     253         * Checks if is same execution. 
     254         * 
     255         * @param instance1 the instance1 
     256         * @param instance2 the instance2 
     257         * @return true, if is same execution 
    276258         */ 
    277259        private boolean isSameExecution(ITaskInstance instance1, 
    … …  
    327309 
    328310        /** 
    329          * 
     311         * Checks if is same execution list. 
     312         * 
     313         * @param list1 the list1 
     314         * @param list2 the list2 
     315         * @return true, if is same execution list 
    330316         */ 
    331317        private boolean isSameExecutionList(ITaskInstanceList list1, 
    … …  
    347333         * <p> 
    348334         * internally used to remove an instance from this task 
    349          * </p> 
    350          *  
    351          * @param instance 
    352          *            the instance to be removed from this task 
     335         * </p>. 
     336         * 
     337         * @param instance            the instance to be removed from this task 
    353338         */ 
    354339        synchronized void removeInstance(ITaskInstance instance) { 
    … …  
    360345         * <p> 
    361346         * internally used to set the human readable description of the task 
    362          * </p> 
    363          *  
    364          * @param description 
    365          *            the new human readable description of the task 
     347         * </p>. 
     348         * 
     349         * @param description            the new human readable description of the task 
    366350         */ 
    367351        void setDescription(String description) { 
Note: See TracChangeset for help on using the changeset viewer.