swagger-api / swagger-api/swagger-codegen
[Java] Add maven-javadoc-plugin in pom.xml of generated Java client
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
This plugin would allow the generation of Javadoc from the generated Java client using mvn javadoc:javadoc, making it easier to document the Java client API.
@cliffano has updated it for jersey1 Java API client via https://github.com/swagger-api/swagger-codegen/pull/3482
If anyone has time to update pom.xml for other Java API clients (listed below), please reply to let us know.
https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/main/resources/Java/libraries/feign/pom.mustache
https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/main/resources/Java/libraries/jersey2/pom.mustache
https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/main/resources/Java/libraries/retrofit/pom.mustache
https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/main/resources/Java/libraries/retrofit2/pom.mustache
https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/main/resources/Java/libraries/okhttp-gson/pom.mustache
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
Review the listed pom.mustache templates for feign, jersey2, retrofit, retrofit2, and okhttp-gson, using the jersey1 change in PR 3482 as the reference. Run mvn javadoc:javadoc on a generated Java client for each library and confirm that Javadoc generation works for all updated clients.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- build-system
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100