core
API
Generated with
core/smithy/smithy.api/Documentation

Documentation

smithy.api.Documentation
object Documentation extends Newtype[String]

Adds documentation to a shape or member using CommonMark syntax.

Attributes

Graph
Supertypes
class Newtype[String]
trait HasId
class Object
trait Matchable
class Any
Self type

Members list

Type members

Inherited classlikes

object hint

Attributes

Inherited from:
Newtype
Supertypes
class Object
trait Matchable
class Any

Inherited types

opaque type Type

Attributes

Inherited from:
Newtype

Value members

Inherited methods

def apply(a: String): Type

Attributes

Inherited from:
Newtype
def unapply(orig: Type): Some[String]

Attributes

Inherited from:
Newtype

Concrete fields

val hints: Hints
val id: ShapeId
val underlyingSchema: Schema[String]

Extensions

Inherited extensions

extension (orig: Type)
def value: String

Attributes

Inherited from:
Newtype

Implicits

Implicits

implicit val schema: Schema[Documentation]

Inherited implicits

implicit val asBijection: Bijection[String, Type]

Attributes

Inherited from:
Newtype
implicit val tag: ShapeTag[Type]

Attributes

Inherited from:
Newtype
Generated with