diff options
author | paltherr <paltherr@epfl.ch> | 2003-09-02 07:38:04 +0000 |
---|---|---|
committer | paltherr <paltherr@epfl.ch> | 2003-09-02 07:38:04 +0000 |
commit | 003528200c7f1b19ffd234dff69e203072d79fff (patch) | |
tree | 7fa28e8d4139d9e75d758a9809f0bc30abda12f2 /sources | |
parent | 860d5686c0af6d6afc5266aded4a269cc5e104b7 (diff) | |
download | scala-003528200c7f1b19ffd234dff69e203072d79fff.tar.gz scala-003528200c7f1b19ffd234dff69e203072d79fff.tar.bz2 scala-003528200c7f1b19ffd234dff69e203072d79fff.zip |
- Added more documentation to methods setInfo a...
- Added more documentation to methods setInfo and updateInfo
Diffstat (limited to 'sources')
-rw-r--r-- | sources/scalac/symtab/Symbol.java | 33 |
1 files changed, 28 insertions, 5 deletions
diff --git a/sources/scalac/symtab/Symbol.java b/sources/scalac/symtab/Symbol.java index a9ee5273ac..2eba395c3e 100644 --- a/sources/scalac/symtab/Symbol.java +++ b/sources/scalac/symtab/Symbol.java @@ -131,17 +131,31 @@ public abstract class Symbol implements Modifiers, Kinds { /** Set type -- this is an alias for setInfo(Type info) */ public final Symbol setType(Type info) { return setInfo(info); } - /** Set initial information valid from start of current phase. */ + /** + * Set initial information valid from start of current phase. This + * information is visible in the current phase and will be + * transformed by the current phase (except if current phase is + * the first one). + */ public Symbol setInfo(Type info) { return setInfoAt(info, Global.instance.currentPhase); } - /** Set initial information valid from start of first phase. */ + /** + * Set initial information valid from start of first phase. This + * information is visible in the first phase and will be + * transformed by all phases excepted the first one. + */ public final Symbol setFirstInfo(Type info) { return setInfoAt(info, Global.instance.getFirstPhase()); } - /** Set initial information valid from start of given phase. */ + /** + * Set initial information valid from start of given phase. This + * information is visible in the given phase and will be + * transformed by the given phase (except if it is the first + * phase). + */ private final Symbol setInfoAt(Type info, Phase phase) { assert phase != null : this; assert !isConstructor() @@ -159,12 +173,21 @@ public abstract class Symbol implements Modifiers, Kinds { return this; } - /** Set new information valid from start of next phase */ + /** + * Set new information valid from start of next phase. This + * information is only visible in next phase or through + * "nextInfo". It will not be transformed by the current phase. + */ public final Symbol updateInfo(Type info) { return updateInfoAt(info, Global.instance.currentPhase); } - /** Set new information valid from start of given phase */ + /** + * Set new information valid from start of phase after given + * phase. This information is only visible from the start of the + * phase after the given phase. It will not be tranformed by the + * given phase. + */ private final Symbol updateInfoAt(Type info, Phase phase) { assert infos != null : this; assert !phase.precedes(infos.limit()) : |