build-module
API
Generated with
build-module/scala.build/scala.build.internal/scala.build.internal.markdown/MarkdownCodeBlock

MarkdownCodeBlock

scala.build.internal.markdown.MarkdownCodeBlock
See theMarkdownCodeBlock companion class
object MarkdownCodeBlock

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Members list

Type members

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def findCodeBlocks(subPath: SubPath, md: String, maybeRecoverOnError: BuildException => Option[BuildException]): Either[BuildException, Seq[MarkdownCodeBlock]]

Finds all code snippets in given input

Finds all code snippets in given input

Value parameters

maybeRecoverOnError

function potentially recovering on errors

md

Markdown file in a String format

subPath

the project os.SubPath to the Markdown file

Attributes

Returns

list of all found snippets

Generated with