From f4fd72174140d7e0246987d83520e5fec357354c Mon Sep 17 00:00:00 2001
From: Dionna Amalie Glaze <drdeeglaze@gmail.com>
Date: Tue, 4 Oct 2016 13:02:31 -0500
Subject: [PATCH] Z3_query_constructor documentation clarification
Hit a segfault when I assumed the API would allocate these _out parameters for me.
---
src/api/z3_api.h | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/api/z3_api.h b/src/api/z3_api.h
index 666485a7f..cd889b3be 100644
--- a/src/api/z3_api.h
+++ b/src/api/z3_api.h
@@ -1997,9 +1997,9 @@ extern "C" {
\param c logical context.
\param constr constructor container. The container must have been passed in to a #Z3_mk_datatype call.
\param num_fields number of accessor fields in the constructor.
- \param constructor constructor function declaration.
- \param tester constructor test function declaration.
- \param accessors array of accessor function declarations.
+ \param constructor constructor function declaration, allocated by user.
+ \param tester constructor test function declaration, allocated by user.
+ \param accessors array of accessor function declarations allocated by user. The array must contain num_fields elements.
def_API('Z3_query_constructor', VOID, (_in(CONTEXT), _in(CONSTRUCTOR), _in(UINT), _out(FUNC_DECL), _out(FUNC_DECL), _out_array(2, FUNC_DECL)))
*/