DocComment

Inherit from Node

Primary key: id: int

schema DocComment extends Node {
  @primary id: int
}

DocComment::hasLocation

• Parameter self: DocComment
• Return bool

pub fn hasLocation(self: DocComment) -> bool;

DocComment::getAnAncestorForIndex

• Parameter self: DocComment
• Parameter index: int
• Return Node

pub fn getAnAncestorForIndex(self: DocComment, index: int) -> Node;

DocComment::getAnAncestor

• Parameter self: DocComment
• Return *Node

pub fn getAnAncestor(self: DocComment) -> *Node;

DocComment::getBelongsFunction

• Parameter self: DocComment
• Return Function

pub fn getBelongsFunction(self: DocComment) -> Function;

DocComment::countAssociatedComment

• Parameter self: DocComment
• Return int

pub fn countAssociatedComment(self: DocComment) -> int;

DocComment::getParentNode

• Parameter self: DocComment
• Return Node

pub fn getParentNode(self: DocComment) -> Node;

DocComment::isRootNode

• Parameter self: DocComment
• Return bool

pub fn isRootNode(self: DocComment) -> bool;

DocComment::getDepthFromRoot

• Parameter self: DocComment
• Return int

pub fn getDepthFromRoot(self: DocComment) -> int;

DocComment::getTextStartOffset

• Parameter self: DocComment
• Return int

pub fn getTextStartOffset(self: DocComment) -> int;

DocComment::getLocation

• Parameter self: DocComment
• Return Location

pub fn getLocation(self: DocComment) -> Location;

DocComment::__all__

Data constraint method.

• Parameter db: GoDB
• Return *DocComment

pub fn __all__(db: GoDB) -> *DocComment;

DocComment::getBelongsFile

• Parameter self: DocComment
• Return File

pub fn getBelongsFile(self: DocComment) -> File;

DocComment::getText

// getText Extract the text associated with a specific node in a file

• Parameter self: DocComment
• Return string

pub fn getText(self: DocComment) -> string;

DocComment::getType

• Parameter self: DocComment
• Return string

pub fn getType(self: DocComment) -> string;

DocComment::getChildCount

• Parameter self: DocComment
• Return int

pub fn getChildCount(self: DocComment) -> int;

DocComment::getTextSize

• Parameter self: DocComment
• Return int

pub fn getTextSize(self: DocComment) -> int;

DocComment::print

• Parameter self: DocComment
• Return *string

pub fn print(self: DocComment) -> *string;

DocComment::getCommentGroup

• Parameter self: DocComment
• Return Node

pub fn getCommentGroup(self: DocComment) -> Node;

DocComment::getAssociateObj

• Parameter self: DocComment
• Return Node

pub fn getAssociateObj(self: DocComment) -> Node;

DocComment::getAssociatedCommentString

• Parameter self: DocComment
• Return string

pub fn getAssociatedCommentString(self: DocComment) -> string;

DocComment::getAchildNode

• Parameter self: DocComment
• Return *Node

pub fn getAchildNode(self: DocComment) -> *Node;