Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Javadoc isn't delomboked

Aperta
#234 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
35/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
java
Ambito
build-system, documentation

Direzione di ricerca

Esamina i sorgenti Java sotto src/main/java e la configurazione della build in pom.xml, quindi confronta l'output attuale di Maven Javadoc con i metodi builder() documentati. Analizza la configurazione delombok proposta di lombok-maven-plugin e verifica che mvn javadoc:javadoc produca documentazione contenente i metodi generati.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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:

  1. Moving the source code from src/main/java to src/main/lombok
  2. 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.

Lingua principale
Java
Stelle
30
Fork
48
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di aws-cloudformation/cloudformation-cli-java-plugin

Tutte le issue di aws-cloudformation/cloudformation-cli-java-plugin

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.