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

SingleLineJavadoc update for new requirements what tags are allowed in singleline javadoc #4052

Open
romani opened this Issue Mar 19, 2017 · 2 comments

Comments

Projects
None yet
2 participants
@romani
Member

romani commented Mar 19, 2017

parent issue - #3888

guide update - google/styleguide@594d91b#diff-b6c9191ee5ccb7a5ef170e98e51d94d8L1084

The basic form is always acceptable. The single-line form may be substituted when the entirety
of the Javadoc block (including comment markers) can fit on a single line. Note that this only
applies when there are no block tags such as @return.

http://checkstyle.sourceforge.net/config_javadoc.html#SingleLineJavadoc

we already have property - ignoredTags and it is null by default so no block tags are allowed.
ignoreInlineTags - is true by default.

We need to change our google config to ignore inline tags (switch to default).

definition of "block tags" (exact list of them) - http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDBEFIF (for java7)
Lets save this link in xdoc to explain user meaning of such terms.
We need to make it clear in xdoc that "tags" is the same as "block tags".

lets do updates for our IT inputs, case from #3762 should be added too.

@romani romani changed the title from SingleLineJavadoc allow to define at-clauses that are not allowed to be in single line javadoc to SingleLineJavadoc update for new requirements what tags are allowed in singlline javadoc Mar 19, 2017

@romani romani changed the title from SingleLineJavadoc update for new requirements what tags are allowed in singlline javadoc to SingleLineJavadoc update for new requirements what tags are allowed in singleline javadoc Mar 19, 2017

@alexbde

This comment has been minimized.

Show comment
Hide comment
@alexbde

alexbde Jan 23, 2018

Hey guys, we have false positives with google-java-format and default google_checks.xml config.

We need to change our google config to ignore inline tags (switch to default).

So that means current solution/workaround is to remove <property name="ignoreInlineTags" value="false"/> from <module name="SingleLineJavadoc">. Right?

Have you got any plans to update google_checks.xml in master?

Thank you in advance!

alexbde commented Jan 23, 2018

Hey guys, we have false positives with google-java-format and default google_checks.xml config.

We need to change our google config to ignore inline tags (switch to default).

So that means current solution/workaround is to remove <property name="ignoreInlineTags" value="false"/> from <module name="SingleLineJavadoc">. Right?

Have you got any plans to update google_checks.xml in master?

Thank you in advance!

@checkstyle checkstyle deleted a comment from divsidhu-26 Jan 23, 2018

@romani

This comment has been minimized.

Show comment
Hide comment
@romani

romani Jan 23, 2018

Member

Have you got any plans to update google_checks.xml in master?

Issue is approved, we just wait for smb to fix it. Please send PR , we will guide you on all required changes.

So that means current solution/workaround is to remove from . Right?

Yes. It will work to make a workaround on your side.
To fix it in master, in addition to config change, there should be done trivial changes in tests files, as some violations should disappear

Member

romani commented Jan 23, 2018

Have you got any plans to update google_checks.xml in master?

Issue is approved, we just wait for smb to fix it. Please send PR , we will guide you on all required changes.

So that means current solution/workaround is to remove from . Right?

Yes. It will work to make a workaround on your side.
To fix it in master, in addition to config change, there should be done trivial changes in tests files, as some violations should disappear

martinschneider added a commit to martinschneider/checkstyle that referenced this issue Oct 14, 2018

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