Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
WritingChecks: add documentation on java grammar #3883
'Writing Javadoc Checks' has a full example on using the CLI to print the javadoc tree. http://checkstyle.sourceforge.net/writingjavadocchecks.html#Tool_to_print_Javadoc_tree_structure
Java has a somewhat similar section with http://checkstyle.sourceforge.net/writingchecks.html#The_Checkstyle_SDK_Gui , but it doesn't contain a full example and doesn't mention the CLI.
I think we should add a new section 'Tool to print Java treestructure' to 'Writing Checks'. Show users how to use the CLI and give a full example of our Java tree just like Javadoc does.