Skip to main content

AbstractParamType.(constructor)

Constructs a new parameter data model from XML element data.

Signature

constructor(xml: DoxygenXmlParser, element: object, elementName: string);

Parameters

Parameter

Type

Description

xml

DoxygenXmlParser

The XML parser instance for processing element data

element

object

The XML element containing parameter information

elementName

string

The name of the XML element being processed

Remarks

Processes the XML element representing parameter information and extracts all available parameter metadata including attributes, type specifications, naming variations, default values, constraints, and descriptions. The constructor handles the paramType schema requirements where all elements are optional, reflecting the flexible nature of parameter documentation.

The implementation processes various parameter representations including simple parameters, array parameters, template parameters with constraints, and parameters with default values. It ensures proper extraction of linked text elements that contain embedded cross-references to related documentation entities.


Generated via tsdoc2docusaurus 1.3.0 by API Extractor/Documenter 7.52.8.