Skip to content
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

feature request: enforce JavaDoc or ScalaDoc indentation #211

Closed
ceedubs opened this issue Jul 14, 2016 · 1 comment
Closed

feature request: enforce JavaDoc or ScalaDoc indentation #211

ceedubs opened this issue Jul 14, 2016 · 1 comment
Labels

Comments

@ceedubs
Copy link

ceedubs commented Jul 14, 2016

The official indentation recommendation for ScalaDoc is:

/**
  * Does stuff.
  */

However, many projects have adopted the JavaDoc-style indentation:

/**
 * Does stuff.
 */

It would be nice to be able to add a scalastyle rule to enforce one or the other (in my case I'm interested in enforcing consistent JavaDoc-style indentation).

Note: #188 mentions that IndentationChecker#isTabAlligned enforces the JavaDoc-style. However, I would be interested in a less restrictive rule that only applies to comments, as isTabAligned doesn't play nicely with some styles of code formatting that I tend to like.

@matthewfarwell
Copy link
Member

I think that would be a good option. A PR would be wonderful.

tim-zh added a commit to tim-zh/scalastyle that referenced this issue Jun 2, 2017
matthewfarwell added a commit that referenced this issue Jun 4, 2017
Fix #211 feature request: enforce JavaDoc or ScalaDoc indentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants