Coverage of Documentation Comments Style Guide and performance optimization of Javadoc parser
- Mentors
- Vladislav Lisetskii, Illia Dubinin
- Organization
- Checkstyle
First, all the existing ANTLR issues are to be cleared out. Bottlenecks in javadoc grammar must be identified so that javadoc parsing could be sped up enabling users to employ checkstyle as frequently as they want to for code review or in their build cycle and peacefully utilize javadoc checks. Currently, employing any javadoc check despairingly increases the overall validation time. Then, documentation (javadoc) guidelines shall be reviewed in detail and the missing functionalities and checks would be realized. The existing checks may need to be fixed and updated accordingly. All the new checks shall be implemented. Finally, the Javadoc Style checkstyle coverage page will be created and will list down all of the checkstyle's javadoc checks.