quarkusio/quarkus

Document and expose documentation of BuildItems in an automated fashion

Open

#6983 aperta il 4 feb 2020

Vedi su GitHub
 (8 commenti) (0 reazioni) (0 assegnatari)Java (2464 fork)batch import
good first issuekind/enhancement

Metriche repository

Star
 (12.967 star)
Metriche merge PR
 (Merge medio 6g 4h) (325 PR mergiate in 30 g)

Descrizione

A big value of extensions is the BuildItem model. We need to document them so other extension writers can discover and use them. They are also part of the extension contract.

  1. document all "public" BuildItem with adequate JavaDoc
  2. build an anotation processor that will collect the BuildItems and generate a list of them per extension and a documentation (summary?).

Guida contributor

Direzione di ricerca
Studia le classi BuildItem esistenti e la loro JavaDoc, quindi progetta un processore di annotazioni per raccogliere e generare un elenco di BuildItem per estensione. Considera l'utilizzo del pacchetto javax.annotation.processing o simili.
Tech stack
java
Dominio
backenddocumentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
JavaMaven or GradleAnnotation processing
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65