DoxygenXmlParser.getAttributeBooleanValue() method
Retrieves the value of a named attribute as a boolean.
Signature
getAttributeBooleanValue(element: object, name: string): boolean;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
element |
object |
The XML element containing the attribute |
|
name |
string |
The name of the attribute to retrieve |
Returns
boolean
True if the attribute value is 'yes' (case-insensitive) or true; otherwise, false
Exceptions
If the attribute does not exist or is not a string or boolean
Remarks
This method checks whether the specified attribute exists on the XML element, and returns true if its value is the string 'yes' (case-insensitive). Values like true/false, which the XML parser returns as booleans, are returned as such. If the attribute is missing or its value is neither a string nor a boolean, an error is thrown.
Generated via tsdoc2docusaurus 1.3.2 by API Extractor/Documenter 7.58.7.