Changeset 1301


Ignore:
Timestamp:
08/23/13 15:15:55 (11 years ago)
Author:
pharms
Message:
  • removed some TODOs as one TODO for commenting a class is sufficient for that class
Location:
trunk/autoquest-core-usability/src/main/java/de/ugoe/cs/autoquest/usability
Files:
6 edited

Legend:

Unmodified
Added
Removed
  • trunk/autoquest-core-usability/src/main/java/de/ugoe/cs/autoquest/usability/TextInputStatisticsRule.java

    r1300 r1301  
    6060 
    6161    /** 
    62      * TODO: comment 
    63      *  
    64      * @param statistics 
    65      * @param results 
     62     * 
    6663     */ 
    6764    private void analyzeStatistics(TextInputStatistics       statistics, 
     
    7471 
    7572    /** 
    76      * TODO: comment 
    77      *  
    78      * @param statistics 
    79      * @param results 
     73     * 
    8074     */ 
    8175    private void checkTextInputRatio(TextInputStatistics       statistics, 
     
    112106 
    113107    /** 
    114      * TODO: comment 
    115      *  
    116      * @param statistics 
    117      * @param results 
     108     * 
    118109     */ 
    119110    private void checkTextFieldEntryRepetitions(TextInputStatistics       statistics, 
     
    173164 
    174165    /** 
    175      * TODO: comment 
    176      *  
    177      * @param statistics 
    178      * @param results 
     166     * 
    179167     */ 
    180168    private void checkTextFieldNoLetterOrDigitInputs(TextInputStatistics       statistics, 
     
    232220 
    233221    /** 
    234      * TODO: comment 
    235222     *  
    236      * @param taskTree 
    237      * @param statistics 
    238223     */ 
    239224    private void calculateStatistics(Collection<ITask> tasks, TextInputStatistics statistics) { 
     
    244229 
    245230    /** 
    246      * TODO: comment 
    247      *  
    248      * @param taskTree 
    249      * @param statistics 
     231     * 
    250232     */ 
    251233    private void calculateStatistics(ITask task, TextInputStatistics statistics) { 
     
    271253 
    272254    /** 
    273      * <p> 
    274      * TODO: comment 
    275      * </p> 
    276      * 
    277      * @param task 
    278      * @return 
     255     * 
    279256     */ 
    280257    private boolean isTextInput(ITask task) { 
     
    290267 
    291268    /** 
    292      * TODO: comment 
    293      *  
    294      * @param taskTree 
    295      * @param statistics 
     269     * 
    296270     */ 
    297271    private void calculateStatistics(IEventTask node, TextInputStatistics statistics) { 
     
    316290 
    317291    /** 
    318      * TODO: comment 
    319      *  
    320      * @param enteredText 
    321      * @return 
     292     * 
    322293     */ 
    323294    private String[] determineTextFragments(String enteredText) { 
     
    350321 
    351322    /** 
    352      * TODO: comment 
    353      *  
    354      * @param lastChar 
    355      * @param currentChar 
    356      * @return 
     323     * 
    357324     */ 
    358325    private boolean isEqualCharacterType(char char1, char char2) { 
     
    383350 
    384351        /** 
    385          * TODO: comment 
    386          *  
    387          * @param node 
    388          * @param fragments 
    389          *  
     352         * 
    390353         */ 
    391354        public void addTextFieldInput(IEventTask node, String[] fragments) { 
     
    394357 
    395358        /** 
    396          * TODO: comment 
    397          *  
    398          * @param node 
    399          * @param fragments 
    400          *  
     359         * 
    401360         */ 
    402361        public void addTextAreaInput(IEventTask node, String[] fragments) { 
     
    405364 
    406365        /** 
    407          * TODO: comment 
    408          *  
    409          * @return 
     366         * 
    410367         */ 
    411368        public int getNoOfAllEvents() { 
     
    414371 
    415372        /** 
    416          * TODO: comment 
    417          *  
    418          * @return 
     373         * 
    419374         */ 
    420375        public int getNoOfTextFieldInputs() { 
     
    423378 
    424379        /** 
    425          * TODO: comment 
    426          *  
    427          * @param i 
    428          * @return 
     380         * 
    429381         */ 
    430382        public String[] getTextFieldInputFragments(int index) { 
     
    433385 
    434386        /** 
    435          * TODO: comment 
    436          *  
    437          * @return 
     387         * 
    438388         */ 
    439389        public int getNoOfTextAreaInputs() { 
     
    442392 
    443393        /** 
    444          * TODO: comment 
    445          *  
    446          * @param i 
    447          * @return 
     394         * 
    448395         */ 
    449396        public String[] getTextAreaInputFragments(int index) { 
     
    452399 
    453400        /** 
    454          * TODO: comment 
    455          *  
     401         * 
    456402         */ 
    457403        public void incrementNoOfOtherEventTasks() { 
  • trunk/autoquest-core-usability/src/main/java/de/ugoe/cs/autoquest/usability/UsabilityDefect.java

    r927 r1301  
    3535 
    3636    /** 
    37      * TODO: comment 
    38      *  
    39      * @param medium 
    40      * @param highTextInputRatio 
     37     * 
    4138     */ 
    4239    public UsabilityDefect(UsabilityDefectSeverity severity, UsabilityDefectDescription description) 
     
    4643 
    4744    /** 
    48      * TODO: comment 
    49      *  
    50      * @param medium 
    51      * @param highTextInputRatio 
     45     * 
    5246     */ 
    5347    public UsabilityDefect(UsabilityDefectSeverity    severity, 
     
    6155 
    6256    /** 
    63      * TODO: comment 
    6457     *  
    65      * @return 
    6658     */ 
    6759    public UsabilityDefectSeverity getSeverity() { 
     
    7062 
    7163    /** 
    72      * @param severity 
    73      *            the severity to set 
     64     * 
    7465     */ 
    7566    public void setSeverity(UsabilityDefectSeverity severity) { 
     
    7869 
    7970    /** 
    80      * @param description 
    81      *            the description to set 
     71     * 
    8272     */ 
    8373    public void setDescription(UsabilityDefectDescription description) { 
     
    8676 
    8777    /** 
    88    *  
    89    */ 
     78     *  
     79     */ 
    9080    public String getParameterizedDescription() { 
    9181        return description.toString(descriptionParameters); 
  • trunk/autoquest-core-usability/src/main/java/de/ugoe/cs/autoquest/usability/UsabilityDefectDescription.java

    r927 r1301  
    4747 
    4848    /** 
    49      * TODO: comment 
    50      *  
    51      * @param name 
    52      * @param ordinal 
     49     * 
    5350     */ 
    5451    private UsabilityDefectDescription() { 
     
    5754 
    5855    /** 
    59      * TODO: comment 
    60      *  
     56     * 
    6157     */ 
    6258    @SuppressWarnings("unchecked") 
     
    108104 
    109105    /** 
    110    *  
    111    */ 
     106     *  
     107     */ 
    112108    public String[] getDescriptionParameters() { 
    113109        List<String> parameters = new ArrayList<String>(); 
     
    123119 
    124120    /** 
    125    *  
    126    */ 
     121     *  
     122     */ 
    127123    public String toString(Map<String, String> parameters) throws IllegalArgumentException { 
    128124        StringBuffer result = new StringBuffer(); 
     
    186182 
    187183    /** 
    188      * TODO: comment 
    189      *  
    190      * @param fragment 
    191      * @return 
     184     * 
    192185     */ 
    193186    private String getFragmentString(Object fragment) { 
  • trunk/autoquest-core-usability/src/main/java/de/ugoe/cs/autoquest/usability/UsabilityEvaluationManager.java

    r1149 r1301  
    3434 
    3535    /** 
    36      * TODO: comment 
    3736     *  
    3837     */ 
     
    4342 
    4443    /** 
    45      * TODO: comment 
    4644     *  
    4745     */ 
     
    5149 
    5250    /** 
    53      * TODO: comment 
    54      *  
    55      * @param taskTree 
     51     * 
    5652     */ 
    5753    public UsabilityEvaluationResult evaluateUsability(ITaskModel taskModel) { 
     
    7672 
    7773    /** 
    78      * TODO: comment 
    79      *  
    80      * @param results 
    81      * @return 
     74     * 
    8275     */ 
    8376    private UsabilityEvaluationResult mergeResults(List<UsabilityEvaluationResult> results) { 
  • trunk/autoquest-core-usability/src/main/java/de/ugoe/cs/autoquest/usability/UsabilityEvaluationResult.java

    r927 r1301  
    3030 
    3131    /** 
    32      * TODO: comment 
    33      *  
    34      * @param defect 
     32     * 
    3533     */ 
    3634    public void addDefect(UsabilityDefect defect) { 
     
    3937 
    4038    /** 
    41      * TODO: comment 
    42      *  
    43      * @return 
     39     * 
    4440     */ 
    4541    public List<UsabilityDefect> getAllDefects() { 
     
    4844 
    4945    /** 
    50      * TODO: comment 
    51      *  
    52      * @return 
     46     * 
    5347     */ 
    5448    public List<UsabilityDefect> getSevereDefects() { 
  • trunk/autoquest-core-usability/src/main/java/de/ugoe/cs/autoquest/usability/UsabilityEvaluationRule.java

    r1149 r1301  
    2626 
    2727    /** 
    28      * TODO: comment 
    29      *  
    30      * @param taskTree 
    31      * @return 
     28     * 
    3229     */ 
    3330    UsabilityEvaluationResult evaluate(ITaskModel taskModel); 
Note: See TracChangeset for help on using the changeset viewer.