How gilgoldzweig/gencycler works
Main Components
a) Core Components:
• Annotations Module
• Compiler Module
• Gencycler Runtime Module
• Sample Module (for demonstration)
b) Processing Flow Components:
• Annotation Processor
• Code Generators
• XML Parser
• File Helpers
┌─ Development Time ─────────────────────────────────────────────┐
• ┌─ Annotations ─┐ ┌─ Compiler ────────────────────────┐ │
• @GencyclerAdapter│ │ ┌─ Processor ─┐ ┌─ Generators ─┐ │ │
• @ViewHolder │ │ │ │ │ │ │ │
• @Clickable │ ─> │ │ Annotation │ │ ViewHolder │ │ │
• @Filterable │ │ │ Processor │─>│ Adapter │ │ │
• ┘ │ │ │ │ │ │ │
• ┘ └──────────────┘ │ │
• ▲ ▼ │ │
• ┌──────┴─────┐ ┌──────────────┐ │ │
• XML │ │ Models │ │ │
• Parser │ │ │ │ │
• ┘ └──────────────┘ │ │
• ┘ │
• ┘
┌─ Runtime ──────────────────────────────────────────────────┐
• ┌─ Generated Code ─┐ ┌─ Gencycler Library ────────┐ │
• Adapter Classes │<───│ Base Classes │ │
• ViewHolders │ │ Helper Utilities │ │
• Event Handlers │ │
• ┘ └────────────────────────────┘ │
• ┘
Key Elements to Highlight
• The annotation processing pipeline
• The code generation process
• The runtime component integration
• The separation between compile-time and runtime components
Additional Notes
• Notes about the compile-time vs runtime distinction
• Version/compatibility information
Implementation Details
• Use standard UML notation where appropriate
• Keep the abstraction level high enough to understand the system flow
• Important interfaces and abstract classes
• Relationship with Android's RecyclerView system
Remember to include the key features mentioned in the README (click listeners, multi-view types, filtering, etc.) as part of the runtime library components, showing how they integrate with the generated code.