airbnb/epoxy

[Feature request] Model documentation generator.

Open

#522 aperta il 4 set 2018

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)Java (738 fork)batch import
help wanted

Metriche repository

Star
 (8412 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

Hi! First of all, thanks for creating and open sourcing Epoxy, it really simplifies and optimizes developing features.

After extending the usage of Epoxy in a large app, and building dozens of components, we're facing a situation where sometimes models are duplicated because of members of the team don't realize they already exist.

Our suggestion would be to take advantage of the annotations and generate a centralized documentation or model catalog.

A similar tool in the react world could be React docgen

Thanks so much again for this awesome project!

Guida contributor

Direzione di ricerca
Ricerca come analizzare le annotazioni del modello Epoxy in fase di compilazione o runtime per generare documentazione. Esplora opzioni come l'elaborazione delle annotazioni o la riflessione.
Tech stack
java
Dominio
mobile
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
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
JavaAndroid
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
50