summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndres Noetzli <andres.noetzli@gmail.com>2020-08-03 16:26:42 -0700
committerGitHub <noreply@github.com>2020-08-03 16:26:42 -0700
commitc84db77ecdaa7107a33824484bf9c649f8fcbbff (patch)
tree5f038373ee25ceb8ef8c0e13091035e6721eb4ef
parent3dad390f4216a9d279197a52b40b8e93696d4019 (diff)
Update documentation for Solver::mkVar() (#4833)
The documentation of `Solver::mkVar()` was not very clear regarding what it could be used for. This lead to some confusion (see e.g. #4828). This commit makes the documentation more explicit.
-rw-r--r--src/api/cvc4cpp.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/api/cvc4cpp.h b/src/api/cvc4cpp.h
index edd74280a..bba654200 100644
--- a/src/api/cvc4cpp.h
+++ b/src/api/cvc4cpp.h
@@ -2788,7 +2788,8 @@ class CVC4_PUBLIC Solver
Term mkConst(Sort sort, const std::string& symbol = std::string()) const;
/**
- * Create (bound) variable.
+ * Create a bound variable to be used in a binder (i.e. a quantifier, a
+ * lambda, or a witness binder).
* @param sort the sort of the variable
* @param symbol the name of the variable
* @return the variable
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback