swiftlang / swiftlang/swift-java
wrap-java: Include Java documentation in generated Swift code
Open
Nobody has claimed this yet.
feature:wrap-java
- Dominant language
- Swift
- Stars
- 1.2k
- Forks
- 123
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 16
Description
This is tricky because we'll need to use a javadoc doclet to extract docs, as our generation is driven from just bytecode, absent of documentation.
We'd be able to offer a better experience to Swift calling Java if we carried docs such that the Swift IDEs can see them
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
Start by investigating the wrap-java generation path and how it currently consumes bytecode without documentation. Explore how a javadoc doclet could provide documentation for generated Swift, and consider the work complete when Java documentation is available to Swift callers through their IDEs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, swift
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100