create xdoc for FileContentsHolder #3664

Closed
romani opened this Issue Dec 16, 2016 · 6 comments

Comments

Projects
None yet
2 participants
@romani
Member

romani commented Dec 16, 2016

there is no information about FileContentsHolder and what is it for.

Some notes are at:
http://checkstyle.sourceforge.net/config_filters.html#SuppressionCommentFilter
http://checkstyle.sourceforge.net/config_filters.html#SuppressWithNearbyCommentFilter

but this module should have its own documentation, and should be referenced at http://checkstyle.sourceforge.net/checks.html as it is similar to SuppressWarningsHolder

@rnveach

This comment has been minimized.

Show comment
Hide comment
@rnveach

rnveach Dec 16, 2016

Member

@romani XDoc for FileContentsHolder is located in config_misc.
http://checkstyle.sourceforge.net/config_misc.html#FileContentsHolder

It doesn't appear on checks.html because it doesn't have Check in its name.

Member

rnveach commented Dec 16, 2016

@romani XDoc for FileContentsHolder is located in config_misc.
http://checkstyle.sourceforge.net/config_misc.html#FileContentsHolder

It doesn't appear on checks.html because it doesn't have Check in its name.

@romani

This comment has been minimized.

Show comment
Hide comment
@romani

romani Dec 16, 2016

Member

ok , we just need to add them to checks.html probably it make sense to make new group there just to avoid confusions

Member

romani commented Dec 16, 2016

ok , we just need to add them to checks.html probably it make sense to make new group there just to avoid confusions

@romani

This comment has been minimized.

Show comment
Hide comment
@romani

romani Dec 17, 2016

Member

Them = FileContentsHolder , SuppressWarningsHolder

Member

romani commented Dec 17, 2016

Them = FileContentsHolder , SuppressWarningsHolder

@rnveach rnveach self-assigned this Jan 5, 2017

@rnveach

This comment has been minimized.

Show comment
Hide comment
@rnveach

rnveach Jan 5, 2017

Member

SuppressWarningsHolder does appear on the page already. The test doesn't verify if something is there that shouldn't be.

Member

rnveach commented Jan 5, 2017

SuppressWarningsHolder does appear on the page already. The test doesn't verify if something is there that shouldn't be.

@romani

This comment has been minimized.

Show comment
Hide comment
@romani

romani Jan 5, 2017

Member

it will be confusing why in table of Checks we place Holders .... They are not Checks ... should we place them in separate table ? on the same page or different ? .... hmmm

Member

romani commented Jan 5, 2017

it will be confusing why in table of Checks we place Holders .... They are not Checks ... should we place them in separate table ? on the same page or different ? .... hmmm

rnveach added a commit to rnveach/checkstyle that referenced this issue Jan 5, 2017

rnveach added a commit to rnveach/checkstyle that referenced this issue Jan 5, 2017

rnveach added a commit to rnveach/checkstyle that referenced this issue Jan 5, 2017

rnveach added a commit to rnveach/checkstyle that referenced this issue Jan 5, 2017

romani added a commit that referenced this issue Jan 5, 2017

@romani romani added this to the 7.5 milestone Jan 5, 2017

@romani

This comment has been minimized.

Show comment
Hide comment
@romani

romani Jan 5, 2017

Member

Fix is merged

Member

romani commented Jan 5, 2017

Fix is merged

@romani romani closed this Jan 5, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment