Updated package info documentation.

This commit is contained in:
Jack Conradson 2016-06-06 15:34:51 -07:00
parent b249dd015d
commit f897342296
3 changed files with 8 additions and 0 deletions

View File

@ -30,6 +30,9 @@ import org.elasticsearch.painless.Variables.Variable;
import org.objectweb.asm.Label; import org.objectweb.asm.Label;
import org.objectweb.asm.Opcodes; import org.objectweb.asm.Opcodes;
/**
* Represents a for-each loop shortcut for arrays. (Internal only.)
*/
class SArrayEach extends AStatement { class SArrayEach extends AStatement {
final int maxLoopCounter; final int maxLoopCounter;
final String type; final String type;

View File

@ -33,6 +33,9 @@ import org.elasticsearch.painless.Variables.Variable;
import org.objectweb.asm.Label; import org.objectweb.asm.Label;
import org.objectweb.asm.Opcodes; import org.objectweb.asm.Opcodes;
/**
* Represents a for-each loop shortcut for iterables. Defers to other S-nodes for non-iterable types.
*/
public class SEach extends AStatement { public class SEach extends AStatement {
final int maxLoopCounter; final int maxLoopCounter;

View File

@ -63,6 +63,7 @@
* {@link org.elasticsearch.painless.node.LStatic} - Represents a static type target. * {@link org.elasticsearch.painless.node.LStatic} - Represents a static type target.
* {@link org.elasticsearch.painless.node.LString} - Represents a string constant. * {@link org.elasticsearch.painless.node.LString} - Represents a string constant.
* {@link org.elasticsearch.painless.node.LVariable} - Represents a variable load/store. * {@link org.elasticsearch.painless.node.LVariable} - Represents a variable load/store.
* {@link org.elasticsearch.painless.node.SArrayEach} - Represents a for each loop shortcut for arrays. (Internal only.)
* {@link org.elasticsearch.painless.node.SBlock} - Represents a set of statements as a branch of control-flow. * {@link org.elasticsearch.painless.node.SBlock} - Represents a set of statements as a branch of control-flow.
* {@link org.elasticsearch.painless.node.SBreak} - Represents a break statement. * {@link org.elasticsearch.painless.node.SBreak} - Represents a break statement.
* {@link org.elasticsearch.painless.node.SCatch} - Represents a catch block as part of a try-catch block. * {@link org.elasticsearch.painless.node.SCatch} - Represents a catch block as part of a try-catch block.
@ -70,6 +71,7 @@
* {@link org.elasticsearch.painless.node.SDeclaration} - Represents a single variable declaration. * {@link org.elasticsearch.painless.node.SDeclaration} - Represents a single variable declaration.
* {@link org.elasticsearch.painless.node.SDeclBlock} - Represents a series of declarations. * {@link org.elasticsearch.painless.node.SDeclBlock} - Represents a series of declarations.
* {@link org.elasticsearch.painless.node.SDo} - Represents a do-while loop. * {@link org.elasticsearch.painless.node.SDo} - Represents a do-while loop.
* {@link org.elasticsearch.painless.node.SEach} - Represents a for each loop shortcut for iterables.
* {@link org.elasticsearch.painless.node.SExpression} - Represents the top-level node for an expression as a statement. * {@link org.elasticsearch.painless.node.SExpression} - Represents the top-level node for an expression as a statement.
* {@link org.elasticsearch.painless.node.SFor} - Represents a for loop. * {@link org.elasticsearch.painless.node.SFor} - Represents a for loop.
* {@link org.elasticsearch.painless.node.SIf} - Represents an if block. * {@link org.elasticsearch.painless.node.SIf} - Represents an if block.