Skip to main content

DoxygenXmlParser.getAttributeNumberValue() method

Retrieves the value of a named attribute as a number.

Signature

getAttributeNumberValue(element: object, name: string): number;

Parameters

Parameter

Type

Description

element

object

The XML element containing the attribute

name

string

The name of the attribute to retrieve

Returns

number

The attribute value as a number

Exceptions

If the attribute does not exist or is not a number

Remarks

This method checks whether the specified attribute exists on the XML element and returns its value as a number. If the attribute is missing or its value is not a number, an error is thrown to indicate the absence or incorrect type.