swiftlang / swiftlang/swift-java
Switch wrap java to JEP467 markdown docs style
Open
Nobody has claimed this yet.
- Dominant language
- Swift
- Stars
- 1.2k
- Forks
- 123
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 16
Description
https://x.com/gunnarmorling/status/2034745665373577540?s=46&t=tga-DO0J45jFwHmVttv_eg
Seems it'll be much easier to write without the weirdness of javadoc ?
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 reading JEP 467 and the linked discussion to understand the proposed Markdown documentation style. Then locate where swift-java produces or wraps Java documentation; the work is done when that output follows the selected JEP 467 style and existing documentation checks still pass.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100