Skip to content

Commit 9ac022c

Browse files
committed
Add more doc comments
1 parent 01b11f7 commit 9ac022c

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

src/main/scala/scala/async/internal/LiveVariables.scala

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ trait LiveVariables {
99
/**
1010
* Returns for a given state a list of fields (as trees) that should be nulled out
1111
* upon resuming that state (at the beginning of `resume`).
12+
*
13+
* @param asyncStates the states of an `async` block
14+
* @param liftables the lifted fields
15+
* @return a map mapping a state to the fields that should be nulled out
16+
* upon resuming that state
1217
*/
1318
def fieldsToNullOut(asyncStates: List[AsyncState], liftables: List[Tree]): Map[Int, List[Tree]] = {
1419
// live variables analysis:
@@ -38,7 +43,9 @@ trait LiveVariables {
3843
* (possible through loops), the corresponding field should be nulled out (at the beginning of
3944
* `resume`).
4045
*
41-
* @return a map which indicates for a given field (the key) the states in which it should be nulled out
46+
* @param asyncStates the states of an `async` block
47+
* @param liftables the lifted fields
48+
* @return a map which indicates for a given field (the key) the states in which it should be nulled out
4249
*/
4350
def liveVars(asyncStates: List[AsyncState], liftables: List[Tree]): Map[Tree, Set[Int]] = {
4451
val liftedSyms: Set[Symbol] = // include only vars

0 commit comments

Comments
 (0)