Skip to content

Commit 750d205

Browse files
committed
reformatted and fixed scaladocs
1 parent a26e206 commit 750d205

File tree

37 files changed

+154
-152
lines changed

37 files changed

+154
-152
lines changed

build.sbt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,6 @@ val commonSettings = Seq(
6767
</developers>
6868
},
6969

70-
(publishArtifact in packageDoc) := false,
7170
libraryDependencies += compilerPlugin("com.github.ghik" % "silencer-plugin" % silencerVersion),
7271
libraryDependencies ++= Seq(
7372
"com.github.ghik" % "silencer-lib" % silencerVersion,

commons-analyzer/src/test/scala/com/avsystem/commons/analyzer/AnalyzerTest.scala

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
11
package com.avsystem.commons
22
package analyzer
33

4-
import org.scalatest.{Assertions, FunSuite}
4+
import org.scalatest.Assertions
55

66
import scala.reflect.internal.util.BatchSourceFile
77
import scala.tools.nsc.plugins.Plugin
88
import scala.tools.nsc.{Global, Settings}
99

1010
/**
11-
* Author: ghik
12-
* Created: 21/08/15.
13-
*/
14-
trait AnalyzerTest { this: Assertions =>
11+
* Author: ghik
12+
* Created: 21/08/15.
13+
*/
14+
trait AnalyzerTest {this: Assertions =>
1515
val settings = new Settings
1616
settings.usejavacp.value = true
17-
val compiler = new Global(settings) {
18-
global =>
17+
val compiler = new Global(settings) {global =>
1918

2019
override protected def loadRoughPluginsList(): List[Plugin] =
2120
new AnalyzerPlugin(global) :: super.loadRoughPluginsList()

commons-analyzer/src/test/scala/com/avsystem/commons/analyzer/DetectSI7046Test.scala

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ package analyzer
44
import org.scalatest.FunSuite
55

66
/**
7-
* Author: ghik
8-
* Created: 08/09/15.
9-
*/
7+
* Author: ghik
8+
* Created: 08/09/15.
9+
*/
1010
class DetectSI7046Test extends FunSuite with AnalyzerTest {
1111
test("too few varargs parameters should be rejected") {
1212
assertErrors(

commons-analyzer/src/test/scala/com/avsystem/commons/analyzer/ImportJavaUtilTest.scala

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ package analyzer
44
import org.scalatest.FunSuite
55

66
/**
7-
* Author: ghik
8-
* Created: 08/09/15.
9-
*/
7+
* Author: ghik
8+
* Created: 08/09/15.
9+
*/
1010
class ImportJavaUtilTest extends FunSuite with AnalyzerTest {
1111
test("import java.util should be rejected") {
1212
assertErrors(

commons-analyzer/src/test/scala/com/avsystem/commons/analyzer/VarargsAtLeastTest.scala

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ package analyzer
44
import org.scalatest.FunSuite
55

66
/**
7-
* Author: ghik
8-
* Created: 08/09/15.
9-
*/
7+
* Author: ghik
8+
* Created: 08/09/15.
9+
*/
1010
class VarargsAtLeastTest extends FunSuite with AnalyzerTest {
1111
test("too few varargs parameters should be rejected") {
1212
assertErrors(

commons-annotations/src/main/scala/com/avsystem/commons/annotation/atLeast.scala

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ package annotation
44
import scala.annotation.StaticAnnotation
55

66
/**
7-
* When applied on varargs parameter, indicates that at least some number of parameters is required.
8-
* This is later checked by the static analyzer.
9-
* <br/>
10-
* WARNING: implementation of method which takes a varargs parameter may NOT assume that given number of
11-
* arguments will always be passed, because it's still possible to pass a [[Seq]] where varargs parameter is
12-
* required using the `: _*` ascription, e.g.
13-
* {{{
14-
* varargsMethod(List(): _*)
15-
* }}}
16-
* and that is not checked by the static analyzer.
17-
*/
7+
* When applied on varargs parameter, indicates that at least some number of parameters is required.
8+
* This is later checked by the static analyzer.
9+
* <br/>
10+
* WARNING: implementation of method which takes a varargs parameter may NOT assume that given number of
11+
* arguments will always be passed, because it's still possible to pass a `Seq` where
12+
* varargs parameter is required using the `: _*` ascription, e.g.
13+
* {{{
14+
* varargsMethod(List(): _*)
15+
* }}}
16+
* and that is not checked by the static analyzer.
17+
*/
1818
class atLeast(n: Int) extends StaticAnnotation

commons-annotations/src/main/scala/com/avsystem/commons/serialization/name.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ package serialization
44
import scala.annotation.StaticAnnotation
55

66
/**
7-
* Can be used on case class fields and classes in sealed hierarchy to instruct automatically derived [[GenCodec]]
7+
* Can be used on case class fields and classes in sealed hierarchy to instruct automatically derived `GenCodec`
88
* to use particular name instead of just using parameter or class name.
99
*
1010
* For example:

commons-annotations/src/main/scala/com/avsystem/commons/serialization/transientDefault.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import scala.annotation.StaticAnnotation
55

66
/**
77
* If some case class field has default value, you can use this annotation on this field to instruct an
8-
* automatically derived [[GenCodec]] to not persist the value of that field if it's equal to the default value.
8+
* automatically derived `GenCodec` to not persist the value of that field if it's equal to the default value.
99
*
1010
* For example:
1111
* {{{

commons-annotations/src/main/scala/com/avsystem/commons/serialization/transparent.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ package serialization
44
import scala.annotation.StaticAnnotation
55

66
/**
7-
* Can be used on case classes with exactly one field to instruct automatically generated [[GenCodec]] that the
7+
* Can be used on case classes with exactly one field to instruct automatically generated `GenCodec` that the
88
* class is a "transparent wrapper" and should be serialized to the same representation as the value of its sole
99
* field.
1010
*/

commons-core/src/main/scala/com/avsystem/commons/jiop/JFunctionUtils.scala

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@ package com.avsystem.commons
22
package jiop
33

44
import java.util.concurrent.Callable
5-
import java.util.{function => juf, Comparator}
5+
import java.util.{Comparator, function => juf}
66

77
import com.avsystem.commons.misc.Sam
88

99
import scala.language.implicitConversions
1010

1111
/**
12-
* Utils to convert Scala functions and expressions to most common Java functional interfaces.
13-
*/
12+
* Utils to convert Scala functions and expressions to most common Java functional interfaces.
13+
*/
1414
trait JFunctionUtils {
1515
def jRunnable(code: => Any) = Sam[Runnable](code)
1616
def jCallable[T](expr: => T) = Sam[Callable[T]](expr)

0 commit comments

Comments
 (0)