airbnb/epoxy

[Feature request] Model documentation generator.

Open

#522 aberto em 4 de set. de 2018

Ver no GitHub
 (3 comments) (0 reactions) (0 assignees)Java (738 forks)batch import
help wanted

Métricas do repositório

Stars
 (8.412 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

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!

Guia do colaborador

Direção de pesquisa
Pesquise como analisar as anotações do modelo Epoxy em tempo de compilação ou execução para gerar documentação. Explore opções como processamento de anotações ou reflexão.
Pilha de tecnologia
java
Domain
mobile
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JavaAndroid
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
50