New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WritingChecks: add documentation on java grammar #3883

Closed
rnveach opened this Issue Feb 28, 2017 · 2 comments

Comments

Projects
None yet
3 participants
@rnveach
Member

rnveach commented Feb 28, 2017

'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 wanted to use something like the javadoc one to point new people to see to get familar with our Java tree, but a full example doesn't seem to exist unless I missed it.

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.

@romani romani added the approved label Feb 28, 2017

@sagar-shah94

This comment has been minimized.

Show comment
Hide comment
@sagar-shah94

sagar-shah94 Mar 1, 2017

Contributor

I am on it.

Contributor

sagar-shah94 commented Mar 1, 2017

I am on it.

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 1, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 1, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 1, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 1, 2017

Issue #3883: Added a new section Tool to print Java treestructure to …
…Writing Checks

Issue #3883: Made minor changes in spelling

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 1, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 1, 2017

Issue #3883: Added a new section Tool to print Java treestructure to …
…Writing Checks

Issue #3883: Made minor changes in spelling

Issue #3883: Made change in content

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 1, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 1, 2017

Issue #3883: Added a new section Tool to print Java treestructure to …
…Writing Checks

Issue #3883: Made minor changes in spelling

Issue #3883: Made change in content

Issue #3883: verified test cases

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 1, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 3, 2017

rnveach added a commit that referenced this issue Mar 3, 2017

@rnveach

This comment has been minimized.

Show comment
Hide comment
@rnveach

rnveach Mar 3, 2017

Member

Fix is merged

Member

rnveach commented Mar 3, 2017

Fix is merged

@rnveach rnveach closed this Mar 3, 2017

@rnveach rnveach added this to the 7.7 milestone Mar 3, 2017

sagar-shah94 pushed a commit to sagar-shah94/checkstyle that referenced this issue Mar 13, 2017

Issue #3883: Added a new section Tool to print Java treestructure to …
…Writing Checks

Issue #3902: Fixed formatting issue in documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment