fixing scaladoc warnings reported by jenkins

This commit is contained in:
Wojciech Langiewicz 2016-03-10 11:31:18 +01:00
parent 87113f9b14
commit afce1b7529
26 changed files with 74 additions and 73 deletions

View file

@ -18,9 +18,10 @@ import akka.stream.javadsl.Source;
* The model of multipart content for media-types `multipart/\*` (general multipart content),
* `multipart/form-data` and `multipart/byteranges`.
*
* The basic modelling classes for these media-types ([[Multipart.General]], [[Multipart.FormData]] and
* [[Multipart.ByteRanges]], respectively) are stream-based but each have a strict counterpart
* (namely [[Multipart.General.Strict]], [[Multipart.FormData.Strict]] and [[Multipart.ByteRanges.Strict]]).
* The basic modelling classes for these media-types ([[akka.http.scaladsl.Multipart.General]], [[Multipart.FormData]] and
* [[akka.http.scaladsl.Multipart.ByteRanges]], respectively) are stream-based but each have a strict counterpart
* (namely [[akka.http.scaladsl.Multipart.General.Strict]], [[akka.http.scaladsl.Multipart.FormData.Strict]] and
* [[akka.http.scaladsl.Multipart.ByteRanges.Strict]]).
*/
public interface Multipart {

View file

@ -54,7 +54,7 @@ class HttpExt(private val config: Config)(implicit val system: ActorSystem) exte
private[this] final val DefaultPortForProtocol = -1 // any negative value
/**
* Creates a [[Source]] of [[IncomingConnection]] instances which represents a prospective HTTP server binding
* Creates a [[akka.stream.scaladsl.Source]] of [[IncomingConnection]] instances which represents a prospective HTTP server binding
* on the given `endpoint`.
*
* If the given port is 0 the resulting source can be materialized several times. Each materialization will
@ -666,16 +666,16 @@ object Http extends ExtensionId[HttpExt] with ExtensionIdProvider {
/**
* Represents a prospective HTTP server binding.
*
* @param localAddress The local address of the endpoint bound by the materialization of the `connections` [[Source]]
* @param localAddress The local address of the endpoint bound by the materialization of the `connections` [[akka.stream.scaladsl.Source]]
*
*/
final case class ServerBinding(localAddress: InetSocketAddress)(private val unbindAction: () Future[Unit]) {
/**
* Asynchronously triggers the unbinding of the port that was bound by the materialization of the `connections`
* [[Source]]
* [[akka.stream.scaladsl.Source]]
*
* The produced [[Future]] is fulfilled when the unbinding has been completed.
* The produced [[scala.concurrent.Future]] is fulfilled when the unbinding has been completed.
*/
def unbind(): Future[Unit] = unbindAction()
}
@ -722,7 +722,7 @@ object Http extends ExtensionId[HttpExt] with ExtensionIdProvider {
/**
* Asynchronously triggers the shutdown of the host connection pool.
*
* The produced [[Future]] is fulfilled when the shutdown has been completed.
* The produced [[scala.concurrent.Future]] is fulfilled when the shutdown has been completed.
*/
def shutdown()(implicit ec: ExecutionContextExecutor): Future[Done] = gatewayFuture.flatMap(_.shutdown())
@ -746,7 +746,7 @@ object Http extends ExtensionId[HttpExt] with ExtensionIdProvider {
* TLS configuration for an HTTPS server binding or client connection.
* For the sslContext please refer to the com.typeasfe.ssl-config library.
* The remaining four parameters configure the initial session that will
* be negotiated, see [[NegotiateNewSession]] for details.
* be negotiated, see [[akka.stream.TLSProtocol.NegotiateNewSession]] for details.
*/
trait DefaultSSLContextCreation {

View file

@ -195,8 +195,8 @@ object HttpEntity {
HttpEntity.Chunked.fromData(contentType, data)
/**
* Returns either the empty entity, if the given file is empty, or a [[Default]] entity
* consisting of a stream of [[ByteString]] instances each containing `chunkSize` bytes
* Returns either the empty entity, if the given file is empty, or a [[HttpEntity.Default]] entity
* consisting of a stream of [[akka.util.ByteString]] instances each containing `chunkSize` bytes
* (except for the final ByteString, which simply contains the remaining bytes).
*
* If the given `chunkSize` is -1 the default chunk size is used.

View file

@ -42,13 +42,13 @@ object HttpHeader {
* partial value parsing. In this case the method returns a `ParsingResult.Ok` with the respective header
* instance holding the valid value elements and an [[ErrorInfo]] for each invalid value.
* c) the value has invalid elements and the header type doesn't support partial value parsing.
* In this case the method returns a `ParsingResult.Ok` with a [[RawHeader]] instance and
* In this case the method returns a `ParsingResult.Ok` with a [[akka.http.scaladsl.model.headers.RawHeader]] instance and
* a single [[ErrorInfo]] for the value parsing problem.
*
* 2. The header name does not correspond to a properly modelled header but the header name and the value are both
* syntactically legal according to the basic header requirements from the HTTP specification.
* (http://tools.ietf.org/html/rfc7230#section-3.2)
* In this case the method returns a `ParsingResult.Ok` with a [[RawHeader]] instance and no errors.
* In this case the method returns a `ParsingResult.Ok` with a [[akka.http.scaladsl.model.headers.RawHeader]] instance and no errors.
*
* 3. The header name or value are illegal according to the basic requirements for HTTP headers
* (http://tools.ietf.org/html/rfc7230#section-3.2). In this case the method returns a `ParsingResult.Error`.

View file

@ -155,7 +155,7 @@ final case class HttpRequest(method: HttpMethod = HttpMethods.GET,
* http://tools.ietf.org/html/rfc7230#section-5.5
*
* Throws an [[IllegalUriException]] if the URI is relative and the `headers` don't
* include a valid [[Host]] header or if URI authority and [[Host]] header don't match.
* include a valid [[akka.http.scaladsl.model.headers.Host]] header or if URI authority and [[akka.http.scaladsl.model.headers.Host]] header don't match.
*/
def effectiveUri(securedConnection: Boolean, defaultHostHeader: Host = Host.empty): Uri =
HttpRequest.effectiveUri(uri, headers, securedConnection, defaultHostHeader)

View file

@ -15,7 +15,7 @@ sealed trait Message
/**
* Represents a WebSocket text message. A text message can either be a [[TextMessage.Strict]] in which case
* the complete data is already available or it can be [[TextMessage.Streamed]] in which case [[textStream]]
* the complete data is already available or it can be [[TextMessage.Streamed]] in which case `textStream`
* will return a Source streaming the data as it comes in.
*/
sealed trait TextMessage extends Message {
@ -42,7 +42,7 @@ object TextMessage {
/**
* Represents a WebSocket binary message. A binary message can either be [[BinaryMessage.Strict]] in which case
* the complete data is already available or it can be [[BinaryMessage.Streamed]] in which case [[dataStream]]
* the complete data is already available or it can be [[BinaryMessage.Streamed]] in which case `dataStream`
* will return a Source streaming the data as it comes in.
*/
//#message-model
@ -59,7 +59,7 @@ object BinaryMessage {
Streamed(dataStream)
/**
* A strict [[BinaryMessage]] that contains the complete data as a [[ByteString]].
* A strict [[BinaryMessage]] that contains the complete data as a [[akka.util.ByteString]].
*/
final case class Strict(data: ByteString) extends BinaryMessage {
def dataStream: Source[ByteString, _] = Source.single(data)

View file

@ -12,8 +12,8 @@ import scala.concurrent.duration.Duration
import scala.concurrent._
/**
* Provides alternative implementations of the basic transformation operations defined on [[Future]],
* which try to avoid scheduling to an [[ExecutionContext]] if possible, i.e. if the given future
* Provides alternative implementations of the basic transformation operations defined on [[scala.concurrent.Future]],
* which try to avoid scheduling to an [[scala.concurrent.ExecutionContext]] if possible, i.e. if the given future
* value is already present.
*/
class FastFuture[A](val future: Future[A]) extends AnyVal {