Object

net.adamcin.scalamojo

ScalaDocStringer

Related Doc: package scalamojo

Permalink

object ScalaDocStringer

Methods useful for generating html strings from text in scaladoc comments, mostly ripped straight from the ScalaDoc tool's HTML generator logic

Since

0.6.0

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ScalaDocStringer
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

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. def blockToHtml(block: Block): NodeSeq

    Permalink
  6. def bodyToHtml(body: Body): NodeSeq

    Permalink
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def commentInheritor(member: MemberEntity)(getter: (Option[Comment]) ⇒ Option[String]): Option[String]

    Permalink
  9. def commentToHtml(comment: Comment): NodeSeq

    Permalink

    Transforms a comment into an styled HTML tree representing its body.

  10. def commentToHtml(comment: Option[Comment]): NodeSeq

    Permalink

    Transforms an optional comment into an styled HTML tree representing its body if it is defined, or into an empty node sequence if it is not.

  11. def docEntityKindToBigImage(ety: DocTemplateEntity): String

    Permalink

    Returns the _big image name corresponding to the DocTemplate Entity (upper left icon)

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

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  16. def getDeprecated(member: MemberEntity): Option[String]

    Permalink
  17. def getDeprecated(traitDef: Trait): Option[String]

    Permalink
  18. def getDescription(comment: Option[Comment]): Option[String]

    Permalink
  19. def getSince(comment: Option[Comment]): Option[String]

    Permalink
  20. def hasPage(e: DocTemplateEntity): Boolean

    Permalink
  21. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  22. def inlineToHtml(inl: Inline): NodeSeq

    Permalink
  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  24. def kindToString(mbr: MemberEntity): String

    Permalink
  25. def linkToHtml(text: Inline, link: LinkTo, hasLinks: Boolean): NodeSeq

    Permalink
  26. def listItemsToHtml(items: Seq[Block]): NodeSeq

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

    Permalink
    Definition Classes
    AnyRef
  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. def relativeLinkTo(destPath: List[String]): String

    Permalink

    A relative link from this page to some destination path.

    A relative link from this page to some destination path.

    destPath

    The path that the link will point to.

  31. def relativeLinkTo(destClass: TemplateEntity): String

    Permalink

    A relative link from this page to some destination class entity.

    A relative link from this page to some destination class entity.

    destClass

    The class or object entity that the link will point to.

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

    Permalink
    Definition Classes
    AnyRef
  33. def templateToHtml(tpl: TemplateEntity, name: String = null): Node with Serializable

    Permalink

    Returns the HTML code that represents the template in tpl as a hyperlinked name.

  34. def templateToPath(tpl: TemplateEntity): List[String]

    Permalink
  35. def templatesToHtml(tplss: List[TemplateEntity], sep: NodeSeq): NodeSeq

    Permalink

    Returns the HTML code that represents the templates in tpls as a list of hyperlinked names.

  36. def toHtmlString(el: NodeSeq): String

    Permalink
  37. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  38. def typeToHtml(tpe: TypeEntity, hasLinks: Boolean): NodeSeq

    Permalink
  39. def typeToHtml(tpes: List[TypeEntity], hasLinks: Boolean): NodeSeq

    Permalink
  40. def typesToHtml(tpess: List[TypeEntity], hasLinks: Boolean, sep: NodeSeq): NodeSeq

    Permalink
  41. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long): Unit

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

Inherited from AnyRef

Inherited from Any

Ungrouped