Javadoc isn't delomboked
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 35/100
- Issue-Typ
- Bug
- Klarheit
- Klar beschrieben
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- java
- Bereich
- build-system, documentation
Rechercherichtung
Überprüfe die Java-Quellen unter src/main/java und die Build-Konfiguration in pom.xml und vergleiche anschließend die aktuelle Maven-Javadoc-Ausgabe mit den dokumentierten builder()-Methoden. Untersuche das vorgeschlagene delombok-Setup von lombok-maven-plugin und verifiziere, dass mvn javadoc:javadoc eine Dokumentation erzeugt, die die generierten Methoden enthält.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
The documentation generated by mvn javadoc:javadoc is missing the methods auto-generated by Lombok. So, the documentation is missing methods like builder() that are used in our examples.
There's a Maven plugin that helps. I've tried it and it seems to work. The steps are:
- Moving the source code from
src/main/javatosrc/main/lombok - Adding the following stanza to
pom.xml:
<plugin>
<groupId>org.projectlombok</groupId>
<artifactId>lombok-maven-plugin</artifactId>
<version>1.18.10.0</version>
<executions>
<execution>
<phase>generate-sources</phase>
<goals>
<goal>delombok</goal>
</goals>
</execution>
</executions>
</plugin>
After that, the javadoc goal produces the full documentation.
- Vorherrschende Sprache
- Java
- Sterne
- 30
- Forks
- 48
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus aws-cloudformation/cloudformation-cli-java-plugin
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 25/100
aws-cloudformation/cloudformation-cli-java-plugin#415 · 1 Kommentar ·
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 42/100
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 20/100
-
injectCredentialsAndInvokeV2 method in proxy class doesn't support API's like PutObject from S3.Offen
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
Alle Issues in aws-cloudformation/cloudformation-cli-java-plugin
Ähnliche Issues
-
[Bug] The shared instance selector's placeholder and no-match text ignore the display languageEvtl. vergeben Ein verknüpfter Pull Request ist offen oder bereits gemergt. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 90/100
apache/rocketmq-dashboard#5561 ·
Maintainer antworten meist innerhalb von 3 Tagen
-
test(setup): GitHub configuration tests fail when the temp path is long enough for YAML foldingOffenbug good first issue help wanted priority medium size S
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 84/100
martin-francois/symphony-trello#776 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
Console.printHexOffengood first issue kernel
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
JackFurton/who-would-build-a-kernel-in-java#33 · 2 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
flutter/flutter-intellij#9137 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
Maintainer antworten meist innerhalb von 1 Tag