Package ortus.boxlang.compiler.ast.comment

Class BoxDocComment

java.lang.Object

ortus.boxlang.compiler.ast.BoxNode

ortus.boxlang.compiler.ast.comment.BoxComment

ortus.boxlang.compiler.ast.comment.BoxMultiLineComment

ortus.boxlang.compiler.ast.comment.BoxDocComment

All Implemented Interfaces:

BoxVisitable

public class BoxDocComment
extends BoxMultiLineComment

Documentation comment

Field Summary

Fields inherited from class ortus.boxlang.compiler.ast.BoxNode

parent, position

Constructor Summary

Constructors

Constructor	Description
BoxDocComment(String commentText, List<BoxDocumentationAnnotation> annotations, Position position, String sourceText)	Create a instance of a BoxDocumentation

Method Summary

Modifier and Type	Method	Description
BoxNode	accept(ReplacingBoxVisitor v)	Accept method for replacing visitor support.
void	accept(VoidBoxVisitor v)	Accept method for visitor support.
List<BoxDocumentationAnnotation>	getAnnotations()
void	setAnnotations(List<BoxDocumentationAnnotation> annotations)
Map<String,Object>	toMap()

Methods inherited from class ortus.boxlang.compiler.ast.comment.BoxComment

getCommentText, setCommentText

Methods inherited from class ortus.boxlang.compiler.ast.BoxNode

addComment, associateComments, endsOnSameLineAs, enumToMap, getAncestors, getChildren, getComments, getDescendants, getDescendantsOfType, getDocComment, getFirstAncestorOfType, getFirstAncestorOfType, getFirstNodeOfType, getFirstNodeOfType, getFirstNodeOfTypes, getParent, getPosition, getSourceText, isAfter, isBefore, isInside, replaceChildren, replaceChildren, setComments, setParent, setPosition, setSourceText, startsOnEndLineOf, toJSON, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

BoxDocComment

public BoxDocComment(String commentText,
 List<BoxDocumentationAnnotation> annotations,
 Position position,
 String sourceText)

Create a instance of a BoxDocumentation

Parameters:

annotations -

position - position within the source code

sourceText - source code

Method Details

getAnnotations

public List<BoxDocumentationAnnotation> getAnnotations()

setAnnotations

public void setAnnotations(List<BoxDocumentationAnnotation> annotations)

toMap

public Map<String,Object> toMap()

Overrides:

toMap in class BoxComment

accept

public void accept(VoidBoxVisitor v)

Description copied from interface: BoxVisitable

Accept method for visitor support.

Specified by:

accept in interface BoxVisitable

Overrides:

accept in class BoxMultiLineComment

Parameters:

v - the visitor implementation

accept

public BoxNode accept(ReplacingBoxVisitor v)

Description copied from interface: BoxVisitable

Accept method for replacing visitor support. Each accept returns the node, or a replacement node.

Specified by:

accept in interface BoxVisitable

Overrides:

accept in class BoxMultiLineComment

Parameters:

v - the visitor implementation