trait CommentNode extends ParseTreeNode with EmbeddedContentsProvider
A comment node.
This common trait is used to hold comments, which are not normally considered as HAST nodes, but they are included for additional analyses (e.g. the ones involving documentation or natural language). It may provide embedded contents, e.g., documentation contents, or unstructured data.
- Alphabetic
- By Inheritance
- CommentNode
- EmbeddedContentsProvider
- ParseTreeNode
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
val
embeddedContents: Option[EmbeddedContentsNode]
Returns the optional embedded contents of the node
Returns the optional embedded contents of the node
- Definition Classes
- EmbeddedContentsProvider
-
abstract
val
rawText: String
The raw text of the comment.
The raw text of the comment.
The raw text of the comment represents the contents of the comment as it appears as a token in the original artifact.
-
abstract
val
text: String
The actual contents of the comment (excluding any form of initial/ending markers).
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toCode(printComments: Boolean): String
Returns a string representation of this comment.
Returns a string representation of this comment.
- printComments
specifies if the comments should be printed.
- returns
the text of the comment if
printComments == true, otherwise the empty string.
- Definition Classes
- CommentNode → ParseTreeNode
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )