JavadocComment
/**
* @brief A java doc comment.
*/
Inherit from JavadocCommentDO
Primary key: element_hash_id: int
schema JavadocComment extends JavadocCommentDO {
@primary element_hash_id: int,
documentable_hash_id: int,
text: string,
location_hash_id: int,
parent_hash_id: int
}
JavadocComment::getText
/**
* @brief gets the text of this element.
* @return string
*/
- Parameter
self
:JavadocComment
- Return
string
pub fn getText(self: JavadocComment) -> string;
JavadocComment::getParentHashId
/**
* @brief gets the parent hash id of this element.
* @return int
*/
- Parameter
self
:JavadocComment
- Return
int
pub fn getParentHashId(self: JavadocComment) -> int;
JavadocComment::getDocumentableElement
/**
* @brief gets the documentable element id of the java doc comment, maybe a callable, field, enumconstant, class or interface.
* @return ElementParent
*/
- Parameter
self
:JavadocComment
- Return
ElementParent
pub fn getDocumentableElement(self: JavadocComment) -> ElementParent;
JavadocComment::getDocumentableHashId
/**
* @brief gets the documentable hash id of this element.
* @return int
*/
- Parameter
self
:JavadocComment
- Return
int
pub fn getDocumentableHashId(self: JavadocComment) -> int;
JavadocComment::__all__
Data constraint method.
- Parameter
db
:JavaDB
- Return
*JavadocComment
pub fn __all__(db: JavaDB) -> *JavadocComment;
JavadocComment::getAnAncestor
/**
* @brief gets an ancestor of the element.
* @return ElementParent
*/
- Parameter
self
:JavadocComment
- Return
*ElementParent
pub fn getAnAncestor(self: JavadocComment) -> *ElementParent;
JavadocComment::getLocation
/**
* @brief gets the location for the element.
* @return Location
*/
- Parameter
self
:JavadocComment
- Return
Location
pub fn getLocation(self: JavadocComment) -> Location;
JavadocComment::getLocationHashId
/**
* @brief gets the location hash id of this element.
* @return int
*/
- Parameter
self
:JavadocComment
- Return
int
pub fn getLocationHashId(self: JavadocComment) -> int;
JavadocComment::getParent
/**
* @brief gets the parent of the element.
* @return ElementParent
*/
- Parameter
self
:JavadocComment
- Return
ElementParent
pub fn getParent(self: JavadocComment) -> ElementParent;