[Checkstyle] Javadoc parameter alignment check does not work with link tags
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 78/100
Línea de trabajo
En el módulo checkstyle, inspecciona la comprobación JavadocParamAlignment y sus datos de prueba; el issue proporciona un ejemplo de Javadoc que reproduce el problema y los diagnósticos de columna que fallan. Ejecuta las pruebas pertinentes de JavadocParamAlignment, añade el caso e investiga por qué el texto de las etiquetas de enlace afecta a la alineación. El trabajo estará terminado cuando el nuevo caso pase junto con method_multiline_correct.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
The custom checkstyle task that enforces param alignment doesn't seem to work with link (and probably other types of) tags.
To reproduce, add the following test case to JavadocParamAlignment in the checkstyle module's test data:
/**
* A method that does something
*
* @param a this is a description
* with a {@link #method(String, String)} link tag
* @param superLongParamName a description
* blabla
*/
public void method_multiline_correct_with_link(String a, String superLongParamName) {
}
and run the tests. I'd expect it to pass just like method_multiline_correct passes, but it currently does not.
Test output:
Violations do not match for src\testData\java\testdata\JavadocParamAlignment.java
Violations not accounted for in test:
51:34: Param description for a should start at column 73
52:34: Param description for a should start at column 73
53:34: Param description for superLongParamName should start at column 73
54:34: Param description for superLongParamName should start at column 73
- Lenguaje dominante
- Java
- Estrellas
- 12.8k
- Forks
- 3.6k
- Merge medio
- 4 d 7 h
- PR fusionados (30 d)
- 47
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de PaperMC/Paper
-
status: needs triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
PaperMC/Paper#14375 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
Add .getIgniter() to ExplosiveMinecartPosiblemente ocupada @WouterGritter la tomó hace 38 días. Abiertostatus: needs triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
PaperMC/Paper#14097 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
BlockType#isOccluding is incorrectly handledPosiblemente ocupada @ryoji-ikeda la tomó hace 182 días. Abiertostatus: accepted
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
PaperMC/Paper#13790 · 5 comentarios ·
Los mantenedores suelen responder en 1 día
-
status: needs triage version: 26.3
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
Los mantenedores suelen responder en 1 día
-
status: accepted version: 26.3
Dificultad 3/5 1-2 días Aptitud para principiantes 55/100
Los mantenedores suelen responder en 1 día
Todos los issues de PaperMC/Paper
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 75/100
521xueweihan/HelloGitHub#4105 ·
-
Awaiting further input from submitter
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
Los mantenedores suelen responder en 1 día
-
code-maintenance
Dificultad 2/5 1-3 horas Aptitud para principiantes 80/100
Los mantenedores suelen responder en 1 día