AbstractParamType class
Abstract base class for parameter data models within documentation.
Signature
export declare abstract class AbstractParamType extends AbstractDataModelBase
Extends: AbstractDataModelBase
Remarks
Represents comprehensive parameter information as defined by the paramType XML Schema, handling function and method parameter definitions including type information, naming variations, default values, and constraints. This class processes the complete range of parameter metadata required for accurate function signature documentation.
The implementation manages optional parameter elements including attributes, type specifications with linked text support, declaration and definition names, array specifications, default values, type constraints, and brief descriptions. All elements are optional, reflecting the flexible nature of parameter documentation within different programming contexts.
Constructors
|
Constructor |
Modifiers |
Description |
|---|---|---|
|
Constructs a new parameter data model from XML element data. |
Properties
|
Property |
Modifiers |
Type |
Description |
|---|---|---|---|
|
string | undefined |
(Optional) Array specification information for array parameters. | ||
|
string | undefined |
(Optional) Parameter attributes specification string. | ||
|
BriefDescriptionDataModel | undefined |
(Optional) Brief description documentation for the parameter. | ||
|
string | undefined |
(Optional) The declared parameter name as it appears in the declaration. | ||
|
string | undefined |
(Optional) The defined parameter name as it appears in the definition. | ||
|
DefValDataModel | undefined |
(Optional) Default value specification with linked text support. | ||
|
TypeDataModel | undefined |
(Optional) Type information for the parameter with linked text support. | ||
|
TypeConstraintDataModel | undefined |
(Optional) Type constraint information for template parameters. |
Generated via tsdoc2docusaurus 1.3.0 by API Extractor/Documenter 7.52.8.