mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-29 19:45:01 +02:00
Code Issues Wiki Activity

[297140] Added comments to clarify method usage.

Browse source
This commit is contained in:
Pawel Piech 2009-12-10 20:48:53 +00:00
parent 0c68019dc1
commit dde65a6ae5
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
dsf/org.eclipse.cdt.dsf/src/org/eclipse/cdt/dsf/debug/service/IExpressions.java
View file

@ -166,6 +166,10 @@ public interface IExpressions extends IFormattedValues {
/** /**
* Retrieves the sub-expressions of the given expression. Sub-expressions are fields of a struct, union, * Retrieves the sub-expressions of the given expression. Sub-expressions are fields of a struct, union,
* or class, the enumerators of an enumeration, and the element of an array. * or class, the enumerators of an enumeration, and the element of an array.
* <br>
* Note: Clients may call this method on any valid expression context, and before calling any other
* method to evaluate the expression value. It is up to the implementation to internally evaluate the
* expression if needed, in order to calculate sub expressions.
* *
* @param exprCtx: The data model context representing an expression. * @param exprCtx: The data model context representing an expression.
* *
@ -177,6 +181,10 @@ public interface IExpressions extends IFormattedValues {
* Retrieves a particular range of sub-expressions of the given expression. * Retrieves a particular range of sub-expressions of the given expression.
* Sub-expressions are fields of a struct, union, or class, the enumerators * Sub-expressions are fields of a struct, union, or class, the enumerators
* of an enumeration, and the element of an array. * of an enumeration, and the element of an array.
* <br>
* Note: Clients may call this method on any valid expression context, and before calling any other
* method to evaluate the expression value. It is up to the implementation to internally evaluate the
* expression if needed, in order to calculate sub expressions.
* *
* @param exprCtx: The data model context representing an expression. * @param exprCtx: The data model context representing an expression.
* startIndex: Index of the first sub-expression to retrieve * startIndex: Index of the first sub-expression to retrieve
@ -191,6 +199,10 @@ public interface IExpressions extends IFormattedValues {
/** /**
* Retrieves the number of sub-expressions of the given expression. Sub-expressions are fields of a struct, union, * Retrieves the number of sub-expressions of the given expression. Sub-expressions are fields of a struct, union,
* or class, the enumerators of an enumeration, and the element of an array. * or class, the enumerators of an enumeration, and the element of an array.
* <br>
* Note: Clients may call this method on any valid expression context, and before calling any other
* method to evaluate the expression value. It is up to the implementation to internally evaluate the
* expression if needed, in order to calculate sub expressions.
* *
* @param exprCtx: The data model context representing an expression. * @param exprCtx: The data model context representing an expression.
* *
@ -202,6 +214,10 @@ public interface IExpressions extends IFormattedValues {
/** /**
* For object oriented languages, this method returns the expressions representing base types of * For object oriented languages, this method returns the expressions representing base types of
* the given expression type. * the given expression type.
* <br>
* Note: Clients may call this method on any valid expression context, and before calling any other
* method to evaluate the expression value. It is up to the implementation to internally evaluate the
* expression if needed, in order to calculate sub expressions.
* *
* @param exprContext: The data model context representing an expression. * @param exprContext: The data model context representing an expression.
* *