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

Improved Javadocs.

This commit is contained in:
Sergey Prigogin 2013-02-08 14:02:28 -08:00
parent 77db4a8dcd
commit ec0ec79c55

View file

@ -39,23 +39,25 @@ public interface ICPPEvaluation extends ISerializableEvaluation {
boolean isValueDependent(); boolean isValueDependent();
/** /**
* TODO Add description * Returns the type of the expression, or a {@code FunctionSetType} if the expression evaluates
* to a function set.
* *
* @param point determines the scope for name lookups * @param point the point of instantiation, determines the scope for name lookups
*/ */
IType getTypeOrFunctionSet(IASTNode point); IType getTypeOrFunctionSet(IASTNode point);
/** /**
* TODO Add description * Returns the value of the expression.
* *
* @param point determines the scope for name lookups * @param point the point of instantiation, determines the scope for name lookups
*/ */
IValue getValue(IASTNode point); IValue getValue(IASTNode point);
/** /**
* TODO Add description * Returns the category of the expression value.
* @see ValueCategory
* *
* @param point determines the scope for name lookups * @param point the point of instantiation, determines the scope for name lookups
*/ */
ValueCategory getValueCategory(IASTNode point); ValueCategory getValueCategory(IASTNode point);
@ -78,7 +80,7 @@ public interface ICPPEvaluation extends ISerializableEvaluation {
* *
* @param parameterMap maps function parameters to their values * @param parameterMap maps function parameters to their values
* @param maxdepth allowed recursion depth * @param maxdepth allowed recursion depth
* @param point determines the scope for name lookups * @param point the point of instantiation, determines the scope for name lookups
* @return the computed evaluation * @return the computed evaluation
*/ */
ICPPEvaluation computeForFunctionCall(CPPFunctionParameterMap parameterMap, int maxdepth, ICPPEvaluation computeForFunctionCall(CPPFunctionParameterMap parameterMap, int maxdepth,
@ -93,9 +95,7 @@ public interface ICPPEvaluation extends ISerializableEvaluation {
* CPPTemplates.PACK_SIZE_FAIL, and CPPTemplates.PACK_SIZE_NOT_FOUND. See their * CPPTemplates.PACK_SIZE_FAIL, and CPPTemplates.PACK_SIZE_NOT_FOUND. See their
* declarations for their meanings. * declarations for their meanings.
* *
* See also CPPTemplates.determinePackSize(). * See also {@code CPPTemplates.determinePackSize()}.
*
* @noreference This method is not intended to be referenced by clients.
*/ */
int determinePackSize(ICPPTemplateParameterMap tpMap); int determinePackSize(ICPPTemplateParameterMap tpMap);