Contributor
Stoyan

Automated Documentation Generation


Mentors
Roman Ivanov, Nick Mancuso
Organization
checkstyle
Technologies
python, java, bash, Maven
Topics
automation, documentation, javadoc, Xdoc
The goal of this project is to automate the generation of documentation for checkstyle modules - checks and filters. To achieve that, multiple Doxia macros are implemented - for the examples, properties, parent module, and violation messages. These macros are then used in XDoc templates that generate the final website. Moreover, the class Javadoc of every module is to be removed in order to avoid having to keep the same documentation in sync in two places. All this achieves more accurate examples in the documentation website and less workload for developers who have to maintain the documentation.