diff options
author | Sven Gothel <[email protected]> | 2023-07-06 11:42:06 +0200 |
---|---|---|
committer | Sven Gothel <[email protected]> | 2023-07-06 11:42:06 +0200 |
commit | 4267e223e33acdc098cc5b4371765f8e31b96eff (patch) | |
tree | 927ec6a9324b538efbeccc515a6aa9d983ef9ccc | |
parent | 3ed3e9887c459169b807165c9df2ae2bc2990a31 (diff) |
GlueGen JavaCallback Doc: Remove reasoning (avoiding ambiguity) to CallbackFunction parameter index
-rw-r--r-- | doc/GlueGen_Mapping.html | 10 | ||||
-rw-r--r-- | doc/GlueGen_Mapping.md | 4 |
2 files changed, 4 insertions, 10 deletions
diff --git a/doc/GlueGen_Mapping.html b/doc/GlueGen_Mapping.html index d484ff8..775835e 100644 --- a/doc/GlueGen_Mapping.html +++ b/doc/GlueGen_Mapping.html @@ -2046,9 +2046,7 @@ typedef-name of the function-pointer-type, aka the callback type name</li> <li><code>CallbackFunction-UserParamIndex</code>: The <code>userParam</code> parameter-index of the -<code>CallbackFunctionType</code>, allowing to accommodate a potential -parameter-type collision between <code>SetCallbackFunction</code> and -<code>CallbackFunction</code>. It also allows to <a +<code>CallbackFunctionType</code>, which allows to <a href="#struct-type-user-param-heterogeneous">indicate a heterogeneous <code>UserParam</code></a></li> <li><code>SetCallback-KeyClassName</code>: Optional name of a @@ -2088,11 +2086,7 @@ typedef-name of the function-pointer-type, the same callback type name as defined in <code>JavaCallbackDef</code></li> <li><code>CallbackFunction-ParamIndex</code>: List of parameter indices of the <code>CallbackFunctionType</code>, matching the semantic -parameter of <code>SetCallback-ParamIndex</code> to accommodate -potential different parameter order or argument names between -<code>SetCallbackFunction</code> and <code>CallbackFunction</code>. The -indexed parameters must be semantical equivalent as specified by the -<code>SetCallback-ParamIndex</code> list.</li> +parameter of <code>SetCallback-ParamIndex</code>.</li> </ul> <h4 id="custom-setcallback-keyclass">Custom <code>SetCallback-KeyClass</code></h4> diff --git a/doc/GlueGen_Mapping.md b/doc/GlueGen_Mapping.md index 2f8e9e1..ae43f33 100644 --- a/doc/GlueGen_Mapping.md +++ b/doc/GlueGen_Mapping.md @@ -826,7 +826,7 @@ as it is core to the semantic mapping of all resources. They also have to use th - `SetCallbackFunction`: `SetCallbackFunction` name of the native toolkit API responsible to set the callback - `SetCallback-UserParamIndex`: `UserParam` parameter-index of the `SetCallbackFunction` - `CallbackFunctionType`: The native toolkit API typedef-name of the function-pointer-type, aka the callback type name -- `CallbackFunction-UserParamIndex`: The `userParam` parameter-index of the `CallbackFunctionType`, allowing to accommodate a potential parameter-type collision between `SetCallbackFunction` and `CallbackFunction`. It also allows to [indicate a heterogeneous `UserParam`](#struct-type-user-param-heterogeneous) +- `CallbackFunction-UserParamIndex`: The `userParam` parameter-index of the `CallbackFunctionType`, which allows to [indicate a heterogeneous `UserParam`](#struct-type-user-param-heterogeneous) - `SetCallback-KeyClassName`: Optional name of a user-implemented `SetCallback-KeyClass`, providing the hash-map-key - see below The `SetCallbackFunction` is utilized to set the `CallbackFunction` as well as to remove it passing `null` for the `CallbackFunction`. @@ -849,7 +849,7 @@ To remove a previously set `CallbackFunction` via `SetCallbackFunction`, the key - `SetCallbackFunction`: `SetCallbackFunction` name of the native toolkit API responsible to set the callback - `SetCallback-ParamIndex`: List of parameter indices of the `SetCallbackFunction`, denoting the key(s) limiting the callback scope, i.e. the callback and all resources will be mapped to this key. The optional `SetCallback-KeyClass` may override this semantic. - `CallbackFunctionType`: The native toolkit API typedef-name of the function-pointer-type, the same callback type name as defined in `JavaCallbackDef` -- `CallbackFunction-ParamIndex`: List of parameter indices of the `CallbackFunctionType`, matching the semantic parameter of `SetCallback-ParamIndex` to accommodate potential different parameter order or argument names between `SetCallbackFunction` and `CallbackFunction`. The indexed parameters must be semantical equivalent as specified by the `SetCallback-ParamIndex` list. +- `CallbackFunction-ParamIndex`: List of parameter indices of the `CallbackFunctionType`, matching the semantic parameter of `SetCallback-ParamIndex`. #### Custom `SetCallback-KeyClass` |