swiftlang / swiftlang/swift-java
Include Swift documentation in generated Java sources
Open
Nobody has claimed this yet.
feature:jextract
- Dominant language
- Swift
- Stars
- 1.2k
- Forks
- 123
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 16
Description
This is pretty simple since we generate from sources already, so we should also carry along docs.
This makes APIs easier to consume if they have docs, Java callers can read them directly in an Java IDE then
Contributor guide
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
No files or tests are named. Start by tracing the source-generation entry point that produces Java sources from Swift sources, then determine where source documentation is omitted. Done means generated Java APIs retain the relevant Swift documentation so Java callers can read it in an IDE.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, swift
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100