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.