Javadoc isn't delomboked

Abierto
#234 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
35/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
java

Línea de trabajo

Revisa las fuentes Java bajo src/main/java y la configuración de compilación en pom.xml; después, compara la salida actual de Maven Javadoc con los métodos builder() documentados. Investiga la configuración propuesta de delombok de lombok-maven-plugin y verifica que mvn javadoc:javadoc genere documentación que contenga los métodos generados.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Java
Estrellas
30
Forks
48
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de aws-cloudformation/cloudformation-cli-java-plugin

Todos los issues de aws-cloudformation/cloudformation-cli-java-plugin

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.