Class: DocBase
Hierarchy
-
DocBase↳
Doc
Constructors
constructor
• new DocBase(docType?, name?): DocBase
Parameters
| Name | Type | Default value |
|---|---|---|
docType | null | DocTypes | null |
name | null | string | null |
Returns
Defined in
lib/elements/Base.ts:24
Properties
children
• children: Map<string, DocParam | DocEvent | DocProp | DocMethod>
The children that belong to this element
Defined in
lib/elements/Base.ts:16
docType
• docType: null | DocTypes
The type of this element
Defined in
lib/elements/Base.ts:19
name
• name: null | string
The name of this element
Defined in
lib/elements/Base.ts:22
Accessors
classes
• get classes(): null | DocClass[]
The stored Classes for this current documentation source
Returns
null | DocClass[]
Defined in
lib/elements/Base.ts:82
events
• get events(): null | DocEvent[]
The stored Events for this current documentation source
Returns
null | DocEvent[]
Defined in
lib/elements/Base.ts:129
functions
• get functions(): null | DocFunction[]
The stored Functions for this current documentation source
Returns
null | DocFunction[]
Defined in
lib/elements/Base.ts:89
interfaces
• get interfaces(): null | DocInterface[]
The stored Interfaces for this current documentation source
Returns
null | DocInterface[]
Defined in
lib/elements/Base.ts:105
methods
• get methods(): null | DocMethod[]
The stored Methods for this current documentation source
Returns
null | DocMethod[]
Defined in
lib/elements/Base.ts:121
params
• get params(): null | DocParam[]
The stored Params for this current documentation source
Returns
null | DocParam[]
Defined in
lib/elements/Base.ts:137
props
• get props(): null | DocProp[]
The stored Props for this current documentation source
Returns
null | DocProp[]
Defined in
lib/elements/Base.ts:113
typedefs
• get typedefs(): null | DocTypedef[]
The stored Typedefs for this current documentation source
Returns
null | DocTypedef[]
Defined in
lib/elements/Base.ts:97