com.typesafe.genjavadoc

TransformCake

Related Doc: package genjavadoc

trait TransformCake extends JavaSig with Output with Comments with BasicTransform with AST

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. TransformCake
  2. AST
  3. BasicTransform
  4. Comments
  5. BaseComments
  6. Output
  7. JavaSig
  8. NeedsJavaSig
  9. AnyRef
  10. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class ClassInfo(sym: scala.tools.nsc.Global.Symbol, name: String, access: String, pattern: (String, String) ⇒ String, module: Boolean, comment: Seq[String], pckg: String, filepattern: (String) ⇒ String, members: Vector[TransformCake.Templ], interface: Boolean, static: Boolean, firstConstructor: Boolean) extends TransformCake.Templ with Product with Serializable

    Definition Classes
    AST
  2. case class Comment(pos: scala.tools.nsc.Global.Position, text: Seq[String]) extends Product with Serializable

    Definition Classes
    BaseComments
  3. case class DeprecationInfo(msg: String, since: String) extends Product with Serializable

    Definition Classes
    AST
  4. case class MethodInfo(access: String, pattern: (String) ⇒ String, ret: String, name: String, comment: Seq[String], d: Option[scala.tools.nsc.Global.DefDef] = None) extends TransformCake.Templ with Product with Serializable

    Definition Classes
    AST
  5. trait Out extends AnyRef

    Definition Classes
    Output
  6. trait Templ extends AnyRef

    Definition Classes
    AST
  7. class UnknownSig extends Exception

    Definition Classes
    JavaSig

Abstract Value Members

  1. abstract def allowedAnnotations: Set[String]

  2. abstract def fabricateParams: Boolean

    Definition Classes
    AST
  3. abstract def filteredStrings: Set[String]

  4. abstract val global: Global

  5. abstract def javaKeywords: Set[String]

  6. abstract def outputBase: File

    Definition Classes
    Output
  7. abstract def strictVisibility: Boolean

    Definition Classes
    AST
  8. abstract def superTransform(tree: scala.tools.nsc.Global.Tree): scala.tools.nsc.Global.Tree

  9. abstract def superTransformUnit(unit: scala.tools.nsc.Global.CompilationUnit): Unit

  10. abstract def suppressSynthetic: Boolean

    Definition Classes
    BasicTransform
  11. abstract def unit: scala.tools.nsc.Global.CompilationUnit

    Definition Classes
    BaseComments

Concrete Value Members

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

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  4. object ClassInfo extends Serializable

    Definition Classes
    AST
  5. object Comment extends Serializable

    Definition Classes
    BaseComments
  6. object MethodInfo extends Serializable

    Definition Classes
    AST
  7. val PreFilter: PartialFunction[ClassInfo, ClassInfo]

    Definition Classes
    Output
  8. object Scaladoc extends (TransformCake.Comment) ⇒ Boolean

    Definition Classes
    BaseComments
  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def between(p1: scala.tools.nsc.Global.Position, p2: scala.tools.nsc.Global.Position): String

    Definition Classes
    BaseComments
  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. var comments: TreeMap[Int, Comment]

    Definition Classes
    BaseComments
  13. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  15. def file(name: String): Out

    Definition Classes
    Output
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def flattenObjects(c: Vector[ClassInfo], forwarders: Boolean = true, staticScope: Boolean = true): Vector[ClassInfo]

    This method is supposed to do the transformation of object into

    This method is supposed to do the transformation of object into

    • a class with $ appended to the name
    • including a MODULE$ static field
    • and static forwarders in the original class

    The first two parts are to be applied recursively to nested objects.

    Definition Classes
    Output
  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. def js(sym0: scala.tools.nsc.Global.Symbol, info: scala.tools.nsc.Global.Type, voidOK: Boolean = true, debug: Boolean = false): String

    Definition Classes
    JavaSig
  22. def liftInnerClassesWithSameName(c: ClassInfo): Seq[ClassInfo]

    Lift nested interfaces with the same name as their parent class to the parent level, as Java does not allow this, mangling their name accordingly

    Lift nested interfaces with the same name as their parent class to the parent level, as Java does not allow this, mangling their name accordingly

    Also applied recursively to members

    Definition Classes
    Output
  23. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  24. def needsJavaSig(tp: scala.tools.nsc.Global.Type): Boolean

    Definition Classes
    NeedsJavaSig
  25. def newTransform(tree: scala.tools.nsc.Global.Tree): scala.tools.nsc.Global.Tree

    Definition Classes
    BasicTransform
  26. def newTransformUnit(unit: scala.tools.nsc.Global.CompilationUnit): Unit

    Definition Classes
    BasicTransform
  27. final def notify(): Unit

    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  29. def parseComments(): Unit

    Definition Classes
    CommentsBaseComments
  30. object parser extends SyntaxAnalyzer

    Definition Classes
    Comments
  31. implicit val positionOrdering: Ordering[scala.tools.nsc.Global.Position]

    Definition Classes
    BaseComments
  32. val positions: SortedSet[Int]

    Definition Classes
    BaseComments
  33. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  34. def toString(): String

    Definition Classes
    AnyRef → Any
  35. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. def withoutPrivates(c: ClassInfo): Option[ClassInfo]

    Private methods and classes are not visible in the javadoc, so they can be removed wholesale.

    Private methods and classes are not visible in the javadoc, so they can be removed wholesale.

    Definition Classes
    Output
  39. def write(out: Out, m: MethodInfo): Unit

    Definition Classes
    Output
  40. def write(out: Out, c: ClassInfo): Unit

    Definition Classes
    Output

Inherited from AST

Inherited from BasicTransform

Inherited from Comments

Inherited from BaseComments

Inherited from Output

Inherited from JavaSig

Inherited from NeedsJavaSig

Inherited from AnyRef

Inherited from Any

Ungrouped