Type Members

1.  trait JavadocASTNode extends HASTNode

   Represents a JavaDoc HAST Node.

   Represents a JavaDoc HAST Node.

   Since

   2.0.0

2.  case class JavadocAuthorNode (name: String) extends JavadocASTNode with Product with Serializable

   Represents an author in the @author tag

   Represents an author in the @author tag

   name

   the name of the author

   Since

   2.0.0

   See also

   ch.usi.inf.reveal.parsing.model.java.javadoc.JavadocAuthorNode

3.  case class JavadocAuthorTagNode (description: Some[JavadocDescriptionNode]) extends JavadocTagNode with Product with Serializable

   Represents an @author tag.

   Represents an @author tag.

   description

   the description of the tag containing one or more names of the authors.

   Since

   2.0.0

   See also

   Javadoc Documentation

4.  case class JavadocClassReferenceNode (packageReference: Option[JavadocPackageReferenceNode], classReference: QualifiedIdentifierNode) extends JavadocSeeTagReferenceNode with Product with Serializable

   Represents a Form-3 class reference.

   Represents a Form-3 class reference.

   packageReference

   the optional reference to the package.

   classReference

   the qualified identifier representing a class.

5.  case class JavadocCommentNode (rawText: String, embeddedContents: Some[JavadocContentsNode]) extends MultilineCommentNode with Product with Serializable

   A Javadoc comment node.

   A Javadoc comment node.

   embeddedContents

   the modeled javadoc documentation.

   See also

   JavadocContentsNode

6.  case class JavadocContentsNode (documentationNode: JavadocDocumentationNode) extends HASTNode with EmbeddedContentsNode with Product with Serializable

   A special kind of embedded content that consists of JavaDoc elements.

7.  case class JavadocCustomTagNode (tagName: String, description: Some[JavadocDescriptionNode]) extends JavadocTagNode with Product with Serializable

   Represents a generic block tag.

   Represents a generic block tag.

   tagName

   the name of the tag.

   description

   the description (or first param) of the tag.

   Since

   2.0.0

8.  case class JavadocDeprecatedTagNode (description: Option[JavadocDescriptionNode]) extends JavadocTagNode with Product with Serializable

   Represents a @deprecated tag.

   Represents a @deprecated tag.

   description

   the description of the deprecation.

   Since

   2.0.0

   See also

   Javadoc Documentation

9.  case class JavadocDescriptionNode (contents: Seq[JavadocASTNode]) extends JavadocASTNode with Product with Serializable

   Represents the description of a javadoc comment.

   Represents the description of a javadoc comment.

   contents

   the sequence of nodes (i.e., textual fragments and inline tags) composing the description.

10.  case class JavadocDocumentationNode (description: Option[JavadocDescriptionNode], tags: Seq[JavadocTagNode]) extends JavadocASTNode with Product with Serializable

    Represents the structure of a javadoc comment.

    Represents the structure of a javadoc comment.

    description

    the description node

    tags

    the sequence of block tags

    Since

    2.0.0

11.  case class JavadocFieldReferenceNode (classReference: Option[JavadocClassReferenceNode], fieldReference: IdentifierNode) extends JavadocSeeTagReferenceNode with Product with Serializable

    Represents a Form-3 field reference.

    Represents a Form-3 field reference.

    classReference

    the optional reference to the class of the field.

    fieldReference

    the identifier representing the field.

12.  case class JavadocGenericParamTagNode (tagParam: Some[TypeParameterNode], description: Option[JavadocDescriptionNode]) extends JavadocTagNode with Product with Serializable

    Represents a @param tag whose argument is a type parameter (e.g., <T>)

    Represents a @param tag whose argument is a type parameter (e.g., <T>)

    tagParam

    the type parameter node linked by the tag.

    description

    the optional description of the tag.

    Since

    2.0.0

    See also

    Javadoc Documentation

13.  case class JavadocLinkPlainTagNode (tagParam: Some[JavadocSeeTagReferenceNode], description: Option[JavadocDescriptionNode]) extends JavadocTagNode with Product with Serializable

    Represents a @linkplain tag.

    Represents a @linkplain tag.

    tagParam

    the reference to be linked

    description

    the description of the link

    Since

    2.0.0

    See also

    Javadoc Documentation

