Class/Object

mdoc.internal.cli

Settings

Related Docs: object Settings | package cli

Permalink

case class Settings(in: AbsolutePath, out: AbsolutePath, watch: Boolean = false, check: Boolean = false, noLinkHygiene: Boolean = false, verbose: Boolean = false, site: Map[String, String] = Map.empty, classpath: String = "", scalacOptions: String = "", cleanTarget: Boolean = false, noLivereload: Boolean = false, port: Int = 4000, host: String = "localhost", help: Boolean = false, usage: Boolean = false, version: Boolean = false, markdownExtensions: List[String] = List("md", "html"), include: List[PathMatcher] = Nil, exclude: List[PathMatcher] = Nil, reportRelativePaths: Boolean = false, charset: Charset = StandardCharsets.UTF_8, cwd: AbsolutePath, stringModifiers: List[StringModifier] = StringModifier.default(), postModifiers: List[PostModifier] = PostModifier.default(), preModifiers: List[PreModifier] = PreModifier.default(), inputStream: InputStream = System.in, screenWidth: Int = 120, screenHeight: Int = 50, headerIdGenerator: (String) ⇒ String = GitHubIdGenerator, variablePrinter: (Variable) ⇒ String = ReplVariablePrinter) extends Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Settings
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Settings(in: AbsolutePath, out: AbsolutePath, watch: Boolean = false, check: Boolean = false, noLinkHygiene: Boolean = false, verbose: Boolean = false, site: Map[String, String] = Map.empty, classpath: String = "", scalacOptions: String = "", cleanTarget: Boolean = false, noLivereload: Boolean = false, port: Int = 4000, host: String = "localhost", help: Boolean = false, usage: Boolean = false, version: Boolean = false, markdownExtensions: List[String] = List("md", "html"), include: List[PathMatcher] = Nil, exclude: List[PathMatcher] = Nil, reportRelativePaths: Boolean = false, charset: Charset = StandardCharsets.UTF_8, cwd: AbsolutePath, stringModifiers: List[StringModifier] = StringModifier.default(), postModifiers: List[PostModifier] = PostModifier.default(), preModifiers: List[PreModifier] = PreModifier.default(), inputStream: InputStream = System.in, screenWidth: Int = 120, screenHeight: Int = 50, headerIdGenerator: (String) ⇒ String = GitHubIdGenerator, variablePrinter: (Variable) ⇒ String = ReplVariablePrinter)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. val charset: Charset

    Permalink

  6. val check: Boolean

    Permalink

  7. val classpath: String

    Permalink

  8. val cleanTarget: Boolean

    Permalink

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. val cwd: AbsolutePath

    Permalink

  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  12. val exclude: List[PathMatcher]

    Permalink

  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  15. val headerIdGenerator: (String) ⇒ String

    Permalink

  16. val help: Boolean

    Permalink

  17. val host: String

    Permalink

  18. val in: AbsolutePath

    Permalink

  19. val include: List[PathMatcher]

    Permalink

  20. val inputStream: InputStream

    Permalink

  21. def isExplicitlyExcluded(path: RelativePath): Boolean

    Permalink

  22. def isFileWatching: Boolean

    Permalink

  23. def isIncluded(path: RelativePath): Boolean

    Permalink

  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  25. val isMarkdownFileExtension: Set[String]

    Permalink

  26. val markdownExtensions: List[String]

    Permalink

  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  28. val noLinkHygiene: Boolean

    Permalink

  29. val noLivereload: Boolean

    Permalink

  30. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  31. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  32. def onLoad(reporter: Reporter): Unit

    Permalink

  33. val out: AbsolutePath

    Permalink

  34. val port: Int

    Permalink

  35. val postModifiers: List[PostModifier]

    Permalink

  36. val preModifiers: List[PreModifier]

    Permalink

  37. val reportRelativePaths: Boolean

    Permalink

  38. def resolveIn(relpath: RelativePath): AbsolutePath

    Permalink

  39. def resolveOut(relpath: RelativePath): AbsolutePath

    Permalink

  40. val scalacOptions: String

    Permalink

  41. val screenHeight: Int

    Permalink

  42. val screenWidth: Int

    Permalink

  43. val site: Map[String, String]

    Permalink

  44. val stringModifiers: List[StringModifier]

    Permalink

  45. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  46. def toInputFile(infile: AbsolutePath): Option[InputFile]

    Permalink

  47. def toString(): String

    Permalink
    Definition Classes
    Settings → AnyRef → Any

  48. val usage: Boolean

    Permalink

  49. def validate(logger: Reporter): Configured[Context]

    Permalink

  50. val variablePrinter: (Variable) ⇒ String

    Permalink

  51. val verbose: Boolean

    Permalink

  52. val version: Boolean

    Permalink

  53. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  54. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  55. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  56. val watch: Boolean

    Permalink

  57. def withProperties(props: MdocProperties): Settings

    Permalink

  58. def withWorkingDirectory(dir: AbsolutePath): Settings

    Permalink

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped