com.sksamuel.scruffy

scribble

package scribble

Visibility
  1. Public
  2. All

Type Members

  1. case class Param(name: String, description: String, type: String, required: Boolean) extends Product with Serializable

  2. case class Response(code: Int, description: String) extends Product with Serializable

  3. case class RouteDoc(name: String, method: HttpMethod, path: String, group: String, description: String, input: Option[String], output: Option[String], since: Option[String], consumes: Seq[String], produces: Seq[String], authorization: Option[String], responses: Seq[Response] = Nil, params: Seq[Param] = Nil) extends Product with Serializable

  4. case class ScribbleDoc(body: String, tags: Seq[Tag]) extends Product with Serializable

    ScribbleDoc is a container for the ScalaDoc comments added to a scribble http route.

  5. case class Tag(name: String, value: String) extends Product with Serializable

Value Members

  1. object ScribbleDocParser

  2. object ScribbleParser extends Parser

  3. object ScribbleScanner extends Logging

  4. object ScribbleWriter extends Logging

Ungrouped