Class/Object

scala.meta.internal.metals

JavadocIndexer

Related Docs: object JavadocIndexer | package metals

Permalink

class JavadocIndexer extends JavaMtags

Extracts Javadoc from Java source code.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JavadocIndexer
  2. JavaMtags
  3. MtagsIndexer
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new JavadocIndexer(input: VirtualFile, fn: (SymbolDocumentation) ⇒ Unit)

    Permalink

Type Members

  1. implicit class XtensionJavaModel extends AnyRef

    Permalink
    Definition Classes
    JavaMtags

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 builder: JavaProjectBuilder

    Permalink
    Definition Classes
    JavaMtags
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def ctor(disambiguator: String, pos: meta.Position, properties: Int): Unit

    Permalink
    Definition Classes
    MtagsIndexer
  8. var currentOwner: String

    Permalink
    Definition Classes
    MtagsIndexer
  9. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def fromClass(symbol: String, method: JavaClass): SymbolDocumentation

    Permalink
  13. def fromConstructor(symbol: String, method: JavaConstructor): SymbolDocumentation

    Permalink
  14. def fromMethod(symbol: String, method: JavaMethod): SymbolDocumentation

    Permalink
  15. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  17. def index(): TextDocument

    Permalink
    Definition Classes
    MtagsIndexer
  18. def indexRoot(): Unit

    Permalink
    Definition Classes
    JavaMtagsMtagsIndexer
  19. def input: VirtualFile

    Permalink
    Definition Classes
    JavaMtagsMtagsIndexer
  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. def language: Language

    Permalink
    Definition Classes
    JavaMtagsMtagsIndexer
  22. def lastCurrentOwner: String

    Permalink
    Definition Classes
    MtagsIndexer
  23. def markdown(e: JavaAnnotatedElement): String

    Permalink
  24. def method(name: Name, disambiguator: String, kind: Kind, properties: Int): Unit

    Permalink
    Definition Classes
    MtagsIndexer
  25. def method(name: String, disambiguator: String, pos: meta.Position, properties: Int): Unit

    Permalink
    Definition Classes
    MtagsIndexer
  26. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  29. def owner: String

    Permalink
    Definition Classes
    MtagsIndexer
  30. def param(symbol: String, name: String, docstring: String): SymbolDocumentation

    Permalink
  31. def param(name: Name, kind: Kind, properties: Int): Unit

    Permalink
    Definition Classes
    MtagsIndexer
  32. def parameters(owner: String, method: JavaAnnotatedElement, params: java.util.List[JavaParameter]): java.util.List[SymbolDocumentation]

    Permalink
  33. def pkg(ref: Term): Unit

    Permalink
    Definition Classes
    MtagsIndexer
  34. def pkg(name: String, pos: meta.Position): Unit

    Permalink
    Definition Classes
    MtagsIndexer
  35. def symbol(signature: Descriptor): String

    Permalink
    Definition Classes
    MtagsIndexer
  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  37. def term(name: Term.Name, kind: Kind, properties: Int): Unit

    Permalink
    Definition Classes
    MtagsIndexer
  38. def term(name: String, pos: meta.Position, kind: Kind, properties: Int): Unit

    Permalink
    Definition Classes
    MtagsIndexer
  39. def toRangePosition(line: Int, name: String): inputs.Position

    Permalink

    Computes the start/end offsets from a name in a line number.

    Computes the start/end offsets from a name in a line number.

    Applies a simple heuristic to find the name: the first occurence of name in that line. If the name does not appear in the line then 0 is returned. If the name appears for example in the return type of a method then we get the position of the return type, not the end of the world.

    Definition Classes
    JavaMtags
  40. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  41. def tparam(name: Name, kind: Kind, properties: Int): Unit

    Permalink
    Definition Classes
    MtagsIndexer
  42. def tpe(name: Name, kind: Kind, properties: Int): Unit

    Permalink
    Definition Classes
    MtagsIndexer
  43. def tpe(name: String, pos: meta.Position, kind: Kind, properties: Int): Unit

    Permalink
    Definition Classes
    MtagsIndexer
  44. def typeParameters[D <: JavaGenericDeclaration](owner: String, method: JavaAnnotatedElement, tparams: java.util.List[JavaTypeVariable[D]]): java.util.List[SymbolDocumentation]

    Permalink
  45. def visitClass(cls: JavaClass, name: String, pos: inputs.Position, kind: Kind, properties: Int): Unit

    Permalink
    Definition Classes
    JavadocIndexerJavaMtags
  46. def visitClass(cls: JavaClass): Unit

    Permalink
    Definition Classes
    JavaMtags
  47. def visitClasses(classes: java.util.List[JavaClass]): Unit

    Permalink
    Definition Classes
    JavaMtags
  48. def visitConstructor(ctor: JavaConstructor, disambiguator: String, pos: inputs.Position, properties: Int): Unit

    Permalink
    Definition Classes
    JavadocIndexerJavaMtags
  49. def visitConstructors(cls: JavaClass): Unit

    Permalink
    Definition Classes
    JavaMtags
  50. def visitMember[T <: JavaMember](m: T): Unit

    Permalink
    Definition Classes
    JavaMtags
  51. def visitMembers[T <: JavaMember](fields: java.util.List[T]): Unit

    Permalink
    Definition Classes
    JavaMtags
  52. def visitMethod(method: JavaMethod, name: String, disambiguator: String, pos: inputs.Position, properties: Int): Unit

    Permalink
    Definition Classes
    JavadocIndexerJavaMtags
  53. def visitMethods(cls: JavaClass): Unit

    Permalink
    Definition Classes
    JavaMtags
  54. def visitOccurrence(occ: SymbolOccurrence, info: SymbolInformation, owner: String): Unit

    Permalink
    Definition Classes
    MtagsIndexer
  55. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. def withOwner[A](owner: String = currentOwner)(thunk: ⇒ A): A

    Permalink
    Definition Classes
    MtagsIndexer

Inherited from JavaMtags

Inherited from MtagsIndexer

Inherited from AnyRef

Inherited from Any

Ungrouped