Add documentation

ultimate-pa · Jan 10, 2025 · 7253c6b · 7253c6b
1 parent 607f592
commit 7253c6b
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/...mate/cdt/translation/implementation/base/expressiontranslation/ExpressionTranslation.java b/...mate/cdt/translation/implementation/base/expressiontranslation/ExpressionTranslation.java
@@ -362,7 +362,13 @@ public void addAssumeValueInRangeStatements(final ILocation loc, final Expressio
 		}
 	}
 
-	public abstract Optional<Expression> getTypeConstraint(ILocation loc, Expression expr, CType cType);
+	/**
+	 * Returns a constraint for the given {@code cType} that is required for the model of the translated expression
+	 * {@code expr}. If the modelling does not require such a type constraint, the function can return
+	 * {@code Optional.empty()}.
+	 */
+	public abstract Optional<Expression> getTypeConstraint(final ILocation loc, final Expression expr,
+			final CType cType);
 
 	public Expression constructNullPointer(final ILocation loc) {
 		return constructPointerForIntegerValues(loc, BigInteger.ZERO, BigInteger.ZERO);