[MPLUGIN-536] Allow generation of documentation for nested POJOs used as @Parameters
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- java
- Área
- documentation
Línea de trabajo
Empieza rastreando la documentación del sitio generada y el manejo en mojo de los campos marcados con @Parameter; después, inspecciona cómo se representan actualmente los POJO anidados. Aclara si sources, dependency sources, JavaDoc JARs o una anotación @Documentation personalizada constituyen el diseño previsto; done debe incluir atributos anidados documentados en lugar de solo un nombre de clase completamente cualificado.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Ashley Scopes opened MPLUGIN-536 and commented
As a plugin developer of a plugin with a few dozen complex options, I'd like to see a new feature where by the generated site documentation and help mojo document the fields of nested pojos that are present with javadoc comments.
@Parameter
private Thing thing;
public class Thing {
public Foo getFoo() { ... }
public void setFoo(Foo foo) { ... }
}
Currently the plugins just report the fully qualified class name as a dead link, which means nested attributes have to be documented manually and the consistency of this varies wildly between projects.
I'd either like to see the ability for the documentation to be generated from project sources, dependency sources, or JavaDoc JARs, or the ability to provide a custom @Documentation annotation to document attributes in nested objects.
This could be specified within a "schemas" section at the bottom of the goal HTML page.
No further details from MPLUGIN-536
- Lenguaje dominante
- Java
- Estrellas
- 63
- Forks
- 78
- Merge medio
- 1 d 4 h
- PR fusionados (30 d)
- 23
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Sin 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 apache/maven-plugin-tools
-
`@Execute` with a custom phase or `"none"` fails descriptor extractionPosiblemente ocupada @CaptainAni187 la tomó hace 27 días. Abiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 86/100
apache/maven-plugin-tools#1232 ·
Los mantenedores suelen responder en 1 día
-
enhancement
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
apache/maven-plugin-tools#1240 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
apache/maven-plugin-tools#1233 · 5 comentarios ·
Los mantenedores suelen responder en 1 día
-
`descriptor` fails on `onlineRequired`, `dependencyCollection` and `dependencyResolutionPathScopes` in the Maven 4 API `@Mojo`Posiblemente ocupada @efegokdemir la tomó hace 25 días. Abiertobug
Dificultad 3/5 1-2 días Aptitud para principiantes 65/100
apache/maven-plugin-tools#1231 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
`@Resolution` fields stay null: `plugin.xml` gets no `<resolutions>`Posiblemente ocupada @goutamadwant la tomó hace 30 días. Abiertobug
Dificultad 3/5 1-2 días Aptitud para principiantes 72/100
apache/maven-plugin-tools#1230 · 1 comentario ·
Los mantenedores suelen responder en 1 día
Todos los issues de apache/maven-plugin-tools
Issues similares
-
BindingServiceProperties.bindings regressed to a non-thread-safe TreeMap in GH-3158: concurrent first use of binding names corrupts itPosiblemente ocupada @AkashB23 la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
spring-cloud/spring-cloud-stream#3321 ·
Los mantenedores suelen responder en 1 día
-
[Bug] 资源包列表 与 模组/数据包/世界 列表排列顺序不一致Posiblemente ocupada @fishdry1000 la tomó hace 4 días. Abiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
Los mantenedores suelen responder en 1 día
-
ai-driven-fuzzing bug claude Minor
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
linagora/twake-calendar-side-service#1333 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
AtlasOfLivingAustralia/species-lists#882 ·
Los mantenedores suelen responder en 1 día
-
Type/Bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
ballerina-platform/ballerina-library#9458 ·
Los mantenedores suelen responder en 1 día