[MPLUGIN-536] Allow generation of documentation for nested POJOs used as @Parameters

Aperta
  • Qualcosa non va?
#846 0 commenti 1 reazione 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
java
Ambito
documentation

Direzione di ricerca

Inizia tracciando la documentazione del sito generata e la gestione in mojo dei campi contrassegnati con @Parameter, quindi esamina come sono attualmente rappresentati i POJO annidati. Chiarisci se sources, dependency sources, JavaDoc JARs o un'annotazione @Documentation personalizzata costituiscano il design previsto; done deve includere attributi annidati documentati invece del solo nome completo della classe.

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

Descrizione

enhancement

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

Lingua principale
Java
Stelle
63
Fork
78
Merge medio
1g 4h
PR unite (30g)
23

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna 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 apache/maven-plugin-tools

Tutte le issue di apache/maven-plugin-tools

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.