This parameter allows you to specify precisely which class members (fields & methods) should be documented.
The tags specified in this parameter are treated as follows.
A class member is included in the documentation only when it has one of the specified tags.
Note: When the class containing such a member must be excluded, the member itself may still appear in the documentation. If that class has subclasses to be documented, the member will be shown as if it belongs to those of them, which are the nearest descendants of the member's original class.
When you specify this parameter, the condition above is only necessary for a member to be actually included in the documentation scope. Using other include/exclude parameters, you can limit which members are included even further! |
@api
@include