aboutsummaryrefslogtreecommitdiffstats
path: root/doc/manual/index.md
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2023-12-02 18:32:34 +0100
committerSven Gothel <[email protected]>2023-12-02 18:32:34 +0100
commit0666c8f9a353b42ffde4902dc0cdec66f925a6e3 (patch)
tree8988d7e90f84c86d687b38205754e1ecf4efb839 /doc/manual/index.md
parent0f731bfabcdd19665c3c09c5f40f898101c501c9 (diff)
Bug 1481 - Hide [ArgumentIs]PascalString argument's length
Native pascal strings shall be just treated as normal Java strings on the Java side. Hence drop the length parameter across generated API, i.e. - C Function bindings - Java Callbacks
Diffstat (limited to 'doc/manual/index.md')
-rw-r--r--doc/manual/index.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/manual/index.md b/doc/manual/index.md
index 0ad4172..48a632d 100644
--- a/doc/manual/index.md
+++ b/doc/manual/index.md
@@ -648,7 +648,7 @@ this case is most useful in conjunction with
**<span id="ArgumentIsString">ArgumentIsString</span>**
Syntax:
-`ArgumentIsString [function name] [indices...]`
+`ArgumentIsString [function name] [indices...]`
where the first argument index is 0
(optional) For a C function with one or more outgoing `char*` (or
compatible data type) arguments, indicates that those arguments are
@@ -658,7 +658,7 @@ as java.lang.String objects rather than `byte[]` or `ByteBuffer`.
**<span id="ArgumentIsPascalString">ArgumentIsPascalString</span>**
Syntax:
-`ArgumentIsPascalString [function name] [indice-tuples...]`,
+`ArgumentIsPascalString [function name] [indice-tuples...]`,
with each tuple being the argument-index for the '`int length`' and the
'`char* value`' argument with index 0 for the the first argument
(optional) For a C function with one or more outgoing '`int length`' and
@@ -666,7 +666,8 @@ with each tuple being the argument-index for the '`int length`' and the
those arguments are semantically non-null-terminated Pascal strings
rather than null-terminated C strings or arbitrary arrays of bytes. The
generated glue code will be modified to emit those arguments as
-java.lang.String objects rather than `byte[]` or `ByteBuffer`.
+java.lang.String objects rather than `byte[]` or `ByteBuffer`
+as well as dropping the redundant '`int length`' argument on the Java side.
**<span id="ClassJavadoc">ClassJavadoc</span>**
Syntax: `ClassJavadoc [class name] [code...]`