Specify tags, by which both classes and class members (i.e. fields, constructors and methods) are included in the generated documentation.
When this parameter is specified, the entire documentation scope will be limited as follows.
A class is included in the documentation only when at least one of the conditions is met:
Note: When the class containing the member must be excluded, the member itself may still appear in the documentation. If that class has documented subclasses, 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 criteria above are only necessary for a class or member to be actually included in the documentation scope. However, they do not guarantee it. Using other include/exclude parameters, you can limit the documentation scope even further! |
@api
@include