redhat-developer / redhat-developer/quarkus-ls
Get Javadoc from java sources or attached Javadoc.
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 50
- Forks
- 18
- Avg merge
- 22h 11m
- Merged PRs (30d)
- 3
Description
Today javadoc is extracted only from It extract Javadoc only from META-INF/quarkus-javadoc.properties
Javadoc should be extracted when it is available:
- from Java sources (when JAR is linked to source)
- from attached Javadoc
After extracting the Javadoc, the /** should be removed and HTML tag (ex : <code>, etc)
- should be removed if doc must be rendered as plaintext
- replace with markdown if doc mus b erenderer as markdown
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 tracing the existing extraction from META-INF/quarkus-javadoc.properties. Then inspect how linked Java sources and attached Javadoc can be read; the work is done when available documentation is extracted, /** markers are removed, and HTML is either stripped for plaintext or converted to Markdown.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100