DoxygenXmlParser.getInnerElementBoolean() method
Retrieves the boolean value of a named child element.
Signature
getInnerElementBoolean(element: object, name: string): boolean;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
element |
object |
The XML element containing the child element |
|
name |
string |
The name of the child element |
Returns
boolean
True if the child element's text is 'true' (case-insensitive); otherwise, false
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 boolean. If the child element is missing, an error is thrown. If the child element is empty, false is returned. If there is more than one child element, an error is thrown to indicate unexpected structure.
Generated via tsdoc2docusaurus 1.3.2 by API Extractor/Documenter 7.58.7.