swagger-api/swagger-codegen

[Java] Add maven-javadoc-plugin in pom.xml of generated Java client

Open

#3.499 geöffnet am 2. Aug. 2016

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)HTML (5.474 Forks)batch import
Client: JavaEnhancement: Featurehelp wanted

Repository-Metriken

Stars
 (12.701 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Research-Richtung
Untersuche die vorhandenen pom.mustache Dateien für die aufgeführten Bibliotheken (feign, jersey2, retrofit, retrofit2, okhttp gson) und füge die maven javadoc plugin Konfiguration ähnlich dem jersey1 Beispiel aus PR #3482 hinzu.
Tech Stack
java
Domain
backend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JavaMavenSwagger Codegen
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50