Skip to content

Commit

Permalink
remove class HTML rendering in comments (linkerd#2050)
Browse files Browse the repository at this point in the history
Signed-off-by: Dennis Adjei-Baah <dennis@buoyant.io>
  • Loading branch information
Dennis Adjei-Baah committed Jul 11, 2018
1 parent d94a9ef commit 59c6eeb
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -57,25 +57,25 @@ trait Stream {
def onCancel: Future[Reset]

/**
* Wraps this [[Stream]] with a [[StreamOnFrame]] that calls the
* Wraps this Stream with a StreamOnFrame that calls the
* provided function on each frame after [[Stream.read read()]]
*
* @param onFrame the function to call on each frame.
* @return a [[StreamOnFrame]] [[StreamProxy]] wrapping this [[Stream]]
* @return a StreamOnFrame StreamProxy wrapping this Stream
*/
def onFrame(onFrame: Try[Frame] => Unit): Stream = new StreamOnFrame(this, onFrame)

/**
* Wraps this [[Stream]] with a function `f` that is called on each frame in
* the stream. The sequence of [[Frame]]s yielded by `f` will be inserted into
* Wraps this Stream with a function `f` that is called on each frame in
* the stream. The sequence of Frames yielded by `f` will be inserted into
* the stream in order at the current position.
*
* @note that in order to avoid violating flow control, `f` must either take
* ownership over the frame and release it, or return it in the returned
* sequence of frames.
* @see [[StreamFlatMap]]
* @param f the function called on each [[Stream]]
* @return a [[StreamFlatMap]] [[StreamProxy]] wrapping this [[Stream]]
* @see StreamFlatMap
* @param f the function called on each Stream
* @return a StreamFlatMap StreamProxy wrapping this Stream
*/
def flatMap(f: Frame => Seq[Frame]): Stream = new StreamFlatMap(this, f)

Expand Down Expand Up @@ -108,15 +108,15 @@ object Stream {
}

/**
* Read a [[Stream]] to the end, [[Frame.release release()]]ing each
* [[Frame]] before reading the next one.
* Read a Stream to the end, Frame.release release()ing each
* Frame before reading the next one.
*
* The value of each frame is discarded, but assertions can be made about
* their contents by attaching an [[Stream.onFrame onFrame()]] callback
* their contents by attaching an Stream.onFrame onFrame() callback
* before calling `readAll()`.
*
* @param stream the [[Stream]] to read to the end
* @return a [[Future]] that will finish when the whole stream is read
* @param stream the Stream to read to the end
* @return a Future that will finish when the whole stream is read
*/

def readToEnd(stream: Stream): Future[Unit] =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ object Headers {
* by the `l5d-dtab` header.
*
* Note that trace configuration is handled by
* [[HttpTraceInitializer.serverModule]].
* HttpTraceInitializer.serverModule.
*/
val serverModule: Stackable[ServiceFactory[Request, Response]] =
new Stack.Module1[hparam.MaxHeaderSize, ServiceFactory[Request, Response]] {
Expand Down Expand Up @@ -98,7 +98,7 @@ object Headers {
* - Dtab
*
* Note that trace configuration is handled by
* [[HttpTraceInitializer.clientModule]].
* HttpTraceInitializer.clientModule.
*/
val clientModule: Stackable[ServiceFactory[Request, Response]] =
new Stack.Module0[ServiceFactory[Request, Response]] {
Expand Down

0 comments on commit 59c6eeb

Please sign in to comment.