Tests if the given program element is included in the result set (to be documented).

This function is actually redundant as the same information is provided by Doc/@isIncluded attribute. So, in most cases it is equivalent to the call:

element.getAttrBooleanValue("isIncluded")
However, a separate function was added because of too frequent use of that information.

This function also directly applies to Type elements, which are not Doc and have no isIncluded attribute (see description of 'element' parameter below).

Parameter:

element

The Doc element whose inclusion in the result set is requested.

It may also be a Type element, which is automatically converted to the ClassDoc by calling the method: Type.asClassDoc()

In any other cases, the function will return false.

If this parameter is not specified, the generator context element is assumed, i.e. the same as the call: contextElement.isIncluded()

Returns:
true, if the program element / package is included in the result set; false, otherwise

See Also:

isVisible()