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

    r1733 r1734  
    1515package de.ugoe.cs.autoquest.tasktrees.treeifc; 
    1616 
     17// TODO: Auto-generated Javadoc 
    1718/** 
    1819 * <p> 
    … …  
    4546         * <p> 
    4647         * adds a child task to a selection 
    47          * </p> 
    48          *  
    49          * @param parent 
    50          *            the selection to add the child to 
    51          * @param child 
    52          *            the child to be added 
     48         * </p>. 
     49         * 
     50         * @param parent            the selection to add the child to 
     51         * @param child            the child to be added 
    5352         */ 
    5453        void addChild(ISelection parent, ITask child); 
    … …  
    5756         * <p> 
    5857         * adds a child task to a specific index of a sequence 
    59          * </p> 
    60          *  
    61          * @param parent 
    62          *            the sequence to add the child to 
    63          * @param index 
    64          *            the index to set the child at 
    65          * @param child 
    66          *            the child to be added 
    67          *  
    68          * @throws IndexOutOfBoundsException 
    69          *             if the index is invalid 
     58         * </p>. 
     59         * 
     60         * @param parent            the sequence to add the child to 
     61         * @param index            the index to set the child at 
     62         * @param child            the child to be added 
     63         * @throws IndexOutOfBoundsException             if the index is invalid 
    7064         */ 
    7165        void addChild(ISequence parent, int index, ITask child) 
    … …  
    7569         * <p> 
    7670         * adds a child task to the end of a sequence 
    77          * </p> 
    78          *  
    79          * @param parent 
    80          *            the sequence to add the child to 
    81          * @param child 
    82          *            the child to be added 
     71         * </p>. 
     72         * 
     73         * @param parent            the sequence to add the child to 
     74         * @param child            the child to be added 
    8375         */ 
    8476        void addChild(ISequence parent, ITask child); 
    … …  
    10597         * <p> 
    10698         * adds a task instance to a user session 
    107          * </p> 
    108          * 
    109          * @param session 
    110          *            the session to add the task instance to 
    111          * @param taskInstance 
    112          *            the task instance to add 
     99         * </p>. 
     100         * 
     101         * @param session            the session to add the task instance to 
     102         * @param taskInstance            the task instance to add 
    113103         */ 
    114104        void addExecutedTask(IUserSession session, ITaskInstance taskInstance); 
    … …  
    136126         * <p> 
    137127         * adds a task instance to a task instance list 
    138          * </p> 
    139          *  
    140          * @param taskInstanceList 
    141          *            the list to add the task instance to 
    142          * @param taskInstance 
    143          *            the task instance to add 
     128         * </p>. 
     129         * 
     130         * @param taskInstanceList            the list to add the task instance to 
     131         * @param taskInstance            the task instance to add 
    144132         */ 
    145133        void addTaskInstance(ITaskInstanceList taskInstanceList, 
    … …  
    162150         * <p> 
    163151         * removes the child of a sequence at a specific position 
    164          * </p> 
    165          *  
    166          * @param parent 
    167          *            the sequence of which the child must be removed 
    168          * @param index 
    169          *            the index of the child to be removed 
    170          *  
    171          * @throws IndexOutOfBoundsException 
    172          *             if the index is invalid 
     152         * </p>. 
     153         * 
     154         * @param parent            the sequence of which the child must be removed 
     155         * @param index            the index of the child to be removed 
     156         * @throws IndexOutOfBoundsException             if the index is invalid 
    173157         */ 
    174158        void removeChild(ISequence parent, int index) 
    … …  
    178162         * <p> 
    179163         * removes the entry of a task instance list at a specific position 
    180          * </p> 
    181          *  
    182          * @param taskInstanceList 
    183          *            the task instance list of which the entry must be removed 
    184          * @param index 
    185          *            the index of the entry to be removed 
    186          *  
    187          * @throws IndexOutOfBoundsException 
    188          *             if the index is invalid 
     164         * </p>. 
     165         * 
     166         * @param taskInstanceList            the task instance list of which the entry must be removed 
     167         * @param index            the index of the entry to be removed 
     168         * @throws IndexOutOfBoundsException             if the index is invalid 
    189169         */ 
    190170        void removeTaskInstance(ITaskInstanceList taskInstanceList, int index) 
    … …  
    196176         * the child is not found (comparison using equals). 
    197177         * </p> 
    198          *  
    199          * @param parent 
    200          *            the selection of which the child must be replace 
    201          * @param oldChild 
    202          *            the child to replace 
    203          * @param newChild 
    204          *            the replacement for the child 
    205          *  
    206          * @throws as 
    207          *             described 
     178         * 
     179         * @param parent            the selection of which the child must be replace 
     180         * @param oldChild            the child to replace 
     181         * @param newChild            the replacement for the child 
    208182         */ 
    209183        void replaceChild(ISelection parent, ITask oldChild, ITask newChild); 
    … …  
    248222         * <p> 
    249223         * replaces the child task of a sequence at a specific position 
    250          * </p> 
    251          *  
    252          * @param parent 
    253          *            the sequence to replace the child in 
    254          * @param index 
    255          *            the index to replace the child at 
    256          * @param child 
    257          *            the child to be added 
    258          *  
    259          * @throws IndexOutOfBoundsException 
    260          *             if the index is invalid 
     224         * </p>. 
     225         * 
     226         * @param parent            the sequence to replace the child in 
     227         * @param index            the index to replace the child at 
     228         * @param child            the child to be added 
     229         * @throws IndexOutOfBoundsException             if the index is invalid 
    261230         */ 
    262231        void setChild(ISequence parent, int index, ITask child) 
    … …  
    266235         * <p> 
    267236         * sets the child task of an iteration 
    268          * </p> 
    269          *  
    270          * @param iteration 
    271          *            the iteration to set the child of 
    272          * @param child 
    273          *            the child to be set 
     237         * </p>. 
     238         * 
     239         * @param iteration            the iteration to set the child of 
     240         * @param child            the child to be set 
    274241         */ 
    275242        void setMarkedTask(IIteration iteration, ITask child); 
    … …  
    278245         * <p> 
    279246         * sets the child task of an optional 
    280          * </p> 
    281          *  
    282          * @param optional 
    283          *            the optional to set the child of 
    284          * @param child 
    285          *            the child to be set 
     247         * </p>. 
     248         * 
     249         * @param optional            the optional to set the child of 
     250         * @param child            the child to be set 
    286251         */ 
    287252        void setMarkedTask(IOptional optional, ITask child); 
    … …  
    290255         * <p> 
    291256         * sets the task model of a task instance 
    292          * </p> 
    293          *  
    294          * @param taskInstance 
    295          *            the task instance to set the task model for 
    296          * @param task 
    297          *            the task model of the instance 
     257         * </p>. 
     258         * 
     259         * @param taskInstance            the task instance to set the task model for 
     260         * @param task            the task model of the instance 
    298261         */ 
    299262        void setTask(ITaskInstance taskInstance, ITask task); 
    … …  
    302265         * <p> 
    303266         * sets a task instance in a task instance list at a specific position 
    304          * </p> 
    305          *  
    306          * @param taskInstanceList 
    307          *            the list to set the task instance in 
    308          * @param index 
    309          *            the index of the task instance to replace 
    310          * @param taskInstance 
    311          *            the replacement for the task instance at the index 
    312          *  
    313          * @throws IndexOutOfBoundsException 
    314          *             if the index is invalid 
     267         * </p>. 
     268         * 
     269         * @param taskInstanceList            the list to set the task instance in 
     270         * @param index            the index of the task instance to replace 
     271         * @param taskInstance            the replacement for the task instance at the index 
     272         * @throws IndexOutOfBoundsException             if the index is invalid 
    315273         */ 
    316274        void setTaskInstance(ITaskInstanceList taskInstanceList, int index, 
Note: See TracChangeset for help on using the changeset viewer.