DoxygenXmlParser.getInnerElementNumber() method
Retrieves the numeric value of a named child element.
Signature
getInnerElementNumber(element: object, name: string): number;
Parameters
Parameter |
Type |
Description |
---|---|---|
element |
object |
The XML element containing the child element |
name |
string |
The name of the child element |
Returns
number
The numeric value of the child element
Exceptions
If the child element does not exist or contains more than one element
Remarks
This method accesses the specified child element and returns its value as a number. If the child element is missing, an error is thrown. If the child element is empty, NaN is returned. If there is more than one child element, an error is thrown to indicate unexpected structure.