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/treeifc/TaskMetric.java

    r1733 r1734  
    1717import java.text.DecimalFormat; 
    1818 
     19// TODO: Auto-generated Javadoc 
    1920/** 
    2021 * <p> 
    … …  
    2829public enum TaskMetric { 
    2930 
    30         COUNT("count", "number of all occurrences of the task in the model"), DEPTH( 
     31        /** The count. */ 
     32        COUNT("count", "number of all occurrences of the task in the model"), /** The depth. */ 
     33 DEPTH( 
    3134                        "depth", 
    3235                        "the maximum depth of the task, i.e., the number of children levels including the " 
    33                                         + "level of the task itself"), EVENT_COVERAGE( 
     36                                        + "level of the task itself"),  
     37 /** The event coverage. */ 
     38 EVENT_COVERAGE( 
    3439                        "covered events", 
    35                         "number of all event task instances covered by the task"), EVENT_COVERAGE_RATIO( 
     40                        "number of all event task instances covered by the task"),  
     41 /** The event coverage ratio. */ 
     42 EVENT_COVERAGE_RATIO( 
    3643                        "event coverage ratio", 
    3744                        "the ratio of events covered by this task in relation to all events " 
    3845                                        + "covered by all tasks in their instances in per mille", 
    39                         0.1, "%"), EVENT_COVERAGE_QUANTILE("event coverage ratio quantile", 
     46                        0.1, "%"),  
     47 /** The event coverage quantile. */ 
     48 EVENT_COVERAGE_QUANTILE("event coverage ratio quantile", 
    4049                        "the quantile of with respect to all event coverages begining with " 
    4150                                        + "the lowest", 0.1, "%"); 
    4251 
    43         /** 
    44          * <p> 
    45          * the name of the metric 
    46          * </p> 
    47          */ 
     52        /** <p> the name of the metric </p>. */ 
    4853        private String name; 
    4954 
    50         /** 
    51          * <p> 
    52          * a human readable description of the metric 
    53          * </p> 
    54          */ 
     55        /** <p> a human readable description of the metric </p>. */ 
    5556        private String description; 
    5657 
    57         /** 
    58          * <p> 
    59          * a scale applied for the metric when formatting the value 
    60          * </p> 
    61          */ 
     58        /** <p> a scale applied for the metric when formatting the value </p>. */ 
    6259        private double formatScale; 
    6360 
    64         /** 
    65          * <p> 
    66          * the unit of the metric used when formatting the value 
    67          * </p> 
    68          */ 
     61        /** <p> the unit of the metric used when formatting the value </p>. */ 
    6962        private String formatUnit; 
    7063 
    … …  
    7265         * <p> 
    7366         * initializes the metric with a name and a description 
    74          * </p> 
     67         * </p>. 
     68         * 
     69         * @param name the name 
     70         * @param description the description 
    7571         */ 
    7672        private TaskMetric(String name, String description) { 
    … …  
    8682         * scale and a unit for formatting it. 
    8783         * </p> 
     84         * 
     85         * @param name the name 
     86         * @param description the description 
     87         * @param formatScale the format scale 
     88         * @param formatUnit the format unit 
    8889         */ 
    8990        private TaskMetric(String name, String description, double formatScale, 
    … …  
    100101         * format scale and unit. 
    101102         * </p> 
    102          *  
     103         * 
     104         * @param value the value 
    103105         * @return the formatted value depending on the scale and unit of the metric 
    104106         */ 
    … …  
    124126         * <p> 
    125127         * returns the human readable description of the metric 
    126          * </p> 
    127          *  
     128         * </p>. 
     129         * 
    128130         * @return the human readable description of the metric 
    129131         */ 
    … …  
    135137         * <p> 
    136138         * returns the name of the metric 
    137          * </p> 
    138          *  
     139         * </p>. 
     140         * 
    139141         * @return the name of the metric 
    140142         */ 
Note: See TracChangeset for help on using the changeset viewer.