event-doc-generator

Generate event documentation for a Spring Boot project by scanning source code to identify events, publishers, and listeners. The tool outputs per-event Markdown files, a catalog, and Mermaid diagrams to visualize flows under docs/event.

Yes, automatically create Mermaid diagrams for event-driven architectures by scanning your codebase. The generator detects event flows and produces visual diagrams alongside Markdown documentation to map out publishers and listeners.

Document events and listeners in a DDD-structured system by scanning Java sources to extract event types and their context mappings. The tool generates detailed Markdown files with field details and usage notes for each event.

The event documentation generator requires no specific dependencies to run. It operates deterministically by scanning your source code and uses validation hooks to ensure accurate extraction of events and listeners.

The best way to maintain an event catalog for Spring Boot applications is automating generation via source code scanning. This approach produces an index of events and ensures documentation stays synchronized with the actual codebase.

Event flows might not show up in generated documentation if the scanner cannot identify valid publishers or listeners in your Java sources. Ensure your code follows standard Spring Boot and DDD patterns for proper detection.