GitHub user HyukjinKwon opened a pull request:
https://github.com/apache/incubator-predictionio/pull/264
[PIO-12] Add a rule for checking Scala documentation style
This PR adds the rule for checking Scala documentation style.
This rule will check below:
- Wrong
```
/**
*
...
```
- Correct
```
/**
*
...
```
We can't just enable `org.scalastyle.scalariform.ScalaDocChecker` because
it forces all the classes, traits, methods, types and properties to have
documentation which is overwhelming.
I ran the checking and then corrected the Java style documentation to Scala
documentation according to http://docs.scala-lang.org/style/scaladoc.html.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/HyukjinKwon/incubator-predictionio
PIO-12-scaladoc
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-predictionio/pull/264.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #264
----
commit 951f320fd376987d6df3343dc810bbe002099010
Author: hyukjinkwon <[email protected]>
Date: 2016-08-02T10:21:50Z
Add a rule for checking Scala documentation style
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
