JavadocTag
/**
* @brief A javadoc tag, either an inline tag or a block tag.
*/
Inherit from JavadocTagDO
Primary key: element_hash_id: int
schema JavadocTag extends JavadocTagDO {
@primary element_hash_id: int,
name: string,
value: string,
containing_comment_hash_id: int,
index_order: int,
location_hash_id: int
}
JavadocTag::getIndex
/**
* @brief gets the index order of this element.
* @return int
*/
- Parameter
self
:JavadocTag
- Return
int
pub fn getIndex(self: JavadocTag) -> int;
JavadocTag::getName
/**
* @brief gets the name of this element.
* @return string
*/
- Parameter
self
:JavadocTag
- Return
string
pub fn getName(self: JavadocTag) -> string;
JavadocTag::getLocationHashId
/**
* @brief gets the location hash id of this element.
* @return int
*/
- Parameter
self
:JavadocTag
- Return
int
pub fn getLocationHashId(self: JavadocTag) -> int;
JavadocTag::__all__
Data constraint method.
- Parameter
db
:JavaDB
- Return
*JavadocTag
pub fn __all__(db: JavaDB) -> *JavadocTag;
JavadocTag::getComment
/**
* @brief gets the doc comment in which the tag is contained.
* @return JavadocComment
*/
- Parameter
self
:JavadocTag
- Return
JavadocComment
pub fn getComment(self: JavadocTag) -> JavadocComment;
JavadocTag::getContainingCommentHashId
/**
* @brief gets the containing comment hash id of this element.
* @return int
*/
- Parameter
self
:JavadocTag
- Return
int
pub fn getContainingCommentHashId(self: JavadocTag) -> int;
JavadocTag::getLocation
/**
* @brief gets the location for the element.
* @return Location
*/
- Parameter
self
:JavadocTag
- Return
Location
pub fn getLocation(self: JavadocTag) -> Location;
JavadocTag::getAnAncestor
/**
* @brief gets an ancestor of the element.
* @return ElementParent
*/
- Parameter
self
:JavadocTag
- Return
*ElementParent
pub fn getAnAncestor(self: JavadocTag) -> *ElementParent;
JavadocTag::getValue
/**
* @brief gets the value of this element.
* @return string
*/
- Parameter
self
:JavadocTag
- Return
string
pub fn getValue(self: JavadocTag) -> string;
JavadocTag::getDocumentableElement
/**
* @brief gets the documented element.
* @return ExpressionParent
*/
- Parameter
self
:JavadocTag
- Return
ExpressionParent
pub fn getDocumentableElement(self: JavadocTag) -> ExpressionParent;