Comment
/** * @brief a comment. */
Inherit from CommentDO
Primary key: element_oid: int
schema Comment extends CommentDO { @primary element_oid: int, text: string, parent_oid: int, location_oid: int }
Comment::getLocationOid
/** * @brief gets the location oid of this element. * @return int */
- Parameter
self
:Comment
- Return
int
pub fn getLocationOid(self: Comment) -> int;
Comment::getParentOid
/** * @brief gets the parent oid of this element. * @return int */
- Parameter
self
:Comment
- Return
int
pub fn getParentOid(self: Comment) -> int;
Comment::getDocumentedClassOrFunctionElement
/** * @brief gets the documented class or function of the comment. * @return CombineElement */
- Parameter
self
:Comment
- Return
CombineElement
pub fn getDocumentedClassOrFunctionElement(self: Comment) -> CombineElement;
Comment::__all__
Data constraint method.
pub fn __all__(db: PythonDB) -> *Comment;
Comment::getLocation
/** * @brief gets the location for the element. * @return Location */
pub fn getLocation(self: Comment) -> Location;
Comment::getAnAncestor
/** * @brief gets an ancestor of the element. * @return CombineElement */
- Parameter
self
:Comment
- Return
*CombineElement
pub fn getAnAncestor(self: Comment) -> *CombineElement;
Comment::getText
/** * @brief gets the text of this element. * @return string */
- Parameter
self
:Comment
- Return
string
pub fn getText(self: Comment) -> string;
Comment::getDocumentedBelowElement
/** * @brief gets the documented element of the comment. * @return CombineElement */
- Parameter
self
:Comment
- Return
*CombineElement
pub fn getDocumentedBelowElement(self: Comment) -> *CombineElement;
Comment::getParent
/** * @brief gets the parent element of the element * @return CombineElement */
- Parameter
self
:Comment
- Return
CombineElement
pub fn getParent(self: Comment) -> CombineElement;