Ignore:
Timestamp:
05/27/13 15:24:09 (11 years ago)
Author:
pharms
Message:
  • improved java doc
File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r1157 r1215  
    1919 
    2020/** 
    21  * TODO comment 
     21 * <p> 
     22 * this is the default implementation of the interface {@link ITask}. It 
     23 * does not do anything fancy except implementing the interface. 
     24 * </p> 
    2225 *  
    23  * @version $Revision: $ $Date: $ 
    24  * @author 2011, last modified by $Author: $ 
     26 * @author Patrick Harms 
    2527 */ 
    2628class Task implements ITask { 
    2729 
    28     /**  */ 
     30    /** 
     31     * <p> 
     32     * default serial version UID 
     33     * </p> 
     34     */ 
    2935    private static final long serialVersionUID = 1L; 
    3036 
    31     /** */ 
     37    /** 
     38     * <p> 
     39     * used as a counter to generate new ids for each newly created task. May overflow. 
     40     * </p> 
     41     */ 
    3242    private static int temporalId = 0; 
    3343 
    34     /** */ 
     44    /** 
     45     * <p> 
     46     * the id of the task (unique throughout the system as long as {@link #temporalId} does not 
     47     * overflow. 
     48     * </p> 
     49     */ 
    3550    private int id; 
    3651 
    37     /** */ 
     52    /** 
     53     * <p> 
     54     * a human readable description of the task 
     55     * </p> 
     56     */ 
    3857    private String description; 
    3958 
    4059    /** 
    41      *  
     60     * <p> 
     61     * constructs a new task with a new id. The id is generated using the {@link #getNewId()} 
     62     * methdod 
     63     * </p> 
    4264     */ 
    4365    Task() { 
    … …  
    4668 
    4769    /** 
    48      * TODO: comment 
     70     * <p> 
     71     * creates a new id for a task using {@link #temporalId} by incrementing it an returning its 
     72     * current value. Resets the counter if {@link Integer.MAX_VALUE} is reached. 
     73     * </p> 
    4974     *  
    50      * @return 
     75     * @return a new unique id for a task as long as {@link #temporalId} does not overflow 
    5176     */ 
    5277    private static synchronized int getNewId() { 
    … …  
    5883    } 
    5984 
    60     /** 
    61      * @return Returns the name. 
     85    /* (non-Javadoc) 
     86     * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#geId() 
    6287     */ 
     88    @Override 
    6389    public int getId() { 
    6490        return id; 
    6591    } 
    6692 
    67     /* 
    68      * (non-Javadoc) 
    69      *  
    70      * @see de.ugoe.cs.tasktree.treeifc.TaskTreeNode#getDescription() 
     93    /* (non-Javadoc) 
     94     * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#getDescription() 
    7195     */ 
    7296    @Override 
    … …  
    7599    } 
    76100 
    77     /* 
    78      * (non-Javadoc) 
    79      *  
    80      * @see de.ugoe.cs.autoquest.tasktrees.treeifc.TaskTreeNode#equals(TaskTreeNode) 
     101    /* (non-Javadoc) 
     102     * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#equals(ITask) 
    81103     */ 
    82104    @Override 
    … …  
    87109    } 
    88110 
    89     /* 
    90      * (non-Javadoc) 
    91      *  
    92      * @see java.lang.Object#hashCode() 
     111    /* (non-Javadoc) 
     112     * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#hashCode() 
    93113     */ 
    94114    @Override 
    … …  
    97117    } 
    98118 
    99     /* 
    100      * (non-Javadoc) 
    101      *  
     119    /* (non-Javadoc) 
    102120     * @see java.lang.Object#toString() 
    103121     */ 
    … …  
    117135    } 
    118136 
    119     /* 
    120      * (non-Javadoc) 
    121      *  
    122      * @see java.lang.Object#clone() 
     137    /* (non-Javadoc) 
     138     * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#clone() 
    123139     */ 
    124140    @Override 
    … …  
    137153 
    138154    /** 
    139      * TODO: comment 
     155     * <p> 
     156     * internally used to set the human readable description of the task 
     157     * </p> 
    140158     *  
    141      * @param i 
    142      * @return 
     159     * @param description the new human readable description of the task 
    143160     */ 
    144161    void setDescription(String description) { 
    … …  
    147164 
    148165    /* (non-Javadoc) 
    149      * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#accept(de.ugoe.cs.autoquest.tasktrees.treeifc.TaskVisitor) 
     166     * @see de.ugoe.cs.autoquest.tasktrees.treeifc.ITask#accept(ITaskVisitor) 
    150167     */ 
    151168    @Override 
Note: See TracChangeset for help on using the changeset viewer.