MarkdownExporting

Value Members

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

   Definition Classes

   AnyRef

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

   Definition Classes

   Any

3. final def ##(): Int

   Definition Classes

   AnyRef → Any

4. final def ==(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

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

   Definition Classes

   Any

6. implicit lazy val HtmlReducer: Reducer[ExecutingFragment, Stream[HtmlLine]]

   Definition Classes

   HtmlPrinter

7. def addToc(implicit args: Arguments): (Tree[HtmlLinesFile]) ⇒ Seq[HtmlLinesFile]

   returns

   add a toc to each HtmlFile where relevant

   Definition Classes

   HtmlPrinter

8. final def asInstanceOf[T0]: T0

   Definition Classes

   Any

9. def checkUrls(args: Arguments, others: Seq[HtmlFile]): (HtmlFile) ⇒ HtmlFile

   Attributes

   protected

   Definition Classes

   HtmlFileWriter

10. def clone(): AnyRef

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

11. def copyResources(): Unit

    copy css and images file to the output directory

    copy css and images file to the output directory

    Attributes

    protected

    Definition Classes

    HtmlFileWriter

12. def createHtmlLinesFiles(spec: ExecutedSpecification)(implicit args: Arguments): Tree[HtmlLinesFile]

    map the executed fragments to HtmlLines and sort them by destination file, one file per specification

    map the executed fragments to HtmlLines and sort them by destination file, one file per specification

    returns

    a Tree of HtmlLinesFile where the root is the parent specification and children are the included specifications

    Definition Classes

    HtmlPrinter

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

    Definition Classes

    AnyRef

14. def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

15. def export(implicit arguments: Arguments): (ExecutingSpecification) ⇒ ExecutedSpecification

    Definition Classes

    HtmlExporting → Exporting

16. def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

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

    Definition Classes

    AnyRef → Any

18. def hashCode(): Int

    Definition Classes

    AnyRef → Any

19. final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

20. def markdownExtension: String

    markdown and .

    markdown and .md is the default output format

    Definition Classes

    MarkdownExporting

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

    Definition Classes

    AnyRef

22. final def notify(): Unit

    Definition Classes

    AnyRef

23. final def notifyAll(): Unit

    Definition Classes

    AnyRef

24. def output(implicit args: Arguments): HtmlReportOutput

    returns

    a new ReportOutput object creating markup elements

    Definition Classes

    MarkdownExporting → HtmlPrinter

25. def print(spec: ExecutedSpecification)(implicit args: Arguments): Seq[HtmlFile]

    print a sequence of executed fragments for a given specification class into a html file the name of the html file is the full class name

    print a sequence of executed fragments for a given specification class into a html file the name of the html file is the full class name

    Definition Classes

    HtmlPrinter

26. def printHtml(output: ⇒ HtmlReportOutput)(implicit args: Arguments): (HtmlLinesFile) ⇒ HtmlFile

    a function printing html lines to a file given:

    a function printing html lines to a file given:

    - the list of lines to print - an output object responsible for printing each HtmlLine as xhtml

    Definition Classes

    HtmlPrinter

27. def reduce(spec: ExecutedSpecification)(implicit args: Arguments): Seq[HtmlLine]

    Organize the fragments into blocks of html lines to print, grouping all the fragments found after a link into a single block that will be reported on a different html page

    Organize the fragments into blocks of html lines to print, grouping all the fragments found after a link into a single block that will be reported on a different html page

    This works by using a List of HtmlLines as a stack where the head of the list is the current block of lines

    returns

    the HtmlLines to print

    Definition Classes

    HtmlPrinter

28. def reportPath(url: String): String

    returns

    the file path for the markdown output

    Definition Classes

    MarkdownExporting → OutputDir

29. def sortByFile(specName: SpecName, arguments: Arguments, parentLink: HtmlLink): (Seq[HtmlLine]) ⇒ Tree[HtmlLinesFile]

    Sort HtmlLines into a Tree of HtmlLinesFile object where the tree represents the tree of included specifications

    Sort HtmlLines into a Tree of HtmlLinesFile object where the tree represents the tree of included specifications

    The goal is to create a file per included specification and to use the Tree of files to create a table of contents for the root specification

    Definition Classes

    HtmlPrinter

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

    Definition Classes

    AnyRef

31. def toString(): String

    Definition Classes

    AnyRef → Any

32. final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

35. def writeFile: (HtmlFile) ⇒ Unit

    Attributes

    protected

    Definition Classes

    HtmlFileWriter

36. def writeFiles(implicit args: Arguments = Arguments()): (Seq[HtmlFile]) ⇒ Unit

    Definition Classes

    MarkdownExporting → HtmlFileWriter

37. def writeXml(xml: NodeSeq)(out: Writer): Unit

    write the xml output to a Writer

    write the xml output to a Writer

    Attributes

    protected

    Definition Classes

    MarkdownExporting → HtmlFileWriter