Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Javadoc links #1040

Merged
merged 8 commits into from
Jan 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -175,10 +175,16 @@ public TransferResult<CFValue, CFStore> visitAssignment(
* {@code node} is known to be {@code typeOfNode}. If the node is a plus or a minus then the
* types of the left and right operands can be refined to include offsets. If the node is a
* multiplication, its operands can also be refined. See {@link
* #propagateToAdditionOperand(LessThanLengthOf, Node, Node, TransferInput, CFStore)}, {@link
* #propagateToSubtractionOperands(LessThanLengthOf, NumericalSubtractionNode, TransferInput,
* CFStore)}, and {@link #propagateToMultiplicationOperand(LessThanLengthOf, Node, Node,
* TransferInput, CFStore)} for details.
* #propagateToAdditionOperand(UBQualifier.LessThanLengthOf, Node, Node, TransferInput,
* CFStore)}, {@link #propagateToSubtractionOperands(UBQualifier.LessThanLengthOf,
* NumericalSubtractionNode, TransferInput, CFStore)}, and {@link
* #propagateToMultiplicationOperand(UBQualifier.LessThanLengthOf, Node, Node, TransferInput,
* CFStore)} for details.
*
* @param typeOfNode type of node
* @param node the node
* @param in the TransferInput before propagate to this operand
* @param store location to store the refined type
*/
private void propagateToOperands(
LessThanLengthOf typeOfNode,
Expand Down Expand Up @@ -234,10 +240,10 @@ private void propagateToMultiplicationOperand(
*
* <p>This means that the left node is less than or equal to the length of the array when the
* right node is subtracted from the left node. Note that unlike {@link
* #propagateToAdditionOperand(LessThanLengthOf, Node, Node, TransferInput, CFStore)} and {@link
* #propagateToMultiplicationOperand(LessThanLengthOf, Node, Node, TransferInput, CFStore)},
* this method takes the NumericalSubtractionNode instead of the two operand nodes. This
* implements case 4.
* #propagateToAdditionOperand(UBQualifier.LessThanLengthOf, Node, Node, TransferInput,
* CFStore)} and {@link #propagateToMultiplicationOperand(UBQualifier.LessThanLengthOf, Node,
* Node, TransferInput, CFStore)}, this method takes the NumericalSubtractionNode instead of the
* two operand nodes. This implements case 4.
*
* @param typeOfSubtraction type of node
* @param node subtraction node that has typeOfSubtraction
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public FlowRule getFlowRule() {
* Produce a string representation.
*
* @return a string representation
* @see org.checkerframework.dataflow.cfg.builder.CFGBuilder.PhaseOneResult#nodeToString
* @see org.checkerframework.dataflow.cfg.builder.PhaseOneResult#nodeToString
*/
@Override
public String toString() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3815,7 +3815,7 @@ protected void reportMethodInvocabilityError(
* constructor result type. This is equivalent to down-casting.
*
* <p>For type checking of the enclosing expression of inner type instantiations, see {@link
* #checkEnclosingExpr(NewClassTree, AnnotatedExecutableType)}
* #checkEnclosingExpr(NewClassTree, AnnotatedTypeMirror.AnnotatedExecutableType)}
*
* @param invocation the AnnotatedDeclaredType of the constructor invocation
* @param constructor the AnnotatedExecutableType of the constructor declaration
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1213,7 +1213,7 @@ private AnnotatedExecutableType(ExecutableType type, AnnotatedTypeFactory factor
/** The parameter types; an unmodifiable list. */
private @MonotonicNonNull List<AnnotatedTypeMirror> paramTypes = null;

/** Whether {@link paramTypes} has been computed. */
/** Whether {@link #paramTypes} has been computed. */
private boolean paramTypesComputed = false;

/**
Expand All @@ -1223,32 +1223,33 @@ private AnnotatedExecutableType(ExecutableType type, AnnotatedTypeFactory factor
private @Nullable AnnotatedDeclaredType receiverType;

/**
* The varargs type is the last element of {@link paramTypes} if the method or constructor
* accepts a variable number of arguments and the {@link paramTypes} has not been expanded
* The varargs type is the last element of {@link #paramTypes} if the method or constructor
* accepts a variable number of arguments and the {@link #paramTypes} has not been expanded
* yet. This type needs to be stored in the field to avoid being affected by calling {@link
* AnnotatedTypes#adaptParameters(AnnotatedTypeFactory, AnnotatedExecutableType, List)}.
* AnnotatedTypes#adaptParameters(AnnotatedTypeFactory,
* AnnotatedTypeMirror.AnnotatedExecutableType, List, com.sun.source.tree.NewClassTree)}.
*/
private @MonotonicNonNull AnnotatedArrayType varargType = null;

/** Whether {@link receiverType} has been computed. */
/** Whether {@link #receiverType} has been computed. */
private boolean receiverTypeComputed = false;

/** The return type. */
private AnnotatedTypeMirror returnType;

/** Whether {@link returnType} has been computed. */
/** Whether {@link #returnType} has been computed. */
private boolean returnTypeComputed = false;

/** The thrown types; an unmodifiable list. */
private List<AnnotatedTypeMirror> thrownTypes;

/** Whether {@link thrownTypes} has been computed. */
/** Whether {@link #thrownTypes} has been computed. */
private boolean thrownTypesComputed = false;

/** The type variables; an unmodifiable list. */
private List<AnnotatedTypeVariable> typeVarTypes;

/** Whether {@link typeVarTypes} has been computed. */
/** Whether {@link #typeVarTypes} has been computed. */
private boolean typeVarTypesComputed = false;

/**
Expand Down Expand Up @@ -1285,7 +1286,7 @@ public void addAnnotation(AnnotationMirror annotation) {
/**
* Sets the parameter types of this executable type, excluding the receiver.If paramTypes
* has been computed and this type is a varargs method, computes and store {@link
* varargType} before calling this method, @see {@link varargType}
* #varargType} before calling this method, @see {@link #varargType}
*
* @param params an unmodifiable list of parameter types to be captured by this method,
* excluding the receiver
Expand Down Expand Up @@ -1344,19 +1345,19 @@ public List<AnnotatedTypeMirror> getParameterTypes() {
}

/**
* Computes the vararg type of this executable type and stores it in {@link varargType}.
* Computes the vararg type of this executable type and stores it in {@link #varargType}.
*
* <p>This method computes {@link varargType} using the {@link paramTypes} of this
* executable type. To use the {@link paramTypes} from different executable type, use {@link
* #computeVarargType(AnnotatedExecutableType)}.
* <p>This method computes {@link #varargType} using the {@link #paramTypes} of this
* executable type. To use the {@link #paramTypes} from different executable type, use
* {@link #computeVarargType(AnnotatedTypeMirror.AnnotatedExecutableType)}.
*/
/*package-private*/ void computeVarargType() {
computeVarargType(paramTypes);
}

/**
* Computes the vararg type using the passed executable type and stores it in this {@link
* varargType}.
* #varargType}.
*
* @param annotatedExecutableType an AnnotatedExecutableType
*/
Expand All @@ -1367,7 +1368,7 @@ public List<AnnotatedTypeMirror> getParameterTypes() {

/**
* Helper function for {@link #computeVarargType()} and {@link
* #computeVarargType(AnnotatedExecutableType)}.
* #computeVarargType(AnnotatedTypeMirror.AnnotatedExecutableType)}.
*
* @param paramTypes the parameter types to determine the vararg type
*/
Expand Down
Loading