java-native-access / java-native-access/jna
documentation ambiguous about callbacks returning String
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 8.9k
- Forks
- 1.7k
- PR merge metrics
- No merged PRs in 30d
Description
If calling a java callback that returns String, the return type is translated to char* on the native side. The documentation is unclear, though, about the lifetime of the string. Is the memory owned by java or should it be freed by C?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the JNA documentation describing callbacks that return String and read the surrounding callback and native-string ownership guidance. Confirm the actual lifetime and freeing responsibility, then update the documentation so the Java-versus-C ownership rule is explicit and unambiguous.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100