airbnb/epoxy

[Feature request] Model documentation generator.

Open

#522 创建于 2018年9月4日

在 GitHub 查看
 (3 评论) (0 反应) (0 负责人)Java (8,412 star) (738 fork)batch import
help wanted

描述

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!

贡献者指南

技术栈
java
领域
documentationmobile
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
over 1 week
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
JavaAndroid developmentAnnotation processing
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
25
研究方向
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.