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/TaskInfo.java

    r1733 r1734  
    2222import de.ugoe.cs.autoquest.tasktrees.treeifc.TaskMetric; 
    2323 
     24// TODO: Auto-generated Javadoc 
    2425/** 
    2526 * <p> 
    … …  
    4243        private static class Measure implements IMeasure { 
    4344 
    44                 /** 
    45                  * <p> 
    46                  * the metric to which the measure belongs 
    47                  * </p> 
    48                  */ 
     45                /** <p> the metric to which the measure belongs </p>. */ 
    4946                private final TaskMetric metric; 
    5047 
    51                 /** 
    52                  * <p> 
    53                  * the observed values for the difference contexts of the task 
    54                  * </p> 
    55                  */ 
     48                /** <p> the observed values for the difference contexts of the task </p>. */ 
    5649                private HashMap<ITask, Integer> values; 
    5750 
    58                 /** 
    59                  * <p> 
    60                  * the context free value of the measure independent of the task context 
    61                  * </p> 
    62                  */ 
     51                /** <p> the context free value of the measure independent of the task context </p>. */ 
    6352                private int contextFreeValue = 0; 
    6453 
    … …  
    6655                 * <p> 
    6756                 * initializes the measure with a specific metric 
    68                  * </p> 
     57                 * </p>. 
     58                 * 
     59                 * @param metric the metric 
    6960                 */ 
    7061                private Measure(TaskMetric metric) { 
    … …  
    119110                 * increases the value of the measure context free as well as specific 
    120111                 * to the provided context according to the provided increment 
    121                  * </p> 
     112                 * </p>. 
     113                 * 
     114                 * @param context the context 
     115                 * @param increment the increment 
    122116                 */ 
    123117                private void increase(ITask context, int increment) { 
    … …  
    143137                 * sets the value of the measure context free as well as specific to the 
    144138                 * provided context 
    145                  * </p> 
     139                 * </p>. 
     140                 * 
     141                 * @param context the context 
     142                 * @param value the value 
    146143                 */ 
    147144                private void set(ITask context, int value) { 
    … …  
    159156        } 
    160157 
    161         /** 
    162          * <p> 
    163          * the task to which the infos belong 
    164          * </p> 
    165          */ 
     158        /** <p> the task to which the infos belong </p>. */ 
    166159        private final ITask task; 
    167160 
    168         /** 
    169          * <p> 
    170          * all available measures for the task 
    171          * </p> 
    172          */ 
     161        /** <p> all available measures for the task </p>. */ 
    173162        private final ArrayList<Measure> measures = new ArrayList<Measure>(); 
    174163 
    … …  
    177166         * initialized the task infos with the task to which they belong. 
    178167         * </p> 
    179          *  
    180          * @param task 
     168         * 
     169         * @param task the task 
    181170         */ 
    182171        TaskInfo(ITask task) { 
    … …  
    209198         * convenience method to internally determine the measure for a specific 
    210199         * metric 
    211          * </p> 
     200         * </p>. 
     201         * 
     202         * @param metric the metric 
     203         * @return the measure 
    212204         */ 
    213205        private Measure getMeasure(TaskMetric metric) { 
    … …  
    282274         * increases a specific value for a measure of a specific metric in the 
    283275         * provided context of the task 
    284          * </p> 
    285          *  
    286          * @param metric 
    287          *            the metric to which the value belongs 
    288          * @param context 
    289          *            the context of the task in which the measure was recorded 
    290          * @param increment 
    291          *            the increment to be added to the value of the measure 
     276         * </p>. 
     277         * 
     278         * @param metric            the metric to which the value belongs 
     279         * @param context            the context of the task in which the measure was recorded 
     280         * @param increment            the increment to be added to the value of the measure 
    292281         */ 
    293282        void increaseCount(TaskMetric metric, ITask context, int increment) { 
    … …  
    307296         * sets a specific value for a measure of a specific metric in the provided 
    308297         * context of the task 
    309          * </p> 
    310          *  
    311          * @param metric 
    312          *            the metric to which the value belongs 
    313          * @param context 
    314          *            the context of the task in which the measure was recorded 
    315          * @param value 
    316          *            the value of the measure 
     298         * </p>. 
     299         * 
     300         * @param metric            the metric to which the value belongs 
     301         * @param context            the context of the task in which the measure was recorded 
     302         * @param value            the value of the measure 
    317303         */ 
    318304        void setCount(TaskMetric metric, ITask context, int value) { 
Note: See TracChangeset for help on using the changeset viewer.