Merge pull request #20000 from wlk/wlk-18500-fix-scaladoc-warnings-from-jenkins

[WIP] fixing scaladoc warnings reported by jenkins
This commit is contained in:
Konrad Malawski 2016-03-11 15:11:31 +01:00
commit 4d9ffd6387
26 changed files with 74 additions and 73 deletions

View file

@ -14,7 +14,7 @@ import scala.concurrent.duration._
import scala.concurrent.Await
/**
* A RouteTest that uses JUnit assertions. ActorSystem and Materializer are provided as an [[ExternalResource]]
* A RouteTest that uses JUnit assertions. ActorSystem and Materializer are provided as an [[org.junit.rules.ExternalResource]]
* and their lifetime is automatically managed.
*/
abstract class JUnitRouteTestBase extends RouteTest {

View file

@ -24,7 +24,7 @@ import akka.http.impl.util._
/**
* A base class to create route tests for testing libraries. An implementation needs to provide
* code to provide and shutdown an [[ActorSystem]], [[Materializer]], and [[ExecutionContextExecutor]].
* code to provide and shutdown an [[akka.actor.ActorSystem]], [[akka.stream.Materializer]], and [[scala.concurrent.ExecutionContextExecutor]].
* Also an implementation should provide instances of [[TestResponse]] to define the assertion
* facilities of the testing library.
*
@ -77,7 +77,7 @@ abstract class RouteTest extends AllDirectives {
}
/**
* Creates a [[TestRoute]] for the main route of an [[HttpApp]].
* Creates a [[TestRoute]] for the main route of an [[akka.http.javadsl.server.HttpApp]].
*/
def testAppRoute(app: HttpApp): TestRoute = testRoute(app.createRoute())

View file

@ -63,7 +63,7 @@ abstract class TestResponse(_response: HttpResponse, awaitAtMost: FiniteDuration
def entityAsString: String = entity.getData.utf8String
/**
* Returns the [[StatusCode]] of the response.
* Returns the [[akka.http.javadsl.model.StatusCode]] of the response.
*/
def status: StatusCode = response.status.asJava
@ -117,7 +117,7 @@ abstract class TestResponse(_response: HttpResponse, awaitAtMost: FiniteDuration
assertEqualsKind(expected, entityBytes, "entity")
/**
* Assert on the response entity to equal the given object after applying an [[Unmarshaller]].
* Assert on the response entity to equal the given object after applying an [[akka.http.javadsl.server.Unmarshaller]].
*/
def assertEntityAs[T <: AnyRef](unmarshaller: Unmarshaller[T], expected: T): TestResponse =
assertEqualsKind(expected, entityAs(unmarshaller), "entity")