Doc
Doc holds the documentation details for a specific program element like a variable, function, macro, or example.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Doc(
kind,name?,type?,signature?,description?,children?):Doc
Parameters
Section titled “Parameters”Kind specifies the type of documentation element.
string = ""
Name is the identifier of the documented element.
string = ""
Type is the CEL type associated with the element.
signature?
Section titled “signature?”string = ""
Signature represents the function or overload signature.
description?
Section titled “description?”string = ""
Description holds the textual description of the element.
children?
Section titled “children?”Doc[] = []
Children holds nested documentation elements.
Returns
Section titled “Returns”Doc
Properties
Section titled “Properties”children
Section titled “children”
readonlychildren:Doc[] =[]
Children holds nested documentation elements.
description
Section titled “description”
readonlydescription:string=""
Description holds the textual description of the element.
readonlykind:DocKind
Kind specifies the type of documentation element.
readonlyname:string=""
Name is the identifier of the documented element.
signature
Section titled “signature”
readonlysignature:string=""
Signature represents the function or overload signature.
readonlytype:string=""
Type is the CEL type associated with the element.