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); otherwise, false
Exceptions
If the attribute does not exist or is not a string
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). If the attribute is missing or its value is not a string, an error is thrown.