DocstringComment
/**
* @brief A docstring comment.
*/
Inherit from DocstringCommentDO
Primary key: element_oid: int
schema DocstringComment extends DocstringCommentDO {
@primary element_oid: int,
text: string,
documented_element_oid: int
}
DocstringComment::getText
/**
* @brief gets the text of this element.
* @return string
*/
- Parameter
self
:DocstringComment
- Return
string
pub fn getText(self: DocstringComment) -> string;
DocstringComment::getDocumentableElement
/**
* @brief gets the documentable element id of the docstring comment, maybe a callable, field, enumconstant, class or interface.
* @return CombineElement
*/
- Parameter
self
:DocstringComment
- Return
CombineElement
pub fn getDocumentableElement(self: DocstringComment) -> CombineElement;
DocstringComment::__all__
Data constraint method.
- Parameter
db
:PythonDB
- Return
*DocstringComment
pub fn __all__(db: PythonDB) -> *DocstringComment;
DocstringComment::getAnAncestor
/**
* @brief gets an ancestor of the element.
* @return CombineElement
*/
- Parameter
self
:DocstringComment
- Return
*CombineElement
pub fn getAnAncestor(self: DocstringComment) -> *CombineElement;
DocstringComment::getParent
/**
* @brief gets the parent element of the element
* @return CombineElement
*/
- Parameter
self
:DocstringComment
- Return
CombineElement
pub fn getParent(self: DocstringComment) -> CombineElement;
DocstringComment::getDocumentedElementOid
/**
* @brief gets the documented element oid of this element.
* @return int
*/
- Parameter
self
:DocstringComment
- Return
int
pub fn getDocumentedElementOid(self: DocstringComment) -> int;