airbnb/epoxy

[Feature request] Model documentation generator.

Open

Aperta il 4 set 2018

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

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

Tech stack
java
Dominio
documentationmobile
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
over 1 week
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
mostly clear
Prerequisiti
JavaAndroid developmentAnnotation processing
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
25
Direzione di ricerca
Explore Epoxy's existing annotation processing code for model generation (e.g., EpoxyModelProcessor). Consider generating a HTML or JSON documentation from the annotations. Look at the react docgen tool for inspiration. The discussion in the issue may provide additional context.