14.  case class JavadocLinkTagNode (tagParam: Some[JavadocSeeTagReferenceNode], description: Option[JavadocDescriptionNode]) extends JavadocTagNode with Product with Serializable

    Represents a @link tag.

    Represents a @link tag.

    tagParam

    the reference to be linked

    description

    the description of the link

    Since

    2.0.0

    See also

    Javadoc Documentation

15.  case class JavadocLiteralTagNode (description: Option[JavadocDescriptionNode]) extends JavadocTagNode with Product with Serializable

    Represents a @literal tag.

    Represents a @literal tag.

    description

    the literal to be interpreted as plain text.

16.  case class JavadocMethodReferenceNode (classReference: Option[JavadocClassReferenceNode], identifier: IdentifierNode, signature: FormalParametersNode) extends JavadocSeeTagReferenceNode with Product with Serializable

    Represents a Form-3 a method reference.

    Represents a Form-3 a method reference.

    classReference

    the optional reference to the class of the method.

    identifier

    the identifier representing the method.

    signature

    the arguments of the method (if any).

17.  case class JavadocPackageReferenceNode (reference: QualifiedIdentifierNode) extends JavadocSeeTagReferenceNode with Product with Serializable

    Represents a Form-3 package reference.

    Represents a Form-3 package reference.

    reference

    the qualified identifier representing the package name.

18.  case class JavadocParamTagNode (tagParam: Some[IdentifierNode], description: Option[JavadocDescriptionNode]) extends JavadocTagNode with Product with Serializable

    Represents a @param tag whose argument is an identifier.

    Represents a @param tag whose argument is an identifier.

    tagParam

    the identifier linked by the tag.

    description

    the optional description of the tag.

    Since

    2.0.0

    See also

    Javadoc Documentation

19.  case class JavadocReturnTagNode (description: Some[JavadocDescriptionNode]) extends JavadocTagNode with Product with Serializable

    Represents a @return tag.

    Represents a @return tag.

    description

    the description of the value returned.

20.  case class JavadocSeeTagNode (tagParam: Some[JavadocSeeTagReferenceNode], description: Option[JavadocDescriptionNode]) extends JavadocTagNode with Product with Serializable

    Represents a @see tag.

    Represents a @see tag.

    tagParam

    the reference to see.

    description

    the optional description of the tag.

    Since

    2.0.0

    See also

    Javadoc Documentation

21.  trait JavadocSeeTagReferenceNode extends JavadocASTNode

    The general trait for all types of Javadoc references.

22.  case class JavadocSinceTagNode (description: Some[JavadocDescriptionNode]) extends JavadocTagNode with Product with Serializable

    Represents a @see tag.

    Represents a @see tag.

    description

    the description of what to see.

23.  case class JavadocStringReferenceNode (reference: StringLiteralNode) extends JavadocSeeTagReferenceNode with Product with Serializable

    Form-1 of Javadoc references, i.e., the one providing a text entry for string.

24.  sealed trait JavadocTagNode extends JavadocASTNode
25.  case class JavadocThrowsTagNode (tagName: String, tagParam: Some[QualifiedIdentifierNode], description: Option[JavadocDescriptionNode]) extends JavadocTagNode with Product with Serializable

    Represents a @throws or the equivalent @exception tags.

    Represents a @throws or the equivalent @exception tags.

    tagName

    the name of the tag (must be "throws" or "exception").

    tagParam

    the qualified identifier node representing the name of the exception.

    description

    the optional description of the tag.

    Since

    2.0.0

    See also

    Javadoc Documentation

26.  case class JavadocValueTagNode (tagParam: Option[JavadocSeeTagReferenceNode]) extends JavadocTagNode with Product with Serializable

    Represents a @value tag.

    Represents a @value tag.

    tagParam

    the reference to a field.

    Since

    2.0.0

    See also

    Javadoc Documentation

27.  case class JavadocVersionTagNode (description: Some[JavadocDescriptionNode]) extends JavadocTagNode with Product with Serializable

    Represents a @version tag.

    Represents a @version tag.

    description

    the description of the version

28.  case class JavadocXmlReferenceNode (reference: XmlComposedNode) extends JavadocSeeTagReferenceNode with Product with Serializable

    Form-2 of Javadoc references, i.e., the one providing an XML node (e.g., a HTML link).